Improving the installation documentation#29
Merged
Israel-Laguan merged 2 commits intoTheRandomCrew:devfrom Nov 18, 2021
Merged
Conversation
Israel-Laguan
approved these changes
Nov 18, 2021
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.
I found some issues with the .gitignore and .env.example links shown in the installation documentation. Since the links were simply
.gitignoreand.env.examplerespectively, they looked for the file in the same docs folder, which didn't exist. I improved these using their proper relatives paths../.gitignoreand../.env.example, because the files were actually in the outside folder.On the other hand, I found that the instruction to run the migration and seed was written just as
set-db:dev, however I think it's clearer to indicate that it's an npm script, so I changed it tonpm run set-db:dev, since that's the way that it should be executed in the terminal.These are simple improvements of issues that I found while checking the installation instruction. I know it's very little but everything helps!