replace Envfile with env_sample and reference env file in auth docs #10864
Conversation
This file contains 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
benhalpern
approved these changes
Oct 15, 2020
pr-triage
bot
added
PR: partially-approved
citizen428
approved these changes
Oct 16, 2020
jacobherrington
approved these changes
Oct 16, 2020
pr-triage
bot
added
PR: reviewed-approved
pr-triage
bot
added
PR: merged
boardfish
pushed a commit
to boardfish/forem
that referenced
this pull request
Oct 17, 2020
…orem#10864) Co-authored-by: khendrikse <k.hendrikse@youngcapital.nl>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of PR is this? (check all applicable)
Description
While trying to set up the project locally I had trouble understanding some parts of the documentation.
I specifically added small pieces to the auth documentation about the fact that the variables should be in the
.envfile. I understand that it might be clear for those of us with a bunch of experience but hopefully it can help out juniors like me as well.I also saw references to
Envfile, and while maybe this word was used to refer to the.env_samplefile, I think it might be clearer to specifically reference that file then.Related Tickets & Documents
#10849
QA Instructions, Screenshots, Recordings
Added tests?
Added to documentation?
What gif best describes this PR or how it makes you feel?