Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve deployment and dev container documentation #212

Closed
brooke-hamilton opened this issue May 19, 2021 · 0 comments · Fixed by #211, #225, #226 or #227
Closed

Improve deployment and dev container documentation #212

brooke-hamilton opened this issue May 19, 2021 · 0 comments · Fixed by #211, #225, #226 or #227
Assignees

Comments

@brooke-hamilton
Copy link
Contributor

Benefit/Result/Outcome
Doc changes to be more explicit on .devcontainer usage for command-line deployments (vs local shell).

Description
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.

Acceptance Criteria

  • Simplified, more complete, and more organized documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment