Initial devcontainer CLI docs #4698
Conversation
docs/remote/devcontainer-cli.md
Outdated
| * **Windows**: You will be prompted to automatically add the `devcontainer` CLI to your `PATH` or to copy the `devcontainer` CLI path to your clipboard for you to add to your `PATH`. | ||
| * **macOS/Linux**: If the extension detects a `bin` folder ( or `.local/bin` folder) in your user home folder and in your `PATH` then you will have the option of adding a symlink to the `devcontainer` CLI to this location. You will also have the option to copy the `devcontainer` CLI path to your clipboard for you to add to your `PATH`. | ||
|
|
||
| 3. From a system shell (one not inside Visual Studio Code), run `devcontainer --help` to test the installation and see the CLI's built-in help. Note that you may need to restart your shell for `PATH` changes to take effect. |
There was a problem hiding this comment.
What do we mean by system shell here? An external terminal?
There was a problem hiding this comment.
It could be a nice touch to include a screenshot of the devcontainer ---help commands. Or if we think they may be changing frequently, we could leave it off if it feels too difficult to maintain/it would become more distracting than helpful :)
There was a problem hiding this comment.
As I continued reading through the doc, I realized a list of commands (perhaps even a text box / markdown table rather than screenshot) could be helpful so that I know what I can do with the CLI going into this.
There was a problem hiding this comment.
Changed the wording for system shell
Added a code block with the devcontainer --help output - that feels like it would be simpler to maintain but hopefully still fulfill the intended purpose. What do you think?
There was a problem hiding this comment.
I really like it! I think text is easier to maintain too, and showing users upfront what the commands should be is nice in case they don't get the expected output or they are just reading for now and not following along live.
Co-authored-by: Brigit Murtaugh <[email protected]>
Co-authored-by: Brigit Murtaugh <[email protected]>
|
Thanks @bamurtaugh - great feedback. I've resolved most of the issues, but left one open to see what you think of the change. |
There was a problem hiding this comment.
Looks great, thanks for incorporating the feedback so quickly @stuartleeks!
Not sure if you may want a glance over from @Chuxel too, but LGTM.
Adds initial docs for the
devcontainerCLI:devcontainerCLI - open folder in Remote-Containers vscode-remote-release#5302,devcontainerCLI command to build the dev container image vscode-remote-release#5349I made an initial estimate of placement in the table of contents, but let me know if the order should be tweaked