Clarifications

microsoft · Apr 10, 2019 · c848c48 · c848c48
1 parent 311bfc2
commit c848c48
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 69 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,6 +2,71 @@
 
 There are many ways for you to contribute to VS Code Remote Development. This document will outline a number of ways you can get involved.
 
+## Contributing Dev Container Definitions
+
+Have a container set up you're proud of and would like to share? Want to see some changes made to an existing definition We love contributions!  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+
+If you want to create a new definition:
+
+1. Fork and clone this repository
+
+2. Create a new folder in the `containers` directory. The name of the folder is effectively the **definition ID** and should follow the following format:
+
+    ````text
+    <language>-<optional: version>-<descriptor>
+    ````
+
+    You'll find many examples in the current `containers` folder.
+
+3. You can grab one of the templates from the `container-templates` folder to help you get an idea of what to contribute for different scenarios, but here's a quick summary of what you should include:
+
+    ```text
+    📁 <language>-<optional: version>-<descriptor>
+       📁 .devcontainer
+          📄 devcontainer.json
+          📄 Dockerfile (optional)
+          📄 docker-compose.yml (optional)
+       📁 test-project (optional)
+       📄 .npmignore
+       📄 README.md
+    ```
+
+    See the [VS Code Remote Development documentation](https://aka.ms/vscode-remote/docker) for information on the expected contents of `devcontainer.json` and how it relates to other files listed above.
+
+    Note that any additional assets can be included as needed, but keep in mind that these will overlay on top of an existing project. Keeping these files in the `.devcontainer` should reduce the chances of something conflicting but note that any command that are run are relative to the root of the project, so you'll need to include `.devcontainer` in any path references.
+
+    VS Code respects [`.npmignore`](https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package) as a way to keep certain content out of projects when your definition is used. Add anything you don't want copied across into this file in [glob](https://facelessuser.github.io/wcmatch/glob/) form.
+
+    Finally, create a `README.md` in the folder with a brief description of the purpose of the container definition and any manual steps required to use it.
+
+4. Commit your changes and submit a PR - we'll take a look at it, provide any needed feedback, and then merge it in! We appreciate any and all feedback!!
+
+### Developing and testing a definition
+
+VS Code Remote provides a straight forward development loop for creating and editing container definitions. Just follow these steps to get started:
+
+1. Create a definition folder and open it in VS Code
+2. Edit the contents of the definition
+3. Run the **Remote: Reopen Folder in Container** command
+4. If this fails, click "Open folder locally" in the dialog that appears and go to step 2
+6. If it opens successfully but you don't like the contents, edit the contents from within the container and run the **Remote: Rebuild Container** command to make changes.
+
+Note that if you make major changes, Docker may occasionally not pick up your edits. If this happens, you can delete the existing container and image, open the folder locally, and go to step 2 above. Install the [Docker extension](https://marketplace.visualstudio.com/items?itemName=PeterJausovec.vscode-docker) locally (when not in a container) to make this easy. While you can use Docker from inside a container by forwarding the Docker unix socket and installing the CLI in the container (see [Docker-in-Docker](containers/docker-in-docker)), you'll likely be removing the container you are actually using so this approach will not work well in this case.
+
+Finally, after you get your container up and running, you can test it by adding test assets into the definition folder as long as they are referenced in the `.devcontainer/ignore` file in [glob](https://facelessuser.github.io/wcmatch/glob/) form ith paths relative the root of the folder. By convention, most definitions place test assets in a `test-project` folder and this path is referenced in the template `ignore` files. 
+
+### Speeding up container provisioning
+
+While using a `Dockerfile` is a convienent way to get going with a new container definition, this method can slow down the process of creating the dev container since it requires the image be built by anyone using it.  If your definition is stable, we strongly reccomend building and publishing your image to [DockerHub](https://hub.docker.com) or [Azure Container Registry](https://azure.microsoft.com/en-us/services/container-registry/) instead. 
+
+Once you've published your container image, just update `devcontainer.json` to reference the image instead of the `Dockerfile`. See `container-templates/image` for an example.
+
+## Contributing to Documentation
+
+The majority of VS Code Remote's documentation can be found in the [VS Code docs repository](https://github.com/Microsoft/vscode-docs). This is usually the best place to contribute, but if you have a correction or suggestion for the countent found here, we welcome your contributions.
+
 ## Reporting Issues
 
 Have you identified a reproducible problem in a dev container definition? We want to hear about it! Here's how you can make reporting your issue as effective as possible.
@@ -78,69 +143,6 @@ We use a bot to help us manage issues. This bot currently:
 
 If you believe the bot got something wrong, please open a new issue and let us know.
 
-## Contributing Dev Container Definitions
-
-Have a container set up you're proud of and would like to share? Want to see some changes made to an existing definition We love contributions!  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
-
-When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
-
-If you want to create a new definition:
-
-1. Fork and clone this repository
-
-2. Create a new folder in the `containers` directory. The name of the folder is effectively the **definition ID** and should follow the following format:
-
-    ````
-    <language>-<optional: version>-<descriptor>
-    ````
-
-    You'll find many examples in the current `containers` folder.
-
-3. You can grab one of the templates from the `container-templates` folder to help you get an idea of what to contribute for different scenarios, but here's a quick summary of what you should include:
-
-    ```
-    📁 <language>-<optional: version>-<descriptor>
-       📁 .devcontainer
-          📄 devcontainer.json
-          📄 Dockerfile (optional)
-          📄 docker-compose.yml (optional)
-       📁 test-project (optional)
-       📄 .npmignore
-       📄 README.md
-    ```
-
-    See the [VS Code Remote Development documentation](https://aka.ms/vscode-remote/docker) for information on the expected contents of `devcontainer.json` and how it relates to other files listed above.
-
-    Note that any additional assets can be included as needed, but keep in mind that these will overlay on top of an existing project. Keeping these files in the `.devcontainer` should reduce the chances of something conflicting but note that any command that are run are relative to the root of the project, so you'll need to include `.devcontainer` in any path references.
-
-    Anything you don't want added to a project should be referenced in [glob](https://facelessuser.github.io/wcmatch/glob/) form in `.npmignore` with paths relative to the root of the folder. Create a `README.md` in the folder with a brief description of the purpose of the container definition and any manual steps required to use it.
-
-4. Commit your changes and submit a PR - we'll take a look at it, provide any needed feedback, and then merge it in! We appreciate any and all feedback!!
-
-### Developing and testing a definition
-
-VS Code Remote provides a straight forward development loop for creating and editing container definitions. Just follow these steps to get started:
-
-1. Create a definition folder and open it in VS Code
-2. Edit the contents of the definition
-3. Run the **Remote: Reopen Folder in Container** command
-4. If this fails, click "Open folder locally" in the dialog that appears and go to step 2
-6. If it opens successfully but you don't like the contents, edit the contents from within the container and run the **Remote: Rebuild Container** command to make changes.
-
-Note that if you make major changes, Docker may occasionally not pick up your edits. If this happens, you can delete the existing container and image, open the folder locally, and go to step 2 above. Install the [Docker extension](https://marketplace.visualstudio.com/items?itemName=PeterJausovec.vscode-docker) locally (when not in a container) to make this easy. While you can use Docker from inside a container by forwarding the Docker unix socket and installing the CLI in the container (see [Docker-in-Docker](containers/docker-in-docker)), you'll likely be removing the container you are actually using so this approach will not work well in this case.
-
-Finally, after you get your container up and running, you can test it by adding test assets into the definition folder as long as they are referenced in the `.devcontainer/ignore` file in [glob](https://facelessuser.github.io/wcmatch/glob/) form ith paths relative the root of the folder. By convention, most definitions place test assets in a `test-project` folder and this path is referenced in the template `ignore` files. 
-
-### Speeding up container provisioning
-
-While using a `Dockerfile` is a convienent way to get going with a new container definition, this method can slow down the process of creating the dev container since it requires the image be built by anyone using it.  If your definition is stable, we strongly reccomend building and publishing your image to [DockerHub](https://hub.docker.com) or [Azure Container Registry](https://azure.microsoft.com/en-us/services/container-registry/) instead. 
-
-Once you've published your container image, just update `devcontainer.json` to reference the image instead of the `Dockerfile`. See `container-templates/image` for an example.
-
-## Contributing to Documentation
-
-The majority of VS Code Remote's documentation can be found in the [VS Code docs repository](https://github.com/Microsoft/vscode-docs). This is usually the best place to contribute, but if you have a correction or suggestion for the countent found here, we welcome your contributions.
-
 ## Code of Conduct
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

diff --git a/README.md b/README.md
@@ -16,15 +16,15 @@ This repository contains a set of **dev container definitions** made up of files
 4. Run the **Remote-Containers: Open Folder in Container...** command in VS Code
 5. Select the root of the definition folder in the "open" dialog (**not** the `test-project` folder if present)
 
-Many definitions include a `test-project` with a sample and/or launch settings in the `.vscode` folder that you can use to see the dev container in action. If you open the folder locally instead, you'll be prompted to reopen it in a container but uou can also use the **Remote-Containers: Reopen Folder in Container** command at any time.
+Many definitions include a `test-project` with a sample and/or launch settings in the `.vscode` folder that you can use to see the dev container in action.
 
 ## Using a definition
 
 You can either:
 
-- Run **Remote-Containers: Create Container Configuration File...** command in VS Code and pick a definition. The appropriate files will then be added to your project. These are updated with each VS Code release.
+- Open a folder in VS Code without a `devcontainer.json` file and run the **Remote-Containers: Create Container Configuration File...** or **Remote-Containers: Reopen Folder in Container** commands. You be prompted to pick a definition and any options and the appropriate files will then be added to your project.
 
-- Manually copy the contents of one of the `containers` sub-folders into your project. Copy the `.devcontainer` folder into your project and you should be ready to go!
+- Manually copy the contents of one of the `containers` sub-folders into your project. Typically you can just copy the `.devcontainer` folder into your project but the folder's README may mention additional files.
 
 ## Adding a definition to an existing public or private repo
 
@@ -34,15 +34,15 @@ Beyond the advantages of having your team use a consistent environment and tool-
 
 ## Contents
 
-- `containers` - Dev container definition folders. 
-- `container-templates` - Templates for creating your own container definitions in your project or for contributing back to this repository.
+- `containers` - Contains reusable dev container definitions.
+- `container-templates` - Contains templates for creating your own container definitions for your project or to [contribute back](CONTRIBUTING.md#contributing-dev-container-definitions).
 - `repository-configurations` - Dev container definitions working on a cloned copy of specific, public source code repository (rather than general purpose).
 
 ## Common Questions
 
 ### Can I just reuse an existing container image or Docker configuration?
 
-Absolutely! If you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the command pallette (Cmd/Ctrl+Shift+P). You'll be prompted to select a Dockerfile or you can opt to use a base image instead and customize from there. 
+Absolutely! If you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the command pallette (Cmd/Ctrl+Shift+P). You'll be prompted to select a Dockerfile or you can opt to use a base image instead and customize from there.
 
 You can also check out the [existing Dockerfile](containers/docker-existing-dockerfile) and [existing Docker Compose](containers/docker-existing-docker-compose) definitions for an example. You can also [attach to an already running container](https://aka.ms/vscode-remote/containers/attach) if you'd prefer.
 

diff --git a/containers/rust/.npmignore b/containers/rust/.npmignore
@@ -1,3 +1,5 @@
+README.md
+.vscode
 src
 Cargo.lock
 Cargo.toml