[BI-2700] Improve Technical Documentation For DeltaBreed Paper#59
Merged
[BI-2700] Improve Technical Documentation For DeltaBreed Paper#59
Conversation
mlm483
requested changes
Jul 31, 2025
Contributor
mlm483
left a comment
mlm483
left a comment
There was a problem hiding this comment.
This looks really good. I left some small suggestions.
One other thing to consider is if there's any point in having two .env templates. If .env.quicktemplate is the best way to get started, why not just replace .env.template with the contents of .env.quicktemplate? Anyone who needs to change a variable with a default value is still free to do so in that case. If there are helpful comments in the .env.template that you want to save, you could move them above their respective variables.
.env.quicktemplate
Outdated
| OAUTH_CLIENT_SECRET=<oauth_client_secret goes here> | ||
|
|
||
| ##Variables already set | ||
| JWT_SECRET=insecure2520f59b2bccc64ce155482bc413f6b9ede5c6d418ab529d1b2051baa6f0849e |
mlm483
approved these changes
Jul 31, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
BI-2700 Improve Technical Documentation For DeltaBreed Paper
Changes to README and additional files to help new users and developers set up a local instance of DeltaBreed.