Cleaned up documentation for initial setup for developer tasks. #1022
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 does this change
In the initial setup, I was getting an error following
This commit cleans up the documentation around initial setup to match what I think
is going on more closely.
What issue does it fix
Closes #1020
Notes for the reviewer
A couple of issues to think about:
I'm not sure whether there is a get.porter.sh url that would work for cloning directly.
This
didn't work and maybe there is a better way to do that or maybe it's just a "remember to update when the organization changes".
Additionally, I did clean up the language in the what does
make install
do. I'm kind of wondering if there is a need to say something around creating a development environment separate from operating environment.Say you've installed porter following that process, decide you want to do some development work, if you follow the steps as written you just blew away your installation for the development version. That's probably a separate meta/docs issue, but I wanted to bring it up.
Checklist