Skip to content

Commit 9af6a6a

Browse files
timeyoutakeit2percentsilksaritai
authored
Configuring codespaces (#19219)
* updating configuring doc * Adding some content changes * pre-built -> predefined to match vscode * reorganizing * moving guides around, rewriting about * adding reference folder * fixing brooken links * clarifying and simplifying about doc * removing limitations * Apply suggestions from code review Co-authored-by: Allison Weins <[email protected]> Co-authored-by: Sarita Iyer <[email protected]> * review changes * Update content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md Co-authored-by: Allison Weins <[email protected]> Co-authored-by: Allison Weins <[email protected]> Co-authored-by: Sarita Iyer <[email protected]>
1 parent 167ae04 commit 9af6a6a

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

content/codespaces/about-codespaces.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,26 @@ topics:
2626

2727
A codespace includes everything developers need to develop for a specific repository, including the {% data variables.product.prodname_vscode %} editing experience and common languages, tools, and utilities. {% data variables.product.prodname_codespaces %} is completely configurable, allowing you to create a customized development environment for your project, and allowing developers to personalize their experience with extensions and dotfile settings.
2828

29-
Codespaces offers many benefits to all teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development.
29+
Codespaces offers many benefits to teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development.
3030

3131

3232
### A consistent environment
3333

34-
You can create a single codespace configuration that defines the environment of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. The standard environment is already available for them as soon as they create a codespace from the repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)."
34+
You can create a single codespace configuration that defines the environment (or _dev container_) of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. A standardized environment is already available for them as soon as they create a codespace from the repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)."
3535

3636
For help getting started with configurations for specific languages, see the [Getting Started](/codespaces/getting-started-with-codespaces) tutorials.
3737

3838
While every codespace created from your repository has a consistent development environment, developers can use {% data variables.product.prodname_codespaces %} wherever they need it – on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}.
3939

4040
### Fast and personal onboarding
4141

42-
With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) already configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**.
42+
With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**.
4343

4444
![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png)
4545

46-
Developers can start coding faster by reducing time spent configuring their environment.
46+
As a result of standardizing on a repeatable developer environment, developers can get started with a new codespace without doing any manual configuration and do not need to do continued maintenance of their developer environment. A new codespace can be created when starting a new feature.
4747

48-
Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository. Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)."
48+
Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)."
4949

5050
Because {% data variables.product.prodname_codespaces %} can be accessed in the browser, developers can work on multiple projects by switching between tabs.
5151

content/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ A development container, or dev container, is the environment that {% data varia
2424

2525
{% data reusables.codespaces.devcontainer-location %}
2626

27-
You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual Workspaces in a codespace in a file named `.vscode/settings.json`.
27+
You can use your `devcontainer.json` to set default settings for the entire codespace environment, including the editor, but you can also set editor-specific settings for individual [workspaces](https://code.visualstudio.com/docs/editor/workspaces) in a codespace in a file named `.vscode/settings.json`.
2828

2929
For information about the settings and properties that you can set in a `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation.
3030

@@ -73,7 +73,7 @@ Predefined container definitions include a common configuration for a particular
7373

7474
Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project's setup.
7575

76-
1. To access the command palette, in the bottom-left corner click **Codespaces**, then start typing "Codespaces: Add Development Container Configuration Files...". Click **Codespaces: Add Development Container Configuration Files...**
76+
1. To access the command palette, in the upper-left corner, select the Application Menu and click **Command Palette…** from the **View** menu, then start typing "Codespaces: Add Development Container Configuration Files...". Click **Codespaces: Add Development Container Configuration Files...**
7777
!["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png)
7878
1. Click the definition you want to use.
7979
![List of predefined container definitions](/assets/images/help/codespaces/predefined-container-definitions-list.png)
@@ -88,7 +88,7 @@ Using a predefined configuration is a great idea if you need some additional ext
8888

8989
If none of the predefined configurations meet your needs, you can create a custom configuration by adding a `devcontainer.json` file. {% data reusables.codespaces.devcontainer-location %}
9090

91-
In the file, you can use supported configuration keys to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed.
91+
In the file, you can use [supported configuration keys](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed.
9292

9393
{% data reusables.codespaces.vscode-settings-order %}
9494

0 commit comments

Comments
 (0)