Initial version of the spec. #33
Conversation
docs/specs/supporting-tools.md
Outdated
| A [codespace](https://docs.github.com/en/codespaces/overview) is a development environment that's hosted in the cloud. Codespaces run on a variety of VM-based compute options hosted by GitHub.com, which you can configure from 2 core machines up to 32 core machines. You can connect to your codespaces from the browser or locally using Visual Studio Code. | ||
|
|
||
| > **Tip:** If you've already built a codespace and connected to it, be sure to run **Codespaces: Rebuild Container** from the Command Palette (`kbstyle(F1)`) to pick up any changes you make. |
There was a problem hiding this comment.
The repository properties are now available publicly for Codespaces, correct? Shouldn't we should include those here assuming so. @edgonmsft @bamurtaugh ?
docs/specs/supporting-tools.md
Outdated
| Some properties are specific to VS Code. Please note that Codespaces supports the VS Code properties. | ||
|
|
||
| | Property | Type | Description | | ||
| |----------|------|-------------| | ||
| | `extensions` | array | An array of extension IDs that specify the extensions that should be installed inside the container when it is created. Defaults to `[]`. | | ||
| | `settings` | object | Adds default `settings.json` values into a container/machine specific settings file. Defaults to `{}`. | |
There was a problem hiding this comment.
We should update these to be under "customizaitons": { "vscode": {} }. It's not clear these are there from this content.
There was a problem hiding this comment.
I added the customizations property to the main definition and reorganized supporting-tools.md a little bit for this.
There was a problem hiding this comment.
Was customizations added to the files in this PR? I'm trying to search for it, but I can't seem to find it.
There was a problem hiding this comment.
Odd, now I see it (maybe it was an old cached version). LGTM!
docs/specs/devcontainer-reference.md
Outdated
| The current metadata schema for **development containers** is contained in a `devcontainer.json` file. | ||
|
|
||
| The `devcontainer.json` specification contains different configuration options related to the underlying orchestrator format. At the same time this specification leaves space for further development and implementation of other orchestrator mechanisms and file formats. |
There was a problem hiding this comment.
Given we had an item in this repo that dealt with where devcontainer.json can be found, I'd suggest including that logic here. e.g.,
While this metadata may be provided in different ways, when searching for a
devcontainer.jsonfile, products should expect to find a devcontainer.json file in one or more of the following locations (in order of precidence):
.devcontainer/devcontainer.json.devcontainer.json.devcontainer/**/devcontainer.json(where**is a sub-folder)It is valid that these files may exist in more than one location, so consider providing a mechanism for users to select one when appropriate.
@chrmarti @edgonmsft is the above the right order?
There was a problem hiding this comment.
Thanks so much for sharing this, @edgonmsft! Left some comments and suggestions.
In chatting with @Chuxel and now reviewing this PR, I'll close #12 in favor of this PR, as this PR includes the devcontainer.json reference and supporting tools info.
Co-authored-by: Brigit Murtaugh <[email protected]>
Co-authored-by: Brigit Murtaugh <[email protected]>
Co-authored-by: Brigit Murtaugh <[email protected]>
|
Thanks! Let's merge it and deal with comments in other PR's. |
This is an initial version of the specification.
cc @Chuxel, @chrmarti, @joshspicer