From 2a4185cd57cb1f68191212e5a035e00e831d7511 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Tue, 12 Apr 2022 15:58:44 +0200 Subject: [PATCH 1/6] Added variable and consistent use of Visual Studio Code and VS Code --- .../deploying-nodejs-to-azure-app-service.md | 2 +- .../disaster-recovery-for-codespaces.md | 2 +- .../security-in-codespaces.md | 4 +-- .../using-github-copilot-in-codespaces.md | 2 +- ...e-vs-code-command-palette-in-codespaces.md | 20 ++++++------ .../creating-a-codespace.md | 2 +- .../using-codespaces-in-visual-studio-code.md | 32 +++++++++---------- .../using-source-control-in-your-codespace.md | 2 +- .../codespaces/getting-started/deep-dive.md | 14 ++++---- .../codespaces/getting-started/quickstart.md | 4 +-- ...ing-for-codespaces-in-your-organization.md | 2 +- content/codespaces/overview.md | 2 +- .../configuring-prebuilds.md | 2 +- ...ing-up-your-java-project-for-codespaces.md | 2 +- .../the-githubdev-web-based-editor.md | 14 ++++---- .../troubleshooting-prebuilds.md | 2 +- .../configuring-a-default-editor.md | 4 +-- ...isual-studio-code-with-github-classroom.md | 18 +++++------ .../integrate-github-classroom-with-an-ide.md | 2 +- .../github-extensions-and-integrations.md | 10 +++--- .../associating-text-editors-with-git.md | 12 +++---- ...etting-started-with-your-github-account.md | 2 +- .../copilot/about-github-copilot-telemetry.md | 2 +- .../github-codespaces-privacy-statement.md | 6 ++-- .../click-remote-explorer-icon-vscode.md | 2 +- data/variables/product.yml | 6 +++- 26 files changed, 88 insertions(+), 84 deletions(-) diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md index b8820ec1a3be..f11ff3b4406f 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md @@ -135,4 +135,4 @@ The following resources may also be useful: * The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action. * For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository. -* The "[Create a Node.js web app in Azure](https://docs.microsoft.com/azure/app-service/quickstart-nodejs)" quickstart in the Azure web app documentation demonstrates using VS Code with the [Azure App Service extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice). +* The "[Create a Node.js web app in Azure](https://docs.microsoft.com/azure/app-service/quickstart-nodejs)" quickstart in the Azure web app documentation demonstrates using {% data variables.product.prodname_vscode %} with the [Azure App Service extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice). diff --git a/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md b/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md index 71bac5b61d8d..5cd930c14635 100644 --- a/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md +++ b/content/codespaces/codespaces-reference/disaster-recovery-for-codespaces.md @@ -42,7 +42,7 @@ While this option does not configure a development environment for you, it will ## Option 4: Use Remote-Containers and Docker for a local containerized environment -If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in Visual Studio Code to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. +If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. {% note %} diff --git a/content/codespaces/codespaces-reference/security-in-codespaces.md b/content/codespaces/codespaces-reference/security-in-codespaces.md index 084b59c82ad5..2def7fff883a 100644 --- a/content/codespaces/codespaces-reference/security-in-codespaces.md +++ b/content/codespaces/codespaces-reference/security-in-codespaces.md @@ -34,7 +34,7 @@ Each codespace has its own isolated virtual network. We use firewalls to block i ### Authentication -You can connect to a codespace using a web browser or from Visual Studio Code. If you connect from Visual Studio Code, you are prompted to authenticate with {% data variables.product.product_name %}. +You can connect to a codespace using a web browser or from {% data variables.product.prodname_vscode %}. If you connect from {% data variables.product.prodname_vscode_shortname %}, you are prompted to authenticate with {% data variables.product.product_name %}. Every time a codespace is created or restarted, it's assigned a new {% data variables.product.company_short %} token with an automatic expiry period. This period allows you to work in the codespace without needing to reauthenticate during a typical working day, but reduces the chance that you will leave a connection open when you stop using the codespace. @@ -107,4 +107,4 @@ Certain development features can potentially add risk to your environment. For e #### Using extensions -Any additional {% data variables.product.prodname_vscode %} extensions that you've installed can potentially introduce more risk. To help mitigate this risk, ensure that the you only install trusted extensions, and that they are always kept up to date. +Any additional {% data variables.product.prodname_vscode_shortname %} extensions that you've installed can potentially introduce more risk. To help mitigate this risk, ensure that the you only install trusted extensions, and that they are always kept up to date. diff --git a/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md b/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md index 0f642d8ead98..ac5d598c5a45 100644 --- a/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md +++ b/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md @@ -17,7 +17,7 @@ redirect_from: ## Using {% data variables.product.prodname_copilot %} -[{% data variables.product.prodname_copilot %}](https://copilot.github.com/), an AI pair programmer, can be used in any codespace. To start using {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_codespaces %}, install the [{% data variables.product.prodname_copilot_short %} extension from the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). +[{% data variables.product.prodname_copilot %}](https://copilot.github.com/), an AI pair programmer, can be used in any codespace. To start using {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_codespaces %}, install the [{% data variables.product.prodname_copilot_short %} extension from the {% data variables.product.prodname_vs_marketplace %}](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). To include {% data variables.product.prodname_copilot_short %}, or other extensions, in all of your codespaces, enable Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)." Additionally, to include {% data variables.product.prodname_copilot_short %} in a given project for all users, you can specify `GitHub.copilot` as an extension in your `devcontainer.json` file. For information about configuring a `devcontainer.json` file, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/codespaces/customizing-your-codespace/configuring-codespaces-for-your-project#creating-a-custom-codespace-configuration)." diff --git a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md index 1abf739940ad..657e1144b73a 100644 --- a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md +++ b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md @@ -15,13 +15,13 @@ redirect_from: - /codespaces/codespaces-reference/using-the-command-palette-in-codespaces --- -## About the {% data variables.product.prodname_vscode %} Command Palette +## About the {% data variables.product.prodname_vs_command_palette %} -The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in Codespaces. The {% data variables.product.prodname_vscode_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information on using the {% data variables.product.prodname_vscode_command_palette %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the Visual Studio Code documentation. +The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in Codespaces. The {% data variables.product.prodname_vs_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vs_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. -## Accessing the {% data variables.product.prodname_vscode_command_palette %} +## Accessing the {% data variables.product.prodname_vs_command_palette_shortname %} -You can access the {% data variables.product.prodname_vscode_command_palette %} in a number of ways. +You can access the {% data variables.product.prodname_vs_command_palette_shortname %} in a number of ways. - Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). @@ -33,7 +33,7 @@ You can access the {% data variables.product.prodname_vscode_command_palette %} ## Commands for {% data variables.product.prodname_github_codespaces %} -To see all commands related to {% data variables.product.prodname_github_codespaces %}, [access the {% data variables.product.prodname_vscode_command_palette %}](#accessing-the-command-palette), then start typing "Codespaces". +To see all commands related to {% data variables.product.prodname_github_codespaces %}, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "Codespaces". ![A list of all commands that relate to Codespaces](/assets/images/help/codespaces/codespaces-command-palette.png) @@ -41,13 +41,13 @@ To see all commands related to {% data variables.product.prodname_github_codespa If you add a new secret or change the machine type, you'll have to stop and restart the codespace for it to apply your changes. -To suspend or stop your codespace's container, [access the {% data variables.product.prodname_vscode_command_palette %}](#accessing-the-command-palette), then start typing "stop". Select **Codespaces: Stop Current Codespace**. +To suspend or stop your codespace's container, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "stop". Select **Codespaces: Stop Current Codespace**. ![Command to stop a codespace](/assets/images/help/codespaces/codespaces-stop.png) ### Adding a dev container from a template -To add a dev container from a template, [access the {% data variables.product.prodname_vscode_command_palette %}](#accessing-the-command-palette), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...** +To add a dev container from a template, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...** ![Command to add a dev container](/assets/images/help/codespaces/add-prebuilt-container-command.png) @@ -55,14 +55,14 @@ To add a dev container from a template, [access the {% data variables.product.pr If you add a dev container or edit any of the configuration files (`devcontainer.json` and `Dockerfile`), you'll have to rebuild your codespace for it to apply your changes. -To rebuild your container, [access the {% data variables.product.prodname_vscode_command_palette %}](#accessing-the-command-palette), then start typing "rebuild". Select **Codespaces: Rebuild Container**. +To rebuild your container, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Command to rebuild a codespace](/assets/images/help/codespaces/codespaces-rebuild.png) ### Codespaces logs -You can use the {% data variables.product.prodname_vscode_command_palette %} to access the codespace creation logs, or you can use it export all logs. +You can use the {% data variables.product.prodname_vs_command_palette_shortname %} to access the codespace creation logs, or you can use it export all logs. -To retrieve the logs for Codespaces, [access the {% data variables.product.prodname_vscode_command_palette %}](#accessing-the-command-palette), then start typing "log". Select **Codespaces: Export Logs** to export all logs related to Codespaces or select **Codespaces: View Creation Logs** to view logs related to the setup. +To retrieve the logs for Codespaces, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "log". Select **Codespaces: Export Logs** to export all logs related to Codespaces or select **Codespaces: View Creation Logs** to view logs related to the setup. ![Command to access logs](/assets/images/help/codespaces/codespaces-logs.png) diff --git a/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/content/codespaces/developing-in-codespaces/creating-a-codespace.md index b41b5bb61bf4..a65428ef15f4 100644 --- a/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -35,7 +35,7 @@ For more information on what happens when you create a codespace, see "[Deep Div For more information on the lifecycle of a codespace, see "[Codespaces lifecycle](/codespaces/developing-in-codespaces/codespaces-lifecycle)." -If you want to use Git hooks for your codespace, then you should set up hooks using the [`devcontainer.json` lifecycle scripts](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts), such as `postCreateCommand`, during step 4. Since your codespace container is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. For more information on using `postCreateCommand`, see the [`devcontainer.json` reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_devcontainerjson-properties) in the Visual Studio Code documentation. +If you want to use Git hooks for your codespace, then you should set up hooks using the [`devcontainer.json` lifecycle scripts](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts), such as `postCreateCommand`, during step 4. Since your codespace container is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. For more information on using `postCreateCommand`, see the [`devcontainer.json` reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_devcontainerjson-properties) in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.codespaces.use-visual-studio-features %} diff --git a/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md index 09de09991226..586474cb5581 100644 --- a/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ b/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md @@ -20,17 +20,17 @@ shortTitle: Visual Studio Code ## About {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %} -You can use your local install of {% data variables.product.prodname_vscode %} to create, manage, work in, and delete codespaces. To use {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %}, you need to install the {% data variables.product.prodname_github_codespaces %} extension. For more information on setting up Codespaces in {% data variables.product.prodname_vscode %}, see "[Prerequisites](#prerequisites)." +You can use your local install of {% data variables.product.prodname_vscode %} to create, manage, work in, and delete codespaces. To use {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode_shortname %}, you need to install the {% data variables.product.prodname_github_codespaces %} extension. For more information on setting up Codespaces in {% data variables.product.prodname_vscode_shortname %}, see "[Prerequisites](#prerequisites)." -By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode %}. For more information, see "[Setting your default editor for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces)." +By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode_shortname %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Setting your default editor for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces)." -If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)." +If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode_shortname %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)." ## Prerequisites -To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later. +To develop in a codespace directly in {% data variables.product.prodname_vscode_shortname %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode_shortname %} October 2020 Release 1.51 or later. -Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation. +Use the {% data variables.product.prodname_vs_marketplace %} to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode_shortname %} documentation. {% mac %} @@ -40,8 +40,8 @@ Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode-mac.png) -1. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. -1. Sign in to {% data variables.product.product_name %} to approve the extension. +2. To authorize {% data variables.product.prodname_vscode_shortname %} to access your account on {% data variables.product.product_name %}, click **Allow**. +3. Sign in to {% data variables.product.product_name %} to approve the extension. {% endmac %} @@ -56,30 +56,30 @@ Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% ![Signing in to view {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/sign-in-to-view-codespaces-vscode.png) -1. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**. +1. To authorize {% data variables.product.prodname_vscode_shortname %} to access your account on {% data variables.product.product_name %}, click **Allow**. 1. Sign in to {% data variables.product.product_name %} to approve the extension. {% endwindows %} -## Creating a codespace in {% data variables.product.prodname_vscode %} +## Creating a codespace in {% data variables.product.prodname_vscode_shortname %} {% data reusables.codespaces.creating-a-codespace-in-vscode %} -## Opening a codespace in {% data variables.product.prodname_vscode %} +## Opening a codespace in {% data variables.product.prodname_vscode_shortname %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} 1. Under "Codespaces", click the codespace you want to develop in. 1. Click the Connect to Codespace icon. - ![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) + ![The Connect to Codespace icon in {% data variables.product.prodname_vscode_shortname %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) -## Changing the machine type in {% data variables.product.prodname_vscode %} +## Changing the machine type in {% data variables.product.prodname_vscode_shortname %} {% data reusables.codespaces.codespaces-machine-types %} You can change the machine type of your codespace at any time. -1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). +1. In {% data variables.product.prodname_vscode_shortname %}, open the Command Palette (`shift command P` / `shift control P`). 1. Search for and select "Codespaces: Change Machine Type." ![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) @@ -98,14 +98,14 @@ You can change the machine type of your codespace at any time. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. -## Deleting a codespace in {% data variables.product.prodname_vscode %} +## Deleting a codespace in {% data variables.product.prodname_vscode_shortname %} {% data reusables.codespaces.click-remote-explorer-icon-vscode %} {% data reusables.codespaces.deleting-a-codespace-in-vscode %} -## Switching to the Insiders build of {% data variables.product.prodname_vscode %} +## Switching to the Insiders build of {% data variables.product.prodname_vscode_shortname %} -You can use the [Insiders Build of Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview#_insiders-nightly-build) within {% data variables.product.prodname_codespaces %}. +You can use the [Insiders Build of {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/setup/setup-overview#_insiders-nightly-build) within {% data variables.product.prodname_codespaces %}. 1. In bottom left of your {% data variables.product.prodname_codespaces %} window, select **{% octicon "gear" aria-label="The settings icon" %} Settings**. 2. From the list, select "Switch to Insiders Version". diff --git a/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md b/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md index 9840e7b32f49..f31e3747918b 100644 --- a/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md +++ b/content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md @@ -19,7 +19,7 @@ shortTitle: Source control You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. -Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode %} documentation "[Using Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." +Source control in {% data variables.product.prodname_github_codespaces %} uses the same workflow as {% data variables.product.prodname_vscode %}. For more information, see the {% data variables.product.prodname_vscode_shortname %} documentation "[Using Version Control in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/editor/versioncontrol#_git-support)." A typical workflow for updating a file using {% data variables.product.prodname_github_codespaces %} would be: diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index c1fdb92445bf..d92a29c13239 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -46,13 +46,13 @@ Since your repository is cloned onto the host VM before the container is created ### Step 3: Connecting to the codespace -When your container has been created and any other initialization has run, you'll be connected to your codespace. You can connect to it through the web or via [Visual Studio Code](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code), or both, if needed. +When your container has been created and any other initialization has run, you'll be connected to your codespace. You can connect to it through the web or via [{% data variables.product.prodname_vscode_shortname %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code), or both, if needed. ### Step 4: Post-creation setup Once you are connected to your codespace, your automated setup may continue to build based on the configuration you specified in your `devcontainer.json` file. You may see `postCreateCommand` and `postAttachCommand` run. -If you want to use Git hooks in your codespace, set up hooks using the [`devcontainer.json` lifecycle scripts](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts), such as `postCreateCommand`. For more information, see the [`devcontainer.json` reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_devcontainerjson-properties) in the Visual Studio Code documentation. +If you want to use Git hooks in your codespace, set up hooks using the [`devcontainer.json` lifecycle scripts](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts), such as `postCreateCommand`. For more information, see the [`devcontainer.json` reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_devcontainerjson-properties) in the {% data variables.product.prodname_vscode_shortname %} documentation. If you have a public dotfiles repository for {% data variables.product.prodname_codespaces %}, you can enable it for use with new codespaces. When enabled, your dotfiles will be cloned to the container and the install script will be invoked. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account#dotfiles)." @@ -67,12 +67,12 @@ As you develop in your codespace, it will save any changes to your files every f {% note %} -**Note:** Changes in a codespace in {% data variables.product.prodname_vscode %} are not saved automatically, unless you have enabled [Auto Save](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save). +**Note:** Changes in a codespace in {% data variables.product.prodname_vscode_shortname %} are not saved automatically, unless you have enabled [Auto Save](https://code.visualstudio.com/docs/editor/codebasics#_save-auto-save). {% endnote %} ### Closing or stopping your codespace -To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. +To stop your codespace you can [use the {% data variables.product.prodname_vs_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. When you close or stop your codespace, all uncommitted changes are preserved until you connect to the codespace again. @@ -93,7 +93,7 @@ Running your application when you first land in your codespace can make for a fa ## Committing and pushing your changes -Git is available by default in your codespace and so you can rely on your existing Git workflow. You can work with Git in your codespace either via the Terminal or by using [Visual Studio Code](https://code.visualstudio.com/docs/editor/versioncontrol)'s source control UI. For more information, see "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace)" +Git is available by default in your codespace and so you can rely on your existing Git workflow. You can work with Git in your codespace either via the Terminal or by using [{% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/editor/versioncontrol)'s source control UI. For more information, see "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace)" ![Running git status in Codespaces Terminal](/assets/images/help/codespaces/git-status.png) @@ -107,9 +107,9 @@ You can create a codespace from any branch, commit, or pull request in your proj ## Personalizing your codespace with extensions -Using {% data variables.product.prodname_vscode %} in your codespace gives you access to the {% data variables.product.prodname_vscode %} Marketplace so that you can add any extensions you need. For information on how extensions run in {% data variables.product.prodname_codespaces %}, see [Supporting Remote Development and GitHub Codespaces](https://code.visualstudio.com/api/advanced-topics/remote-extensions) in the {% data variables.product.prodname_vscode %} docs. +Using {% data variables.product.prodname_vscode_shortname %} in your codespace gives you access to the {% data variables.product.prodname_vs_marketplace %} so that you can add any extensions you need. For information on how extensions run in {% data variables.product.prodname_codespaces %}, see [Supporting Remote Development and GitHub Codespaces](https://code.visualstudio.com/api/advanced-topics/remote-extensions) in the {% data variables.product.prodname_vscode_shortname %} docs. -If you already use {% data variables.product.prodname_vscode %}, you can use [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to automatically sync extensions, settings, themes, and keyboard shortcuts between your local instance and any {% data variables.product.prodname_codespaces %} you create. +If you already use {% data variables.product.prodname_vscode_shortname %}, you can use [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to automatically sync extensions, settings, themes, and keyboard shortcuts between your local instance and any {% data variables.product.prodname_codespaces %} you create. ## Further reading diff --git a/content/codespaces/getting-started/quickstart.md b/content/codespaces/getting-started/quickstart.md index 1ad6fa9ba9c8..f6e95e42997f 100644 --- a/content/codespaces/getting-started/quickstart.md +++ b/content/codespaces/getting-started/quickstart.md @@ -76,7 +76,7 @@ Now that you've made a few changes, you can use the integrated terminal or the s ## Personalizing with an extension -Within a codespace, you have access to the Visual Studio Code Marketplace. For this example, you'll install an extension that alters the theme, but you can install any extension that is useful for your workflow. +Within a codespace, you have access to the {% data variables.product.prodname_vs_marketplace %}. For this example, you'll install an extension that alters the theme, but you can install any extension that is useful for your workflow. 1. In the left sidebar, click the Extensions icon. @@ -88,7 +88,7 @@ Within a codespace, you have access to the Visual Studio Code Marketplace. For t ![Select the fairyfloss theme](/assets/images/help/codespaces/fairyfloss.png) -4. Changes you make to your editor setup in the current codespace, such as theme and keyboard bindings, are synced automatically via [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to any other codespaces you open and any instances of Visual Studio Code that are signed into your GitHub account. +4. Changes you make to your editor setup in the current codespace, such as theme and keyboard bindings, are synced automatically via [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to any other codespaces you open and any instances of {% data variables.product.prodname_vscode %} that are signed into your GitHub account. ## Next Steps diff --git a/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md index 9c4ec49bcf46..cbdd7fea90e7 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization.md @@ -41,7 +41,7 @@ You can limit the choice of machine types that are available for repositories ow ## Deleting unused codespaces -Your users can delete their codespaces in https://github.com/codespaces and from within Visual Studio Code. To reduce the size of a codespace, users can manually delete files using the terminal or from within Visual Studio Code. +Your users can delete their codespaces in https://github.com/codespaces and from within {% data variables.product.prodname_vscode %}. To reduce the size of a codespace, users can manually delete files using the terminal or from within {% data variables.product.prodname_vscode_shortname %}. {% note %} diff --git a/content/codespaces/overview.md b/content/codespaces/overview.md index 9afe18e468d3..fc883510186b 100644 --- a/content/codespaces/overview.md +++ b/content/codespaces/overview.md @@ -34,7 +34,7 @@ To customize the runtimes and tools in your codespace, you can create a custom c If you don't do any custom configuration, {% data variables.product.prodname_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". -You can also personalize aspects of your codespace environment by using a public [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 VS Code extensions. For more information, see "[Customizing your codespace](/codespaces/customizing-your-codespace)". +You can also personalize aspects of your codespace environment by using a public [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 {% data variables.product.prodname_vscode_shortname %} extensions. For more information, see "[Customizing your codespace](/codespaces/customizing-your-codespace)". ## About billing for {% data variables.product.prodname_codespaces %} diff --git a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 32ed69a74248..6b8700298c5e 100644 --- a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -84,7 +84,7 @@ Prebuilds do not use any user-level secrets while building your environment, bec ## Configuring time-consuming tasks to be included in the prebuild -You can use the `onCreateCommand` and `updateContentCommand` commands in your `devcontainer.json` to include time-consuming processes as part of the prebuild template creation. For more information, see the Visual Studio Code documentation, "[devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts)." +You can use the `onCreateCommand` and `updateContentCommand` commands in your `devcontainer.json` to include time-consuming processes as part of the prebuild template creation. For more information, see the {% data variables.product.prodname_vscode %} documentation, "[devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts)." `onCreateCommand` is run only once, when the prebuild template is created, whereas `updateContentCommand` is run at template creation and at subsequent template updates. Incremental builds should be included in `updateContentCommand` since they represent the source of your project and need to be included for every prebuild template update. diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md index 6b18f995e01f..46a869736bfc 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md @@ -164,7 +164,7 @@ With your dev container added and a basic understanding of what everything does, "forwardPorts": [4000], ``` - For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the Visual Studio Code docs. + For more information on `devcontainer.json` properties, see the [devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) on the {% data variables.product.prodname_vscode_shortname %} docs. {% data reusables.codespaces.rebuild-command %} diff --git a/content/codespaces/the-githubdev-web-based-editor.md b/content/codespaces/the-githubdev-web-based-editor.md index 087e959b0ec5..b53bd042aa31 100644 --- a/content/codespaces/the-githubdev-web-based-editor.md +++ b/content/codespaces/the-githubdev-web-based-editor.md @@ -27,7 +27,7 @@ The {% data variables.product.prodname_serverless %} introduces a lightweight ed The {% data variables.product.prodname_serverless %} is available to everyone for free on {% data variables.product.prodname_dotcom_the_website %}. -The {% data variables.product.prodname_serverless %} provides many of the benefits of {% data variables.product.prodname_vscode %}, such as search, syntax highlighting, and a source control view. You can also use Settings Sync to share your own {% data variables.product.prodname_vscode %} settings with the editor. For more information, see "[Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync)" in the {% data variables.product.prodname_vscode %} documentation. +The {% data variables.product.prodname_serverless %} provides many of the benefits of {% data variables.product.prodname_vscode %}, such as search, syntax highlighting, and a source control view. You can also use Settings Sync to share your own {% data variables.product.prodname_vscode_shortname %} settings with the editor. For more information, see "[Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync)" in the {% data variables.product.prodname_vscode_shortname %} documentation. The {% data variables.product.prodname_serverless %} runs entirely in your browser’s sandbox. The editor doesn’t clone the repository, but instead uses the [GitHub Repositories extension](https://code.visualstudio.com/docs/editor/github#_github-repositories-extension) to carry out most of the functionality that you will use. Your work is saved in the browser’s local storage until you commit it. You should commit your changes regularly to ensure that they're always accessible. @@ -49,7 +49,7 @@ Both the {% data variables.product.prodname_serverless %} and {% data variables. | **Start up** | The {% data variables.product.prodname_serverless %} opens instantly with a key-press and you can start using it right away, without having to wait for additional configuration or installation. | When you create or resume a codespace, the codespace is assigned a VM and the container is configured based on the contents of a `devcontainer.json` file. This set up may take a few minutes to create the environment. For more information, see "[Creating a Codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." | | **Compute** | There is no associated compute, so you won’t be able to build and run your code or use the integrated terminal. | With {% data variables.product.prodname_codespaces %}, you get the power of dedicated VM on which you can run and debug your application.| | **Terminal access** | None. | {% data variables.product.prodname_codespaces %} provides a common set of tools by default, meaning that you can use the Terminal exactly as you would in your local environment.| -| **Extensions** | Only a subset of extensions that can run in the web will appear in the Extensions View and can be installed. For more information, see "[Using extensions](#using-extensions)."| With Codespaces, you can use most extensions from the Visual Studio Code Marketplace.| +| **Extensions** | Only a subset of extensions that can run in the web will appear in the Extensions View and can be installed. For more information, see "[Using extensions](#using-extensions)."| With Codespaces, you can use most extensions from the {% data variables.product.prodname_vs_marketplace %}.| ### Continue working on {% data variables.product.prodname_codespaces %} @@ -61,9 +61,9 @@ To continue your work in a codespace, click **Continue Working on…** and selec ## Using source control -When you use the {% data variables.product.prodname_serverless %}, all actions are managed through the Source Control View, which is located in the Activity Bar on the left hand side. For more information on the Source Control View, see "[Version Control](https://code.visualstudio.com/docs/editor/versioncontrol)" in the {% data variables.product.prodname_vscode %} documentation. +When you use the {% data variables.product.prodname_serverless %}, all actions are managed through the Source Control View, which is located in the Activity Bar on the left hand side. For more information on the Source Control View, see "[Version Control](https://code.visualstudio.com/docs/editor/versioncontrol)" in the {% data variables.product.prodname_vscode_shortname %} documentation. -Because the web-based editor uses the GitHub Repositories extension to power its functionality, you can switch branches without needing to stash changes. For more information, see "[GitHub Repositories](https://code.visualstudio.com/docs/editor/github#_github-repositories-extension)" in the {% data variables.product.prodname_vscode %} documentation. +Because the web-based editor uses the GitHub Repositories extension to power its functionality, you can switch branches without needing to stash changes. For more information, see "[GitHub Repositories](https://code.visualstudio.com/docs/editor/github#_github-repositories-extension)" in the {% data variables.product.prodname_vscode_shortname %} documentation. ### Create a new branch @@ -88,9 +88,9 @@ You can use the {% data variables.product.prodname_serverless %} to work with an ## Using extensions -The {% data variables.product.prodname_serverless %} supports {% data variables.product.prodname_vscode %} extensions that have been specifically created or updated to run in the web. These extensions are known as "web extensions". To learn how you can create a web extension or update your existing extension to work for the web, see "[Web extensions](https://code.visualstudio.com/api/extension-guides/web-extensions)" in the {% data variables.product.prodname_vscode %} documentation. +The {% data variables.product.prodname_serverless %} supports {% data variables.product.prodname_vscode_shortname %} extensions that have been specifically created or updated to run in the web. These extensions are known as "web extensions". To learn how you can create a web extension or update your existing extension to work for the web, see "[Web extensions](https://code.visualstudio.com/api/extension-guides/web-extensions)" in the {% data variables.product.prodname_vscode_shortname %} documentation. -Extensions that can run in the {% data variables.product.prodname_serverless %} will appear in the Extensions View and can be installed. If you use Settings Sync, any compatible extensions are also installed automatically. For information, see "[Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync)" in the {% data variables.product.prodname_vscode %} documentation. +Extensions that can run in the {% data variables.product.prodname_serverless %} will appear in the Extensions View and can be installed. If you use Settings Sync, any compatible extensions are also installed automatically. For information, see "[Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync)" in the {% data variables.product.prodname_vscode_shortname %} documentation. ## Troubleshooting @@ -104,5 +104,5 @@ If you have issues opening the {% data variables.product.prodname_serverless %}, ### Known limitations - The {% data variables.product.prodname_serverless %} is currently supported in Chrome (and various other Chromium-based browsers), Edge, Firefox, and Safari. We recommend that you use the latest versions of these browsers. -- Some keybindings may not work, depending on the browser you are using. These keybinding limitations are documented in the "[Known limitations and adaptations](https://code.visualstudio.com/docs/remote/codespaces#_known-limitations-and-adaptations)" section of the {% data variables.product.prodname_vscode %} documentation. +- Some keybindings may not work, depending on the browser you are using. These keybinding limitations are documented in the "[Known limitations and adaptations](https://code.visualstudio.com/docs/remote/codespaces#_known-limitations-and-adaptations)" section of the {% data variables.product.prodname_vscode_shortname %} documentation. - `.` may not work to open the {% data variables.product.prodname_serverless %} according to your local keyboard layout. In that case, you can open any {% data variables.product.prodname_dotcom %} repository in the {% data variables.product.prodname_serverless %} by changing the URL from `github.com` to `github.dev`. diff --git a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index 16a636982276..a712e885aa45 100644 --- a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -22,7 +22,7 @@ If multiple machine types are available when you create a codespace then a dialo ![The dialog box for choosing a machine type](/assets/images/help/codespaces/choose-custom-machine-type.png) -If you have your {% data variables.product.prodname_codespaces %} editor preference set to "Visual Studio Code for Web" then the "Setting up your codespace" page will show the message "Prebuilt codespace found" if a prebuild is being used. Similarly, if your editor preference is "Visual Studio Code" then the integrated terminal will contain the message "You are on a prebuilt codespace defined by the prebuild configuration for your repository" when you create a new codespace. For more information, see "[Setting your default editor for Codespaces](/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces)." +If you have your {% data variables.product.prodname_codespaces %} editor preference set to "{% data variables.product.prodname_vscode %} for Web" then the "Setting up your codespace" page will show the message "Prebuilt codespace found" if a prebuild is being used. Similarly, if your editor preference is "{% data variables.product.prodname_vscode %}" then the integrated terminal will contain the message "You are on a prebuilt codespace defined by the prebuild configuration for your repository" when you create a new codespace. For more information, see "[Setting your default editor for Codespaces](/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces)." After you have created a codespace you can check whether it was created from a prebuild by running the following {% data variables.product.prodname_cli %} command in the terminal: diff --git a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md index e1e297828682..eabce3420eba 100644 --- a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md +++ b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md @@ -16,7 +16,7 @@ shortTitle: Configure default editor - [Atom](https://atom.io/) - [MacVim](https://macvim-dev.github.io/macvim/) -- [Visual Studio Code](https://code.visualstudio.com/) +- [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) - [Visual Studio Codium](https://vscodium.com/) - [Sublime Text](https://www.sublimetext.com/) - [BBEdit](http://www.barebones.com/products/bbedit/) @@ -43,7 +43,7 @@ shortTitle: Configure default editor {% windows %} - [Atom](https://atom.io/) -- [Visual Studio Code](https://code.visualstudio.com/) +- [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) - [Visual Studio Codium](https://vscodium.com/) - [Sublime Text](https://www.sublimetext.com/) - [ColdFusion Builder](https://www.adobe.com/products/coldfusion-builder.html) diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md index 36db699c94ab..d8d138a7ae3c 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md @@ -1,38 +1,38 @@ --- title: About using Visual Studio Code with GitHub Classroom shortTitle: About using Visual Studio Code -intro: 'You can configure Visual Studio Code as the preferred editor for assignments in {% data variables.product.prodname_classroom %}.' +intro: 'You can configure {% data variables.product.prodname_vscode %} as the preferred editor for assignments in {% data variables.product.prodname_classroom %}.' versions: fpt: '*' redirect_from: - /education/manage-coursework-with-github-classroom/about-using-vs-code-with-github-classroom --- -## About Visual Studio Code +## About {% data variables.product.prodname_vscode %} -Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. With the [GitHub Classroom extension for Visual Studio Code](https://aka.ms/classroom-vscode-ext), students can easily browse, edit, submit, collaborate, and test their Classroom Assignments. For more information about IDEs and {% data variables.product.prodname_classroom %}, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." +{% data variables.product.prodname_vscode %} is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. With the [GitHub Classroom extension for {% data variables.product.prodname_vscode_shortname %}](https://aka.ms/classroom-vscode-ext), students can easily browse, edit, submit, collaborate, and test their Classroom Assignments. For more information about IDEs and {% data variables.product.prodname_classroom %}, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." ### Your student's editor of choice -The GitHub Classroom integration with Visual Studio Code provides students with an extension pack which contains: +The GitHub Classroom integration with {% data variables.product.prodname_vscode_shortname %} provides students with an extension pack which contains: 1. [GitHub Classroom Extension](https://aka.ms/classroom-vscode-ext) with custom abstractions that make it easy for students to navigate getting started. 2. [Visual Studio Live Share Extension](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack) integrating into a student view for easy access to teaching assistants and classmates for help and collaboration. 3. [GitHub Pull Request Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) allowing students to see feedback from their instructors within the editor. -### How to launch the assignment in Visual Studio Code -When creating an assignment, Visual Studio Code can be added as the preferred editor for an assignment. For more details, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." +### How to launch the assignment in {% data variables.product.prodname_vscode_shortname %} +When creating an assignment, {% data variables.product.prodname_vscode_shortname %} can be added as the preferred editor for an assignment. For more details, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." -This will include an "Open in Visual Studio Code" badge in all student repositories. This badge handles installing Visual Studio Code, the Classroom extension pack, and opening to the active assignment with one click. +This will include an "Open in {% data variables.product.prodname_vscode %}" badge in all student repositories. This badge handles installing {% data variables.product.prodname_vscode_shortname %}, the Classroom extension pack, and opening to the active assignment with one click. {% note %} -**Note:** The student must have Git installed on their computer to push code from Visual Studio Code to their repository. This is not automatically installed when clicking the **Open in Visual Studio Code** button. The student can download Git from [here](https://git-scm.com/downloads). +**Note:** The student must have Git installed on their computer to push code from {% data variables.product.prodname_vscode_shortname %} to their repository. This is not automatically installed when clicking the **Open in Visual Studio Code** button. The student can download Git from [here](https://git-scm.com/downloads). {% endnote %} ### How to use GitHub Classroom extension pack The GitHub Classroom extension has two major components: the 'Classrooms' view and the 'Active Assignment' view. -When the student launches the extension for the first time, they are automatically navigated to the Explorer tab in Visual Studio Code, where they can see the "Active Assignment" view alongside the tree-view of files in the repository. +When the student launches the extension for the first time, they are automatically navigated to the Explorer tab in {% data variables.product.prodname_vscode_shortname %}, where they can see the "Active Assignment" view alongside the tree-view of files in the repository. ![GitHub Classroom Active Assignment View](/assets/images/help/classroom/vs-code-active-assignment.png) diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md index 455c28008bad..2034b557335f 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md @@ -23,7 +23,7 @@ After a student accepts an assignment with an IDE, the README file in the studen | IDE | More information | | :- | :- | | Microsoft MakeCode Arcade | "[About using MakeCode Arcade with {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/about-using-makecode-arcade-with-github-classroom)" | -| Visual Studio Code | [{% data variables.product.prodname_classroom %} extension](http://aka.ms/classroom-vscode-ext) in the Visual Studio Marketplace | +| {% data variables.product.prodname_vscode %} | [{% data variables.product.prodname_classroom %} extension](http://aka.ms/classroom-vscode-ext) in the Visual Studio Marketplace | We know cloud IDE integrations are important to your classroom and are working to bring more options. diff --git a/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md b/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md index 324d48998a12..19f6ecfba30c 100644 --- a/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md +++ b/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md @@ -13,7 +13,7 @@ shortTitle: Extensions & integrations --- ## Editor tools -You can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and Visual Studio. +You can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and {% data variables.product.prodname_vs %}. ### {% data variables.product.product_name %} for Atom @@ -23,13 +23,13 @@ With the {% data variables.product.product_name %} for Atom extension, you can c With the {% data variables.product.product_name %} for Unity editor extension, you can develop on Unity, the open source game development platform, and see your work on {% data variables.product.product_name %}. For more information, see the official Unity editor extension [site](https://unity.github.com/) or the [documentation](https://github.com/github-for-unity/Unity/tree/master/docs). -### {% data variables.product.product_name %} for Visual Studio +### {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} -With the {% data variables.product.product_name %} for Visual Studio extension, you can work in {% data variables.product.product_name %} repositories without leaving Visual Studio. For more information, see the official Visual Studio extension [site](https://visualstudio.github.com/) or [documentation](https://github.com/github/VisualStudio/tree/master/docs). +With the {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} extension, you can work in {% data variables.product.product_name %} repositories without leaving {% data variables.product.prodname_vs %}. For more information, see the official {% data variables.product.prodname_vs %} extension [site](https://visualstudio.github.com/) or [documentation](https://github.com/github/VisualStudio/tree/master/docs). -### {% data variables.product.prodname_dotcom %} for Visual Studio Code +### {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} -With the {% data variables.product.prodname_dotcom %} for Visual Studio Code extension, you can review and manage {% data variables.product.product_name %} pull requests in Visual Studio Code. For more information, see the official Visual Studio Code extension [site](https://vscode.github.com/) or [documentation](https://github.com/Microsoft/vscode-pull-request-github). +With the {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} extension, you can review and manage {% data variables.product.product_name %} pull requests in {% data variables.product.prodname_vscode_shortname %}. For more information, see the official {% data variables.product.prodname_vscode_shortname %} extension [site](https://vscode.github.com/) or [documentation](https://github.com/Microsoft/vscode-pull-request-github). ## Project management tools diff --git a/content/get-started/getting-started-with-git/associating-text-editors-with-git.md b/content/get-started/getting-started-with-git/associating-text-editors-with-git.md index 5aa79a46c76a..d903687c9bd6 100644 --- a/content/get-started/getting-started-with-git/associating-text-editors-with-git.md +++ b/content/get-started/getting-started-with-git/associating-text-editors-with-git.md @@ -27,9 +27,9 @@ shortTitle: Associate text editors $ git config --global core.editor "atom --wait" ``` -## Using Visual Studio Code as your editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Install [Visual Studio Code](https://code.visualstudio.com/) (VS Code). For more information, see "[Setting up Visual Studio Code](https://code.visualstudio.com/Docs/setup/setup-overview)" in the VS Code documentation. +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} 3. Type this command: ```shell @@ -67,9 +67,9 @@ shortTitle: Associate text editors $ git config --global core.editor "atom --wait" ``` -## Using Visual Studio Code as your editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Install [Visual Studio Code](https://code.visualstudio.com/) (VS Code). For more information, see "[Setting up Visual Studio Code](https://code.visualstudio.com/Docs/setup/setup-overview)" in the VS Code documentation. +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} 3. Type this command: ```shell @@ -106,9 +106,9 @@ shortTitle: Associate text editors $ git config --global core.editor "atom --wait" ``` -## Using Visual Studio Code as your editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Install [Visual Studio Code](https://code.visualstudio.com/) (VS Code). For more information, see "[Setting up Visual Studio Code](https://code.visualstudio.com/Docs/setup/setup-overview)" in the VS Code documentation. +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} 3. Type this command: ```shell diff --git a/content/get-started/onboarding/getting-started-with-your-github-account.md b/content/get-started/onboarding/getting-started-with-your-github-account.md index 245a75c61f6c..639543752167 100644 --- a/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -75,7 +75,7 @@ For more information about how to authenticate to {% data variables.product.prod | ------------- | ------------- | ------------- | | Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | | {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | -| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | | Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | | {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} diff --git a/content/github/copilot/about-github-copilot-telemetry.md b/content/github/copilot/about-github-copilot-telemetry.md index 4b8db2affa67..9b9248a61081 100644 --- a/content/github/copilot/about-github-copilot-telemetry.md +++ b/content/github/copilot/about-github-copilot-telemetry.md @@ -9,7 +9,7 @@ versions: ## What data is collected -Data collected is described in the "[{% data variables.product.prodname_copilot %} Telemetry Terms](/github/copilot/github-copilot-telemetry-terms)." In addition, the {% data variables.product.prodname_copilot %} extension/plugin collects activity from the user's Integrated Development Environment (IDE), tied to a timestamp, and metadata collected by the extension/plugin telemetry package. When used with Visual Studio Code, IntelliJ, NeoVIM, or other IDEs, {% data variables.product.prodname_copilot %} collects the standard metadata provided by those IDEs. +Data collected is described in the "[{% data variables.product.prodname_copilot %} Telemetry Terms](/github/copilot/github-copilot-telemetry-terms)." In addition, the {% data variables.product.prodname_copilot %} extension/plugin collects activity from the user's Integrated Development Environment (IDE), tied to a timestamp, and metadata collected by the extension/plugin telemetry package. When used with {% data variables.product.prodname_vscode %}, IntelliJ, NeoVIM, or other IDEs, {% data variables.product.prodname_copilot %} collects the standard metadata provided by those IDEs. ## How the data is used by {% data variables.product.company_short %} diff --git a/content/site-policy/privacy-policies/github-codespaces-privacy-statement.md b/content/site-policy/privacy-policies/github-codespaces-privacy-statement.md index 5c84b46a70ee..1c0e2c9a1ed6 100644 --- a/content/site-policy/privacy-policies/github-codespaces-privacy-statement.md +++ b/content/site-policy/privacy-policies/github-codespaces-privacy-statement.md @@ -16,8 +16,8 @@ Use of GitHub Codespaces is subject to the [GitHub Privacy Statement](/github/si Activity on github.dev is subject to [GitHub's Beta Previews terms](/github/site-policy/github-terms-of-service#j-beta-previews) -## Using Visual Studio Code +## Using {% data variables.product.prodname_vscode %} -GitHub Codespaces and github.dev allow for use of Visual Studio Code in the web browser. When using Visual Studio Code in the web browser, some telemetry collection is enabled by default and is [explained in detail on the Visual Studio Code website](https://code.visualstudio.com/docs/getstarted/telemetry). Users can opt out of telemetry by going to File > Preferences > Settings under the top left menu. +GitHub Codespaces and github.dev allow for use of {% data variables.product.prodname_vscode %} in the web browser. When using {% data variables.product.prodname_vscode_shortname %} in the web browser, some telemetry collection is enabled by default and is [explained in detail on the {% data variables.product.prodname_vscode_shortname %} website](https://code.visualstudio.com/docs/getstarted/telemetry). Users can opt out of telemetry by going to File > Preferences > Settings under the top left menu. -If a user chooses to opt out of telemetry capture in Visual Studio Code while inside of a codespace as outlined, this will sync the disable telemetry preference across all future web sessions in GitHub Codespaces and github.dev. +If a user chooses to opt out of telemetry capture in {% data variables.product.prodname_vscode_shortname %} while inside of a codespace as outlined, this will sync the disable telemetry preference across all future web sessions in GitHub Codespaces and github.dev. diff --git a/data/reusables/codespaces/click-remote-explorer-icon-vscode.md b/data/reusables/codespaces/click-remote-explorer-icon-vscode.md index 874a9f57b085..83bf494e4d3d 100644 --- a/data/reusables/codespaces/click-remote-explorer-icon-vscode.md +++ b/data/reusables/codespaces/click-remote-explorer-icon-vscode.md @@ -1,2 +1,2 @@ -1. In {% data variables.product.prodname_vscode %}, in the left sidebar, click the Remote Explorer icon. +1. In {% data variables.product.prodname_vscode_shortname %}, in the left sidebar, click the Remote Explorer icon. ![The Remote Explorer icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png) diff --git a/data/variables/product.yml b/data/variables/product.yml index 52b900e77f61..2e0164534ac9 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -178,10 +178,14 @@ prodname_codeql_workflow: 'CodeQL analysis workflow' # Visual Studio prodname_vs: 'Visual Studio' +prodname_vscode_shortname: 'VS Code' prodname_vscode: 'Visual Studio Code' prodname_vss_ghe: 'Visual Studio subscriptions with GitHub Enterprise' prodname_vss_admin_portal_with_url: 'the [administrator portal for Visual Studio subscriptions](https://visualstudio.microsoft.com/subscriptions-administration/)' -prodname_vscode_command_palette: 'VS Code Command Palette' +prodname_vs_command_palette_shortname: 'VS Code Command Palette' +prodname_vs_command_palette: 'Visual Studio Code Command Palette' +prodname_vs_marketplace: 'Visual Studio Code Marketplace' +prodname_vs_marketplace_shortname: 'VS Code Marketplace' # GitHub Dependabot prodname_dependabot: 'Dependabot' From d6670a518f88af69dc070b3bd7e43b640ff2e449 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 21 Apr 2022 11:04:55 +0200 Subject: [PATCH 2/6] Fix old variable name --- .../developing-in-codespaces/developing-in-a-codespace.md | 4 ++-- .../introduction-to-dev-containers.md | 2 +- content/codespaces/troubleshooting/codespaces-logs.md | 2 +- .../troubleshooting-creation-and-deletion-of-codespaces.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index a985c3a36ced..b44ac1335fda 100644 --- a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -52,9 +52,9 @@ For more information on using {% data variables.product.prodname_vscode %}, see {% data reusables.codespaces.committing-link-to-procedure %} -### Using the {% data variables.product.prodname_vscode_command_palette %} +### Using the {% data variables.product.prodname_vs_command_palette %} -The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the {% data variables.product.prodname_vscode_command_palette %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." +The {% data variables.product.prodname_vs_command_palette_shortname %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the {% data variables.product.prodname_vs_command_palette_shortname %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." ## Navigating to an existing codespace diff --git a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 9e67787fd84b..eca0cfed6fcb 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -140,7 +140,7 @@ You can add a predefined dev container configuration either while working in a c 1. If you are working in a codespace, apply your changes, by clicking **Rebuild now** in the message at the bottom right of the window. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." - !["Codespaces: Rebuild Container" in the {% data variables.product.prodname_vscode_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) + !["Codespaces: Rebuild Container" in the {% data variables.product.prodname_vs_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) ### Adding additional features to your `devcontainer.json` file diff --git a/content/codespaces/troubleshooting/codespaces-logs.md b/content/codespaces/troubleshooting/codespaces-logs.md index 7c223f33bd2f..e068955df06b 100644 --- a/content/codespaces/troubleshooting/codespaces-logs.md +++ b/content/codespaces/troubleshooting/codespaces-logs.md @@ -53,7 +53,7 @@ These logs contain information about the container, dev container, and their con {% webui %} 1. Connect to the codespace you want to debug. -2. Open the {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. +2. Open the {% data variables.product.prodname_vs_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. diff --git a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index 14a353a74bc4..7c61b8adb15d 100644 --- a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -56,4 +56,4 @@ Some more destructive options: This codespace is currently running in recovery mode due to a container error. ``` -Review the creation logs, update the dev container configuration as needed, and run **Codespaces: Rebuild Container** in the {% data variables.product.prodname_vscode_command_palette %} to retry. For more information, see " [Codespaces logs](/codespaces/troubleshooting/codespaces-logs)" and "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." +Review the creation logs, update the dev container configuration as needed, and run **Codespaces: Rebuild Container** in the {% data variables.product.prodname_vs_command_palette %} to retry. For more information, see " [Codespaces logs](/codespaces/troubleshooting/codespaces-logs)" and "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." From 2eadd6769b0a69a192c1edd044d531628eb8c84f Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 21 Apr 2022 11:15:33 +0200 Subject: [PATCH 3/6] Fix test --- .../using-the-vs-code-command-palette-in-codespaces.md | 4 ++-- .../developing-in-codespaces/developing-in-a-codespace.md | 4 ++-- content/codespaces/getting-started/deep-dive.md | 2 +- .../introduction-to-dev-containers.md | 2 +- content/codespaces/troubleshooting/codespaces-logs.md | 2 +- .../troubleshooting-creation-and-deletion-of-codespaces.md | 2 +- data/variables/product.yml | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md index 657e1144b73a..df3acce4e1c7 100644 --- a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md +++ b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md @@ -15,9 +15,9 @@ redirect_from: - /codespaces/codespaces-reference/using-the-command-palette-in-codespaces --- -## About the {% data variables.product.prodname_vs_command_palette %} +## About the {% data variables.product.prodname_vscode_command_palette %} -The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in Codespaces. The {% data variables.product.prodname_vs_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vs_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. +The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in Codespaces. The {% data variables.product.prodname_vscode_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vs_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. ## Accessing the {% data variables.product.prodname_vs_command_palette_shortname %} diff --git a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index b44ac1335fda..ebb783043f30 100644 --- a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -52,9 +52,9 @@ For more information on using {% data variables.product.prodname_vscode %}, see {% data reusables.codespaces.committing-link-to-procedure %} -### Using the {% data variables.product.prodname_vs_command_palette %} +### Using the {% data variables.product.prodname_vscode_command_palette %} -The {% data variables.product.prodname_vs_command_palette_shortname %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the {% data variables.product.prodname_vs_command_palette_shortname %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." +The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the {% data variables.product.prodname_vs_command_palette_shortname %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." ## Navigating to an existing codespace diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index 64d494b7f233..68fb665a9b58 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -72,7 +72,7 @@ As you develop in your codespace, it will save any changes to your files every f ### Closing or stopping your codespace -To stop your codespace you can [use the {% data variables.product.prodname_vs_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. +To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. When you close or stop your codespace, all uncommitted changes are preserved until you connect to the codespace again. diff --git a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index eca0cfed6fcb..9e67787fd84b 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -140,7 +140,7 @@ You can add a predefined dev container configuration either while working in a c 1. If you are working in a codespace, apply your changes, by clicking **Rebuild now** in the message at the bottom right of the window. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-changes-to-your-configuration)." - !["Codespaces: Rebuild Container" in the {% data variables.product.prodname_vs_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) + !["Codespaces: Rebuild Container" in the {% data variables.product.prodname_vscode_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) ### Adding additional features to your `devcontainer.json` file diff --git a/content/codespaces/troubleshooting/codespaces-logs.md b/content/codespaces/troubleshooting/codespaces-logs.md index e068955df06b..7c223f33bd2f 100644 --- a/content/codespaces/troubleshooting/codespaces-logs.md +++ b/content/codespaces/troubleshooting/codespaces-logs.md @@ -53,7 +53,7 @@ These logs contain information about the container, dev container, and their con {% webui %} 1. Connect to the codespace you want to debug. -2. Open the {% data variables.product.prodname_vs_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. +2. Open the {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. diff --git a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index 7c61b8adb15d..14a353a74bc4 100644 --- a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -56,4 +56,4 @@ Some more destructive options: This codespace is currently running in recovery mode due to a container error. ``` -Review the creation logs, update the dev container configuration as needed, and run **Codespaces: Rebuild Container** in the {% data variables.product.prodname_vs_command_palette %} to retry. For more information, see " [Codespaces logs](/codespaces/troubleshooting/codespaces-logs)" and "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." +Review the creation logs, update the dev container configuration as needed, and run **Codespaces: Rebuild Container** in the {% data variables.product.prodname_vscode_command_palette %} to retry. For more information, see " [Codespaces logs](/codespaces/troubleshooting/codespaces-logs)" and "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)." diff --git a/data/variables/product.yml b/data/variables/product.yml index 2e0164534ac9..9e807cb46eb9 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -183,7 +183,7 @@ prodname_vscode: 'Visual Studio Code' prodname_vss_ghe: 'Visual Studio subscriptions with GitHub Enterprise' prodname_vss_admin_portal_with_url: 'the [administrator portal for Visual Studio subscriptions](https://visualstudio.microsoft.com/subscriptions-administration/)' prodname_vs_command_palette_shortname: 'VS Code Command Palette' -prodname_vs_command_palette: 'Visual Studio Code Command Palette' +prodname_vscode_command_palette: 'Visual Studio Code Command Palette' prodname_vs_marketplace: 'Visual Studio Code Marketplace' prodname_vs_marketplace_shortname: 'VS Code Marketplace' From 0cf9a1a9b7379c182e49fe6483d22ac8333ec4a6 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 21 Apr 2022 15:15:00 +0200 Subject: [PATCH 4/6] Fixing more mentions of Visual Studio Code --- .../developing-in-codespaces/developing-in-a-codespace.md | 4 ++-- data/reusables/codespaces/committing-link-to-procedure.md | 2 +- data/reusables/codespaces/connect-to-codespace-from-vscode.md | 2 +- data/reusables/codespaces/creating-a-codespace-in-vscode.md | 4 ++-- data/reusables/codespaces/deleting-a-codespace-in-vscode.md | 2 +- data/reusables/codespaces/use-visual-studio-features.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index ebb783043f30..3bbdf7ee192b 100644 --- a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -33,7 +33,7 @@ shortTitle: Develop in a codespace 4. Panels - This is where you can see output and debug information, as well as the default place for the integrated Terminal. 5. Status Bar - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. -For more information on using {% data variables.product.prodname_vscode %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode %} documentation. +For more information on using {% data variables.product.prodname_vscode_shortname %}, see the [User Interface guide](https://code.visualstudio.com/docs/getstarted/userinterface) in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.codespaces.connect-to-codespace-from-vscode %} @@ -54,7 +54,7 @@ For more information on using {% data variables.product.prodname_vscode %}, see ### Using the {% data variables.product.prodname_vscode_command_palette %} -The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the {% data variables.product.prodname_vs_command_palette_shortname %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." +The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Using the {% data variables.product.prodname_vs_command_palette_shortname %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." ## Navigating to an existing codespace diff --git a/data/reusables/codespaces/committing-link-to-procedure.md b/data/reusables/codespaces/committing-link-to-procedure.md index 0bf78b2fe50d..ebbdafc05428 100644 --- a/data/reusables/codespaces/committing-link-to-procedure.md +++ b/data/reusables/codespaces/committing-link-to-procedure.md @@ -1,3 +1,3 @@ -Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit your changes. Committing changes to your repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, such as adding {% data variables.product.prodname_vscode %} extensions, will appear for all users. +Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit your changes. Committing changes to your repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, such as adding {% data variables.product.prodname_vscode_shortname %} extensions, will appear for all users. For information, see "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#committing-your-changes)." diff --git a/data/reusables/codespaces/connect-to-codespace-from-vscode.md b/data/reusables/codespaces/connect-to-codespace-from-vscode.md index 045387a57b31..9ab86b13a424 100644 --- a/data/reusables/codespaces/connect-to-codespace-from-vscode.md +++ b/data/reusables/codespaces/connect-to-codespace-from-vscode.md @@ -1 +1 @@ -You can connect to your codespace directly from {% data variables.product.prodname_vscode %}. For more information, see "[Using Codespaces in {% data variables.product.prodname_vscode %}](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)." +You can connect to your codespace directly from {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Using Codespaces in {% data variables.product.prodname_vscode_shortname %}](/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)." diff --git a/data/reusables/codespaces/creating-a-codespace-in-vscode.md b/data/reusables/codespaces/creating-a-codespace-in-vscode.md index 96eb32c4489e..bdb7adec1c6d 100644 --- a/data/reusables/codespaces/creating-a-codespace-in-vscode.md +++ b/data/reusables/codespaces/creating-a-codespace-in-vscode.md @@ -1,8 +1,8 @@ -After you connect your account on {% data variables.product.product_location %} to the {% data variables.product.prodname_github_codespaces %} extension, you can create a new codespace. For more information about the {% data variables.product.prodname_github_codespaces %} extension, see the [{% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). +After you connect your account on {% data variables.product.product_location %} to the {% data variables.product.prodname_github_codespaces %} extension, you can create a new codespace. For more information about the {% data variables.product.prodname_github_codespaces %} extension, see the [{% data variables.product.prodname_vs_marketplace_shortname %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). {% note %} -**Note**: Currently, {% data variables.product.prodname_vscode %} doesn't allow you to choose a dev container configuration when you create a codespace. If you want to choose a specific dev container configuration, use the {% data variables.product.prodname_dotcom %} web interface to create your codespace. For more information, click the **Web browser** tab at the top of this page. +**Note**: Currently, {% data variables.product.prodname_vscode_shortname %} doesn't allow you to choose a dev container configuration when you create a codespace. If you want to choose a specific dev container configuration, use the {% data variables.product.prodname_dotcom %} web interface to create your codespace. For more information, click the **Web browser** tab at the top of this page. {% endnote %} diff --git a/data/reusables/codespaces/deleting-a-codespace-in-vscode.md b/data/reusables/codespaces/deleting-a-codespace-in-vscode.md index ff8bb8110f95..67183c4ef21f 100644 --- a/data/reusables/codespaces/deleting-a-codespace-in-vscode.md +++ b/data/reusables/codespaces/deleting-a-codespace-in-vscode.md @@ -1,4 +1,4 @@ -You can delete codespaces from within {% data variables.product.prodname_vscode %} when you are not currently working in a codespace. +You can delete codespaces from within {% data variables.product.prodname_vscode_shortname %} when you are not currently working in a codespace. {% data reusables.codespaces.click-remote-explorer-icon-vscode %} 1. Under "GITHUB CODESPACES", right-click the codespace you want to delete. diff --git a/data/reusables/codespaces/use-visual-studio-features.md b/data/reusables/codespaces/use-visual-studio-features.md index a5b1cf915191..4cabe97da46e 100644 --- a/data/reusables/codespaces/use-visual-studio-features.md +++ b/data/reusables/codespaces/use-visual-studio-features.md @@ -1 +1 @@ -You can edit code, debug, and use Git commands while developing in a codespace with {% data variables.product.prodname_vscode %}. For more information, see the [{% data variables.product.prodname_vscode %} documentation](https://code.visualstudio.com/docs). +You can edit code, debug, and use Git commands while developing in a codespace with {% data variables.product.prodname_vscode_shortname %}. For more information, see the [{% data variables.product.prodname_vscode_shortname %} documentation](https://code.visualstudio.com/docs). From 7ea42fcb38f1b1aa96c0c27188aec0f6602cfffb Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 21 Apr 2022 16:09:03 +0200 Subject: [PATCH 5/6] Fixed more mentions of Visual Studio Code --- ...managing-repository-access-for-your-codespaces.md | 2 +- .../introduction-to-dev-containers.md | 12 ++++++------ .../troubleshooting/troubleshooting-prebuilds.md | 4 ++-- ...using-visual-studio-code-with-github-classroom.md | 4 ++-- data/reusables/codespaces/more-info-devcontainer.md | 2 +- data/reusables/codespaces/vscode-settings-order.md | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index b6b604c5b441..a39731b49faa 100644 --- a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -25,7 +25,7 @@ When permissions are listed in the `devcontainer.json` file, you will be prompte To create codespaces with custom permissions defined, you must use one of the following: * The {% data variables.product.prodname_dotcom %} web UI * [{% data variables.product.prodname_dotcom %} CLI](https://github.com/cli/cli/releases/latest) 2.5.2 or later -* [{% data variables.product.prodname_github_codespaces %} Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 1.5.3 or later +* [{% data variables.product.prodname_github_codespaces %} {% data variables.product.prodname_vscode %} extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 1.5.3 or later ## Setting additional repository permissions diff --git a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 9e67787fd84b..5c362ad805dd 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -110,7 +110,7 @@ To use a Dockerfile as part of a dev container configuration, reference it in yo } ``` -For more information about using a Dockerfile in a dev container configuration, see the {% data variables.product.prodname_vscode %} documentation "[Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile)." +For more information about using a Dockerfile in a dev container configuration, see the {% data variables.product.prodname_vscode_shortname %} documentation "[Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile)." ## Using the default dev container configuration @@ -122,7 +122,7 @@ The default configuration is a good option if you're working on a small project ## Using a predefined dev container configuration -You can choose from a list of predefined configurations to create a dev container configuration for your repository. These configurations provide common setups for particular project types, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. +You can choose from a list of predefined configurations to create a dev container configuration for your repository. These configurations provide common setups for particular project types, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode_shortname %} settings, and {% data variables.product.prodname_vscode_shortname %} extensions that should be installed. 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. @@ -192,9 +192,9 @@ If `.devcontainer/devcontainer.json` or `.devcontainer.json` exists, it will be ### Editing the devcontainer.json file -You can add and edit the supported configuration keys in the `devcontainer.json` file to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. {% data reusables.codespaces.more-info-devcontainer %} +You can add and edit the supported configuration keys in the `devcontainer.json` file to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode_shortname %} extensions will be installed. {% data reusables.codespaces.more-info-devcontainer %} -The `devcontainer.json` file is written using the JSONC format. This allows you to include comments within the configuration file. For more information, see "[Editing JSON with Visual Studio Code](https://code.visualstudio.com/docs/languages/json#_json-with-comments)" in the {% data variables.product.prodname_vscode %} documentation. +The `devcontainer.json` file is written using the JSONC format. This allows you to include comments within the configuration file. For more information, see "[Editing JSON with {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/languages/json#_json-with-comments)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% note %} @@ -202,11 +202,11 @@ The `devcontainer.json` file is written using the JSONC format. This allows you {% endnote %} -### Editor settings for Visual Studio Code +### Editor settings for {% data variables.product.prodname_vscode_shortname %} {% data reusables.codespaces.vscode-settings-order %} -You can define default editor settings for {% data variables.product.prodname_vscode %} in two places. +You can define default editor settings for {% data variables.product.prodname_vscode_shortname %} in two places. * Editor settings defined in the `.vscode/settings.json` file in your repository are applied as _Workspace_-scoped settings in the codespace. * Editor settings defined in the `settings` key in the `devcontainer.json` file are applied as _Remote [Codespaces]_-scoped settings in the codespace. diff --git a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index 4d5a81e4a11d..349ffdbf30e6 100644 --- a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -22,11 +22,11 @@ When you create a codespace, you can choose the type of the virtual machine you ![A list of available machine types](/assets/images/help/codespaces/choose-custom-machine-type.png) -If you have your {% data variables.product.prodname_codespaces %} editor preference set to "Visual Studio Code for Web" then the "Setting up your codespace" page will show the message "Prebuilt codespace found" if a prebuild is being used. +If you have your {% data variables.product.prodname_codespaces %} editor preference set to "{% data variables.product.prodname_vscode %} for Web" then the "Setting up your codespace" page will show the message "Prebuilt codespace found" if a prebuild is being used. ![The 'prebuilt codespace found' message](/assets/images/help/codespaces/prebuilt-codespace-found.png) -Similarly, if your editor preference is "Visual Studio Code" then the integrated terminal will contain the message "You are on a prebuilt codespace defined by the prebuild configuration for your repository" when you create a new codespace. For more information, see "[Setting your default editor for Codespaces](/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces)." +Similarly, if your editor preference is "{% data variables.product.prodname_vscode_shortname %}" then the integrated terminal will contain the message "You are on a prebuilt codespace defined by the prebuild configuration for your repository" when you create a new codespace. For more information, see "[Setting your default editor for Codespaces](/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces)." After you have created a codespace you can check whether it was created from a prebuild by running the following {% data variables.product.prodname_cli %} command in the terminal: diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md index d8d138a7ae3c..8a9e3f877f37 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md @@ -21,11 +21,11 @@ The GitHub Classroom integration with {% data variables.product.prodname_vscode_ ### How to launch the assignment in {% data variables.product.prodname_vscode_shortname %} When creating an assignment, {% data variables.product.prodname_vscode_shortname %} can be added as the preferred editor for an assignment. For more details, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide)." -This will include an "Open in {% data variables.product.prodname_vscode %}" badge in all student repositories. This badge handles installing {% data variables.product.prodname_vscode_shortname %}, the Classroom extension pack, and opening to the active assignment with one click. +This will include an "Open in {% data variables.product.prodname_vscode_shortname %}" badge in all student repositories. This badge handles installing {% data variables.product.prodname_vscode_shortname %}, the Classroom extension pack, and opening to the active assignment with one click. {% note %} -**Note:** The student must have Git installed on their computer to push code from {% data variables.product.prodname_vscode_shortname %} to their repository. This is not automatically installed when clicking the **Open in Visual Studio Code** button. The student can download Git from [here](https://git-scm.com/downloads). +**Note:** The student must have Git installed on their computer to push code from {% data variables.product.prodname_vscode_shortname %} to their repository. This is not automatically installed when clicking the **Open in {% data variables.product.prodname_vscode_shortname %}** button. The student can download Git from [here](https://git-scm.com/downloads). {% endnote %} diff --git a/data/reusables/codespaces/more-info-devcontainer.md b/data/reusables/codespaces/more-info-devcontainer.md index 430a9f1156d1..f0fd5c863b78 100644 --- a/data/reusables/codespaces/more-info-devcontainer.md +++ b/data/reusables/codespaces/more-info-devcontainer.md @@ -1 +1 @@ -For information about the settings and properties that you can set in a `devcontainer.json` file, see "[devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json)" in the {% data variables.product.prodname_vscode %} documentation. \ No newline at end of file +For information about the settings and properties that you can set in a `devcontainer.json` file, see "[devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json)" in the {% data variables.product.prodname_vscode_shortname %} documentation. \ No newline at end of file diff --git a/data/reusables/codespaces/vscode-settings-order.md b/data/reusables/codespaces/vscode-settings-order.md index fc4b8401298c..27e09a3975ca 100644 --- a/data/reusables/codespaces/vscode-settings-order.md +++ b/data/reusables/codespaces/vscode-settings-order.md @@ -1 +1 @@ -When you configure editor settings for {% data variables.product.prodname_vscode %}, there are three scopes available: _Workspace_, _Remote [Codespaces]_, and _User_. If a setting is defined in multiple scopes, _Workspace_ settings take priority, then _Remote [Codespaces]_, then _User_. +When you configure editor settings for {% data variables.product.prodname_vscode_shortname %}, there are three scopes available: _Workspace_, _Remote [Codespaces]_, and _User_. If a setting is defined in multiple scopes, _Workspace_ settings take priority, then _Remote [Codespaces]_, then _User_. From 795da27af0c42da7a954b4d288bcf9b2fabedac4 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 28 Apr 2022 08:51:47 +0200 Subject: [PATCH 6/6] Incorporated feedback --- .../using-github-copilot-in-codespaces.md | 2 +- ...he-vs-code-command-palette-in-codespaces.md | 18 +++++++++--------- .../developing-in-a-codespace.md | 2 +- .../using-codespaces-in-visual-studio-code.md | 2 +- .../codespaces/getting-started/deep-dive.md | 2 +- .../codespaces/getting-started/quickstart.md | 2 +- .../the-githubdev-web-based-editor.md | 2 +- data/variables/product.yml | 4 ++-- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md b/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md index 387e98129b20..a6a0a614dfdb 100644 --- a/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md +++ b/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md @@ -17,7 +17,7 @@ redirect_from: ## Using {% data variables.product.prodname_copilot %} -[{% data variables.product.prodname_copilot %}](https://copilot.github.com/), an AI pair programmer, can be used in any codespace. To start using {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_codespaces %}, install the [{% data variables.product.prodname_copilot_short %} extension from the {% data variables.product.prodname_vs_marketplace %}](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). +[{% data variables.product.prodname_copilot %}](https://copilot.github.com/), an AI pair programmer, can be used in any codespace. To start using {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_codespaces %}, install the [{% data variables.product.prodname_copilot_short %} extension from the {% data variables.product.prodname_vscode_marketplace %}](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). To include {% data variables.product.prodname_copilot_short %}, or other extensions, in all of your codespaces, enable Settings Sync. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)." Additionally, to include {% data variables.product.prodname_copilot_short %} in a given project for all users, you can specify `GitHub.copilot` as an extension in your `devcontainer.json` file. For information about configuring a `devcontainer.json` file, see "[Introduction to dev containers](/codespaces/customizing-your-codespace/configuring-codespaces-for-your-project#creating-a-custom-dev-container-configuration)." diff --git a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md index df3acce4e1c7..acb0cad204c8 100644 --- a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md +++ b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md @@ -17,11 +17,11 @@ redirect_from: ## About the {% data variables.product.prodname_vscode_command_palette %} -The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in Codespaces. The {% data variables.product.prodname_vscode_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vs_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. +The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in Codespaces. The {% data variables.product.prodname_vscode_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vscode_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. -## Accessing the {% data variables.product.prodname_vs_command_palette_shortname %} +## Accessing the {% data variables.product.prodname_vscode_command_palette_shortname %} -You can access the {% data variables.product.prodname_vs_command_palette_shortname %} in a number of ways. +You can access the {% data variables.product.prodname_vscode_command_palette_shortname %} in a number of ways. - Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). @@ -33,7 +33,7 @@ You can access the {% data variables.product.prodname_vs_command_palette_shortna ## Commands for {% data variables.product.prodname_github_codespaces %} -To see all commands related to {% data variables.product.prodname_github_codespaces %}, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "Codespaces". +To see all commands related to {% data variables.product.prodname_github_codespaces %}, [access the {% data variables.product.prodname_vscode_command_palette_shortname %}](#accessing-the-command-palette), then start typing "Codespaces". ![A list of all commands that relate to Codespaces](/assets/images/help/codespaces/codespaces-command-palette.png) @@ -41,13 +41,13 @@ To see all commands related to {% data variables.product.prodname_github_codespa If you add a new secret or change the machine type, you'll have to stop and restart the codespace for it to apply your changes. -To suspend or stop your codespace's container, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "stop". Select **Codespaces: Stop Current Codespace**. +To suspend or stop your codespace's container, [access the {% data variables.product.prodname_vscode_command_palette_shortname %}](#accessing-the-command-palette), then start typing "stop". Select **Codespaces: Stop Current Codespace**. ![Command to stop a codespace](/assets/images/help/codespaces/codespaces-stop.png) ### Adding a dev container from a template -To add a dev container from a template, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...** +To add a dev container from a template, [access the {% data variables.product.prodname_vscode_command_palette_shortname %}](#accessing-the-command-palette), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...** ![Command to add a dev container](/assets/images/help/codespaces/add-prebuilt-container-command.png) @@ -55,14 +55,14 @@ To add a dev container from a template, [access the {% data variables.product.pr If you add a dev container or edit any of the configuration files (`devcontainer.json` and `Dockerfile`), you'll have to rebuild your codespace for it to apply your changes. -To rebuild your container, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "rebuild". Select **Codespaces: Rebuild Container**. +To rebuild your container, [access the {% data variables.product.prodname_vscode_command_palette_shortname %}](#accessing-the-command-palette), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Command to rebuild a codespace](/assets/images/help/codespaces/codespaces-rebuild.png) ### Codespaces logs -You can use the {% data variables.product.prodname_vs_command_palette_shortname %} to access the codespace creation logs, or you can use it export all logs. +You can use the {% data variables.product.prodname_vscode_command_palette_shortname %} to access the codespace creation logs, or you can use it export all logs. -To retrieve the logs for Codespaces, [access the {% data variables.product.prodname_vs_command_palette_shortname %}](#accessing-the-command-palette), then start typing "log". Select **Codespaces: Export Logs** to export all logs related to Codespaces or select **Codespaces: View Creation Logs** to view logs related to the setup. +To retrieve the logs for Codespaces, [access the {% data variables.product.prodname_vscode_command_palette_shortname %}](#accessing-the-command-palette), then start typing "log". Select **Codespaces: Export Logs** to export all logs related to Codespaces or select **Codespaces: View Creation Logs** to view logs related to the setup. ![Command to access logs](/assets/images/help/codespaces/codespaces-logs.png) diff --git a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index 3bbdf7ee192b..ff505fbe49e3 100644 --- a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -54,7 +54,7 @@ For more information on using {% data variables.product.prodname_vscode_shortnam ### Using the {% data variables.product.prodname_vscode_command_palette %} -The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Using the {% data variables.product.prodname_vs_command_palette_shortname %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." +The {% data variables.product.prodname_vscode_command_palette %} allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Using the {% data variables.product.prodname_vscode_command_palette_shortname %} in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces)." ## Navigating to an existing codespace diff --git a/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md index 517b50cc62b1..3b81563de2dd 100644 --- a/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ b/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md @@ -30,7 +30,7 @@ If you prefer to work in the browser, but want to continue using your existing { To develop in a codespace directly in {% data variables.product.prodname_vscode_shortname %}, you must install and sign into the {% data variables.product.prodname_github_codespaces %} extension with your {% data variables.product.product_name %} credentials. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode_shortname %} October 2020 Release 1.51 or later. -Use the {% data variables.product.prodname_vs_marketplace %} to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode_shortname %} documentation. +Use the {% data variables.product.prodname_vscode_marketplace %} to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode_shortname %} documentation. {% mac %} diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index 68fb665a9b58..47f78fb94786 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -107,7 +107,7 @@ You can create a codespace from any branch, commit, or pull request in your proj ## Personalizing your codespace with extensions -Using {% data variables.product.prodname_vscode_shortname %} in your codespace gives you access to the {% data variables.product.prodname_vs_marketplace %} so that you can add any extensions you need. For information on how extensions run in {% data variables.product.prodname_codespaces %}, see [Supporting Remote Development and GitHub Codespaces](https://code.visualstudio.com/api/advanced-topics/remote-extensions) in the {% data variables.product.prodname_vscode_shortname %} docs. +Using {% data variables.product.prodname_vscode_shortname %} in your codespace gives you access to the {% data variables.product.prodname_vscode_marketplace %} so that you can add any extensions you need. For information on how extensions run in {% data variables.product.prodname_codespaces %}, see [Supporting Remote Development and GitHub Codespaces](https://code.visualstudio.com/api/advanced-topics/remote-extensions) in the {% data variables.product.prodname_vscode_shortname %} docs. If you already use {% data variables.product.prodname_vscode_shortname %}, you can use [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to automatically sync extensions, settings, themes, and keyboard shortcuts between your local instance and any {% data variables.product.prodname_codespaces %} you create. diff --git a/content/codespaces/getting-started/quickstart.md b/content/codespaces/getting-started/quickstart.md index 5085351b1b9b..9374cd01565c 100644 --- a/content/codespaces/getting-started/quickstart.md +++ b/content/codespaces/getting-started/quickstart.md @@ -76,7 +76,7 @@ Now that you've made a few changes, you can use the integrated terminal or the s ## Personalizing with an extension -Within a codespace, you have access to the {% data variables.product.prodname_vs_marketplace %}. For this example, you'll install an extension that alters the theme, but you can install any extension that is useful for your workflow. +Within a codespace, you have access to the {% data variables.product.prodname_vscode_marketplace %}. For this example, you'll install an extension that alters the theme, but you can install any extension that is useful for your workflow. 1. In the left sidebar, click the Extensions icon. diff --git a/content/codespaces/the-githubdev-web-based-editor.md b/content/codespaces/the-githubdev-web-based-editor.md index b53bd042aa31..2671daa017e1 100644 --- a/content/codespaces/the-githubdev-web-based-editor.md +++ b/content/codespaces/the-githubdev-web-based-editor.md @@ -49,7 +49,7 @@ Both the {% data variables.product.prodname_serverless %} and {% data variables. | **Start up** | The {% data variables.product.prodname_serverless %} opens instantly with a key-press and you can start using it right away, without having to wait for additional configuration or installation. | When you create or resume a codespace, the codespace is assigned a VM and the container is configured based on the contents of a `devcontainer.json` file. This set up may take a few minutes to create the environment. For more information, see "[Creating a Codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." | | **Compute** | There is no associated compute, so you won’t be able to build and run your code or use the integrated terminal. | With {% data variables.product.prodname_codespaces %}, you get the power of dedicated VM on which you can run and debug your application.| | **Terminal access** | None. | {% data variables.product.prodname_codespaces %} provides a common set of tools by default, meaning that you can use the Terminal exactly as you would in your local environment.| -| **Extensions** | Only a subset of extensions that can run in the web will appear in the Extensions View and can be installed. For more information, see "[Using extensions](#using-extensions)."| With Codespaces, you can use most extensions from the {% data variables.product.prodname_vs_marketplace %}.| +| **Extensions** | Only a subset of extensions that can run in the web will appear in the Extensions View and can be installed. For more information, see "[Using extensions](#using-extensions)."| With Codespaces, you can use most extensions from the {% data variables.product.prodname_vscode_marketplace %}.| ### Continue working on {% data variables.product.prodname_codespaces %} diff --git a/data/variables/product.yml b/data/variables/product.yml index 9e807cb46eb9..54b64f298230 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -182,9 +182,9 @@ prodname_vscode_shortname: 'VS Code' prodname_vscode: 'Visual Studio Code' prodname_vss_ghe: 'Visual Studio subscriptions with GitHub Enterprise' prodname_vss_admin_portal_with_url: 'the [administrator portal for Visual Studio subscriptions](https://visualstudio.microsoft.com/subscriptions-administration/)' -prodname_vs_command_palette_shortname: 'VS Code Command Palette' +prodname_vscode_command_palette_shortname: 'VS Code Command Palette' prodname_vscode_command_palette: 'Visual Studio Code Command Palette' -prodname_vs_marketplace: 'Visual Studio Code Marketplace' +prodname_vscode_marketplace: 'Visual Studio Code Marketplace' prodname_vs_marketplace_shortname: 'VS Code Marketplace' # GitHub Dependabot