Automate PATH verification in install_prerequisites.sh, simplify README
#858
Conversation
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
bnaecker
approved these changes
Apr 4, 2022
davepacheco
reviewed
Apr 4, 2022
| $ ./tools/install_prerequisites.sh | ||
| ---- | ||
|
|
||
| Alternatively, the manual installation steps as follows: |
Collaborator
There was a problem hiding this comment.
I admit I'm a little sad to see this section go. I feel like this is useful documentation for the important third-party pieces that we're using. At the same time, it probably doesn't make sense to have both this and an automated version that can get out of sync. I wonder if there's a useful compromise -- what if we move more of this documentation into install_prerequisites.sh itself? Things I could imagine noting in that script:
- That Diesel uses the native libpq to talk to to PostgreSQL (CockroachDB in our case)
- That the test suite expects the
cockroachandclickhousecommands on your PATH - That the brand/omicron1/tools package is used for deploying control plane components into zones on a test machine [as opposed to a local build or test suite run]
Collaborator
Author
There was a problem hiding this comment.
Good suggestion, I've added much more documentation to the script itself.
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.
Automating as much of the README as possible within the installation script to simplify the onboarding process.