Doc changes to be more explicit on .devcontainer usage for command-line deployments (vs local shell) #211
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
The steps for cloning the project to a local machine apply to all usage paths (i.e. development container, command line, and UI deployments), but are only documented in this development container page. The "setup" steps in this page (e.g. the steps of getting the bits to the local machine and ready to run) should be moved to top-level "getting started" page. This will also help simplify/clarify the "Command-Line Deployment" steps by avoiding some context switching across the different getting started pages.
I've personally needed to think about where I need to run these commands to deploy via command-line. This attempts to make it more explicit
brooke-hamilton
suggested changes
May 19, 2021
brooke-hamilton
approved these changes
May 24, 2021
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.
Description
Doc changes to be more explicit on .devcontainer usage for command-line deployments (vs local shell).
The steps for cloning the project to a local machine apply to all usage paths (i.e. development container, command line, and UI deployments), but are only documented in this development container page. The "setup" steps in this page (e.g. the steps of getting the bits to the local machine and ready to run) should be moved to top-level "getting started" page. This aims to help simplify/clarify the "Command-Line Deployment" steps by avoiding some context switching across the different getting started pages. The command-line step-by-step page was then updated to be more explicit at the beginning around whether the command was run from the local BASH shell or from the BASH shell in the devcontainer.
Issue reference
The issue this PR will close: #212
Checklist
Please make sure you've completed the relevant tasks for this PR, out of the following list:
shellcheck.vscode/extensions.json.)