docs: Devcontainers-cli enhancement #2548
Conversation
…hes. This includes adding a new dropdown for Docker which lists overall steps that have to be done when setting up the environment. Furthermore, the previous documentation is no listed under VSCode and new documentation for the Devcontainer CLI has been added.
Moved information about creating volumes for Docker containers into the overall Docker setup documentation. Add warning for changing build directory or adding options for building at the top of the page.
Thanks for the review! I will have a look at everything and try to make adjustments accordingly. |
Co-authored-by: Nicolas Munnich <[email protected]>
Since the described approaches for VS Code and Dev Container CLI varied quiet a bit a more unified way of setting them up was added. Due to that, the documentation for building and flashing could be simplified as well.
There was a problem hiding this comment.
Thanks for sticking with it, this looks pretty good! Some more minor comments this time.
Also, since it hasn't been linked yet, this closes #208
Sure, I adjusted everything. |
| @@ -9,6 +9,7 @@ | |||
| "mounts": [ | |||
| "type=volume,source=zmk-root-user,target=/root", | |||
| "type=volume,source=zmk-config,target=/workspaces/zmk-config", | |||
| "type=volume,source=zmk-modules,target=/workspaces/zmk-modules", | |||
There was a problem hiding this comment.
Just a note: approving this change, from a container setup perspective. Will let the docs team handle final approval/merge of this PR though. Thanks!
Just as a side note, I personally am in favor of reformatting such that each sentence begins on a new line in the file. This just makes it easier to review, imo. |
Applied everything you mentioned. Sure I will keep it in mind. |
* docs: Split local toolchain setup for Docker in two separated approaches. This includes adding a new dropdown for Docker which lists overall steps that have to be done when setting up the environment. Furthermore, the previous documentation is no listed under VSCode and new documentation for the Devcontainer CLI has been added. Since the described approaches for VS Code and Dev Container CLI varied quiet a bit a more unified way of setting them up was added. Due to that, the documentation for building and flashing could be simplified as well. * docs: Update documentation for building and flashing for devcontainers. Moved information about creating volumes for Docker containers into the overall Docker setup documentation. Add warning for changing build directory or adding options for building at the top of the page. * feat(devcontainers): Add new volume for mounting modules. --------- Co-authored-by: Nicolas Munnich <[email protected]>
* docs: Split local toolchain setup for Docker in two separated approaches. This includes adding a new dropdown for Docker which lists overall steps that have to be done when setting up the environment. Furthermore, the previous documentation is no listed under VSCode and new documentation for the Devcontainer CLI has been added. Since the described approaches for VS Code and Dev Container CLI varied quiet a bit a more unified way of setting them up was added. Due to that, the documentation for building and flashing could be simplified as well. * docs: Update documentation for building and flashing for devcontainers. Moved information about creating volumes for Docker containers into the overall Docker setup documentation. Add warning for changing build directory or adding options for building at the top of the page. * feat(devcontainers): Add new volume for mounting modules. --------- Co-authored-by: Nicolas Munnich <[email protected]>
Documentation enhancement for local setup with the devcontainers-cli like mentioned on Discord.
Additionally, I added a new volume for modules to the
devcontainer.json, so that it can be used for building locally with external modules.