Update dev containers content #5587
Conversation
|
I created an issue outlining docs changes we'll want to work on this upcoming iteration: #5593. This PR attempts to focus on some of the quickest changes (the 3 checkboxes outlined above), while some of the others in issue 5593 are a bit longer-term (i.e. more restructuring, getting started content across docs, blog post). @Chuxel @chrmarti would love your eyes on this PR to get things started, and please let me know if you have any other docs changes in mind too for the longer list! |
| @@ -9,185 +9,18 @@ DateApproved: 8/4/2022 | |||
| --- | |||
| # devcontainer.json reference | |||
|
|
|||
| A `devcontainer.json` file in your project tells Visual Studio Code (and other services and tools that support the format) how to access (or create) a **development container** with a well-defined tool and runtime stack. It's currently supported by the [Remote - Containers](https://aka.ms/vscode-remote/download/containers) extension and [GitHub Codespaces](https://github.com/features/codespaces). | |||
| A `devcontainer.json` file in your project tells Visual Studio Code (and other services and tools that support the format) how to access (or create) a **development container** with a well-defined tool and runtime stack. | |||
There was a problem hiding this comment.
We could put a cut-to-the-chase "TL;DR - This document has moved to the dev container spec site!" up at the top with a direct link to reduce the amount of reading.
Can the left nav also point to the new spot @gregvanl?
There was a problem hiding this comment.
Added that sentence to the top and cut down a bit more content.
Would also be interested in what @gregvanl thinks!
There was a problem hiding this comment.
@bamurtaugh @Chuxel Yep, we can easily redirect an existing left nav item to a different location or site.
For example:
Python > Data Science jumps to Data Science > Overview
Containers > Develop with Kubernetes redirects to https://docs.microsoft.com/visualstudio/bridge/bridge-to-kubernetes-vs-code
Redirects are added in the vscode-website repo, which I can do when you're ready
There was a problem hiding this comment.
Perfect, thanks for confirming, Greg! Yes, once we merge this PR, let's redirect the devcontainer.json page under the Remote TOC to https://containers.dev/implementors/json_reference/.
I still update the content on our devcontainer.json page in this PR in case someone has specifically saved or otherwise gets to this URL.
Co-authored-by: Chuck Lantz <chuck_lantz@hotmail.com>
docs/remote/devcontainer-cli.md
Outdated
| } | ||
| } | ||
|
|
||
| ### [Optional] Avoiding problems with images built using Docker |
There was a problem hiding this comment.
Is this too much detail maybe? (Also: Would we want to avoid "vscode" and use "devcontainer" instead?)
There was a problem hiding this comment.
Yeah, upon a re-read, it does feel a bit specific and VS Code-centric (and while these are VS Code docs, this is the section on the open agnostic CLI). We had added it based on previous user request, but I think that may have been a singular or small number of users, so I don't anticipate this would be a big point of confusion. Removed, cc @Chuxel if you have other thoughts.
There was a problem hiding this comment.
This bit of doc was actually contributed by a user who apparently hit this, so not sure we want to remove it, but it's more of a "tip" than a requirement - it could be moved to an "Advanced" topic (though maybe linked from here?) Agree that using devcontainer-cli as the ARG name is better than vscode tho.
There was a problem hiding this comment.
It might be loosely enough related to https://code.visualstudio.com/remote/advancedcontainers/reduce-docker-warnings, that I could add the info there?
There was a problem hiding this comment.
I just pushed a change to add this info in https://code.visualstudio.com/remote/advancedcontainers/reduce-docker-warnings and to point to it from devcontainer-cli.md. I also updated the ARG name to devcontainercli.
|
@gregvanl this is ready for your review and merge! And we'd want to update the devcontainer.json node in the TOC to point to https://containers.dev/implementors/json_reference/, as discussed above. |
With the latest work on the specification, we want to update the dev containers content on the VS Code docs site.
cc @Chuxel