1
0
mirror of synced 2025-12-22 03:16:52 -05:00

updating content files

This commit is contained in:
Grace Park
2021-06-14 12:06:52 -07:00
parent 850ab9ccb4
commit 6f7e4f50dc
1154 changed files with 6299 additions and 6267 deletions

View File

@@ -11,16 +11,16 @@ topics:
{% data reusables.codespaces.release-stage %}
### Introduction
## Introduction
This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
#### Prerequisites
### Prerequisites
- You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart.
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
### Step 1: Open your project in a codespace
## Step 1: Open your project in a codespace
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you dont see this option, your project isnt available for {% data variables.product.prodname_codespaces %}.
@@ -36,7 +36,7 @@ You can customize your codespace by adjusting the amount of vCPUs and RAM, [addi
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
### Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
@@ -53,7 +53,7 @@ To set up your project with a custom container, you will need to use a `devconta
![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png)
{% data reusables.codespaces.rebuild-command %}
#### Anatomy of your dev container
### Anatomy of your dev container
Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files:
@@ -62,7 +62,7 @@ Adding the C# (.NET) dev container template adds a `.devcontainer` folder to the
The newly added `devcontainer.json` file defines a few properties that are described after the sample.
##### devcontainer.json
#### devcontainer.json
```json
{
@@ -136,7 +136,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
- **postCreateCommand** - If you want to run anything after you land in your codespace thats not defined in the Dockerfile, like `dotnet restore`, you can do that here.
- **remoteUser** - By default, youre running as the vscode user, but you can optionally set this to root.
##### Dockerfile
#### Dockerfile
```bash
# [Choice] .NET version: 5.0, 3.1, 2.1
@@ -164,7 +164,7 @@ RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-d
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
### Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependancies when your codespace launches.
@@ -196,7 +196,7 @@ With your dev container added and a basic understanding of what everything does,
![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png)
### Step 4: Run your application
## Step 4: Run your application
In the previous section, you used the `postCreateCommand` to installing a set of packages via pip3. With our dependencies now installed, we can run our application.
@@ -206,11 +206,11 @@ In the previous section, you used the `postCreateCommand` to installing a set of
![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png)
### Step 5: Commit your changes
## Step 5: Commit your changes
{% data reusables.codespaces.committing-link-to-procedure %}
### Next steps
## Next steps
You should now be ready start developing your C# (.NET) project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios.

View File

@@ -10,16 +10,16 @@ topics:
{% data reusables.codespaces.release-stage %}
### Introduction
## Introduction
This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
#### Prerequisites
### Prerequisites
- You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
### Step 1: Open your project in a codespace
## Step 1: Open your project in a codespace
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you dont see this option, your project isnt available for {% data variables.product.prodname_codespaces %}.
@@ -35,7 +35,7 @@ You can customize your codespace by adjusting the amount of vCPUs and RAM, [addi
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
### Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
@@ -49,7 +49,7 @@ To set up your project with a custom container, you will need to use a `devconta
![Java version selection](/assets/images/help/codespaces/add-java-version.png)
{% data reusables.codespaces.rebuild-command %}
#### Anatomy of your dev container
### Anatomy of your dev container
Adding the Java dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files:
@@ -58,7 +58,7 @@ Adding the Java dev container template adds a `.devcontainer` folder to the root
The newly added `devcontainer.json` file defines a few properties that are described after the sample.
##### devcontainer.json
#### devcontainer.json
```json
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
@@ -114,7 +114,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
- **postCreateCommand** - If you want to run anything after you land in your codespace thats not defined in the Dockerfile, you can do that here.
- **remoteUser** - By default, youre running as the `vscode` user, but you can optionally set this to `root`.
##### Dockerfile
#### Dockerfile
```bash
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.159.0/containers/java/.devcontainer/base.Dockerfile
@@ -144,7 +144,7 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/shar
You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile.
### Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches.
@@ -166,7 +166,7 @@ With your dev container added and a basic understanding of what everything does,
Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, youll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container.
### Step 4: Run your application
## Step 4: Run your application
In the previous section, you used the `postCreateCommand` to install a set of packages via npm. You can now use this to run our application with npm.
@@ -176,11 +176,11 @@ In the previous section, you used the `postCreateCommand` to install a set of pa
![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png)
### Step 5: Commit your changes
## Step 5: Commit your changes
{% data reusables.codespaces.committing-link-to-procedure %}
### Next steps
## Next steps
You should now be ready start developing your Java project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios.

View File

@@ -14,16 +14,16 @@ topics:
{% data reusables.codespaces.release-stage %}
### Introduction
## Introduction
This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
#### Prerequisites
### Prerequisites
- You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
### Step 1: Open your project in a codespace
## Step 1: Open your project in a codespace
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you dont see this option, your project isnt available for {% data variables.product.prodname_codespaces %}.
@@ -38,7 +38,7 @@ You can customize your codespace by adjusting the amount of vCPUs and RAM, [addi
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
### Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
@@ -51,7 +51,7 @@ To set up your project with a custom container, you will need to use a `devconta
![Node.js version selection](/assets/images/help/codespaces/add-node-version.png)
{% data reusables.codespaces.rebuild-command %}
#### Anatomy of your dev container
### Anatomy of your dev container
Adding the Node.js dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files:
@@ -60,7 +60,7 @@ Adding the Node.js dev container template adds a `.devcontainer` folder to the r
The newly added `devcontainer.json` file defines a few properties that are described after the sample.
##### devcontainer.json
#### devcontainer.json
```json
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
@@ -107,7 +107,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
- **postCreateCommand** - If you want to run anything after you land in your codespace thats not defined in the Dockerfile, you can do that here.
- **remoteUser** - By default, youre running as the vscode user, but you can optionally set this to root.
##### Dockerfile
#### Dockerfile
```bash
# [Choice] Node.js version: 14, 12, 10
@@ -128,7 +128,7 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile.
### Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally.
@@ -150,7 +150,7 @@ With your dev container added and a basic understanding of what everything does,
Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, youll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container.
### Step 4: Run your application
## Step 4: Run your application
In the previous section, you used the `postCreateCommand` to installing a set of packages via npm. You can now use this to run our application with npm.
@@ -162,11 +162,11 @@ In the previous section, you used the `postCreateCommand` to installing a set of
![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png)
### Step 5: Commit your changes
## Step 5: Commit your changes
{% data reusables.codespaces.committing-link-to-procedure %}
### Next steps
## Next steps
You should now be ready start developing your JavaScript project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios.

View File

@@ -13,16 +13,16 @@ topics:
{% data reusables.codespaces.release-stage %}
### Introduction
## Introduction
This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template.
#### Prerequisites
### Prerequisites
- You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart.
- You must have {% data variables.product.prodname_codespaces %} enabled for your organization.
### Step 1: Open your project in a codespace
## Step 1: Open your project in a codespace
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you dont see this option, your project isnt available for {% data variables.product.prodname_codespaces %}.
@@ -38,7 +38,7 @@ You can customize your codespace by adjusting the amount of vCPUs and RAM, [addi
{% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
### Step 2: Add a dev container to your codespace from a template
## Step 2: Add a dev container to your codespace from a template
The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository.
@@ -54,7 +54,7 @@ To set up your project with a custom container, you will need to use a `devconta
![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png)
{% data reusables.codespaces.rebuild-command %}
#### Anatomy of your dev container
### Anatomy of your dev container
Adding the Python dev container template adds a `.devcontainer` folder to the root of your project's repository with the following files:
@@ -63,7 +63,7 @@ Adding the Python dev container template adds a `.devcontainer` folder to the ro
The newly added `devcontainer.json` file defines a few properties that are described after the sample.
##### devcontainer.json
#### devcontainer.json
```json
{
@@ -126,7 +126,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr
- **postCreateCommand** - If you want to run anything after you land in your codespace thats not defined in the Dockerfile, like `pip3 install -r requirements`, you can do that here.
- **remoteUser** - By default, youre running as the `vscode` user, but you can optionally set this to `root`.
##### Dockerfile
#### Dockerfile
```bash
# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6
@@ -153,7 +153,7 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/l
You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container.
### Step 3: Modify your devcontainer.json file
## Step 3: Modify your devcontainer.json file
With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependancies when your codespace launches.
@@ -186,7 +186,7 @@ With your dev container added and a basic understanding of what everything does,
![Extensions list](/assets/images/help/codespaces/python-extensions.png)
### Step 4: Run your application
## Step 4: Run your application
In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application.
@@ -196,11 +196,11 @@ In the previous section, you used the `postCreateCommand` to install a set of pa
![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png)
### Step 5: Commit your changes
## Step 5: Commit your changes
{% data reusables.codespaces.committing-link-to-procedure %}
### Next steps
## Next steps
You should now be ready start developing your Python project in {% data variables.product.prodname_codespaces %}. Here are some additional resources for more advanced scenarios.