diff --git a/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 738945ccc9..4f9a4692ad 100644 --- a/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -1,6 +1,6 @@ --- title: Allowing your codespace to access a private image registry -intro: 'You can use secrets to allow {% data variables.product.prodname_codespaces %} to access a private image registry' +intro: 'You can use secrets to allow {% data variables.product.prodname_github_codespaces %} to access a private image registry' versions: fpt: '*' ghec: '*' @@ -10,15 +10,15 @@ product: '{% data reusables.gated-features.codespaces %}' shortTitle: Private image registry --- -## About private image registries and {% data variables.product.prodname_codespaces %} +## About private image registries and {% data variables.product.prodname_github_codespaces %} A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_dotcom %} Container Registry, Azure Container Registry, or DockerHub. -{% data variables.product.prodname_dotcom %} Container Registry can be configured to pull container images seamlessly, without having to provide any authentication credentials to {% data variables.product.prodname_codespaces %}. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. +{% data variables.product.prodname_dotcom %} Container Registry can be configured to pull container images seamlessly, without having to provide any authentication credentials to {% data variables.product.prodname_github_codespaces %}. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. ## Accessing images stored in {% data variables.product.prodname_dotcom %} Container Registry -{% data variables.product.prodname_dotcom %} Container Registry is the easiest way for {% data variables.product.prodname_github_codespaces %} to consume devcontainer container images. +{% data variables.product.prodname_dotcom %} Container Registry is the easiest way for {% data variables.product.prodname_codespaces %} to consume devcontainer container images. For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". @@ -52,7 +52,7 @@ We recommend publishing images via {% data variables.product.prodname_actions %} ## Accessing images stored in other container registries -If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace. +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_github_codespaces %} will make the registry available inside your codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` 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 acb0cad204..bf2b347536 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 @@ -1,6 +1,6 @@ --- -title: Using the Visual Studio Code Command Palette in Codespaces -intro: 'You can use the Command Palette feature of {% data variables.product.prodname_vscode %} to access many commands in Codespaces.' +title: Using the Visual Studio Code Command Palette in GitHub Codespaces +intro: 'You can use the Command Palette feature of {% data variables.product.prodname_vscode %} to access many commands in {% data variables.product.prodname_github_codespaces %}.' versions: fpt: '*' ghec: '*' @@ -17,7 +17,7 @@ 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_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. +The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in {% data variables.product.prodname_github_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_vscode_command_palette_shortname %} @@ -31,9 +31,9 @@ You can access the {% data variables.product.prodname_vscode_command_palette_sho ![The application menu](/assets/images/help/codespaces/codespaces-view-menu.png) -## Commands for {% data variables.product.prodname_github_codespaces %} +## Commands for {% data variables.product.prodname_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". +To see all commands related to {% data variables.product.prodname_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) @@ -63,6 +63,6 @@ To rebuild your container, [access the {% data variables.product.prodname_vscode 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_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. +To retrieve the logs for {% data variables.product.prodname_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 {% data variables.product.prodname_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/customizing-your-codespace/setting-your-default-editor-for-codespaces.md b/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md index e25a09d3c5..cfa14aca5b 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md +++ b/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces.md @@ -1,6 +1,6 @@ --- -title: Setting your default editor for Codespaces -intro: 'You can set your default editor for {% data variables.product.prodname_codespaces %} in your personal settings page.' +title: Setting your default editor for GitHub Codespaces +intro: 'You can set your default editor for {% data variables.product.prodname_github_codespaces %} in your personal settings page.' product: '{% data reusables.gated-features.codespaces %}' versions: fpt: '*' @@ -14,7 +14,7 @@ shortTitle: Set the default editor On the settings page, you can set your editor preference so that any newly created codespaces are opened automatically in either {% data variables.product.prodname_vscode %} for Web or the {% data variables.product.prodname_vscode %} desktop application. -If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). +If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_github_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). ## Setting your default editor @@ -22,5 +22,5 @@ If you want to use {% data variables.product.prodname_vscode %} as your default {% data reusables.user-settings.codespaces-tab %} 1. Under "Editor preference", select the option you want. ![Setting your editor](/assets/images/help/codespaces/select-default-editor.png) - If you choose **{% data variables.product.prodname_vscode %}**, {% data variables.product.prodname_codespaces %} will automatically open in the desktop application when you next create a codespace. You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully. + If you choose **{% data variables.product.prodname_vscode %}**, {% data variables.product.prodname_github_codespaces %} will automatically open in the desktop application when you next create a codespace. You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully. ![Setting your editor](/assets/images/help/codespaces/launch-default-editor.png) diff --git a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md b/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md index a04e2eb9cc..101f33b361 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md +++ b/content/codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces.md @@ -1,5 +1,5 @@ --- -title: Setting your default region for Codespaces +title: Setting your default region for GitHub Codespaces intro: 'You can set your default region in the {% data variables.product.prodname_github_codespaces %} profile settings page to personalize where your data is held.' product: '{% data reusables.gated-features.codespaces %}' versions: 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 3b81563de2..c795ecd608 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 @@ -1,5 +1,5 @@ --- -title: Using Codespaces in Visual Studio Code +title: Using GitHub Codespaces in Visual Studio Code intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.codespaces %}' redirect_from: @@ -18,9 +18,9 @@ shortTitle: Visual Studio Code --- -## About {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %} +## About {% data variables.product.prodname_github_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_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)." +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_github_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_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)." diff --git a/content/codespaces/developing-in-codespaces/using-codespaces-with-github-cli.md b/content/codespaces/developing-in-codespaces/using-codespaces-with-github-cli.md index 68efad7449..df1218a9ce 100644 --- a/content/codespaces/developing-in-codespaces/using-codespaces-with-github-cli.md +++ b/content/codespaces/developing-in-codespaces/using-codespaces-with-github-cli.md @@ -1,5 +1,5 @@ --- -title: Using Codespaces with GitHub CLI +title: Using GitHub Codespaces with GitHub CLI shortTitle: GitHub CLI intro: 'You can work with {% data variables.product.prodname_github_codespaces %} directly from your command line by using `gh`, the {% data variables.product.product_name %} command line interface.' product: '{% data reusables.gated-features.codespaces %}' @@ -18,16 +18,21 @@ topics: {% data reusables.cli.about-cli %} For more information, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)." You can work with {% data variables.product.prodname_codespaces %} in the {% data variables.product.prodname_cli %} to: -- [List your codespaces](#list-all-of-your-codespaces) -- [Create a codespace](#create-a-new-codespace) -- [Stop a codespace](#stop-a-codespace) -- [Delete a codespace](#delete-a-codespace) -- [SSH into a codespace](#ssh-into-a-codespace) -- [Open a codespace in {% data variables.product.prodname_vscode %}](#open-a-codespace-in-visual-studio-code) -- [Open a codespace in JupyterLab](#open-a-codespace-in-jupyterlab) -- [Copying a file to/from a codespace](#copy-a-file-tofrom-a-codespace) -- [Modify ports in a codespace](#modify-ports-in-a-codespace) -- [Access codespace logs](#access-codespace-logs) +- [About {% data variables.product.prodname_cli %}](#about--data-variablesproductprodname_cli-) +- [Installing {% data variables.product.prodname_cli %}](#installing--data-variablesproductprodname_cli-) +- [Using {% data variables.product.prodname_cli %}](#using--data-variablesproductprodname_cli-) +- [`gh` commands for {% data variables.product.prodname_github_codespaces %}](#gh-commands-for--data-variablesproductprodname_github_codespaces-) + - [List all of your codespaces](#list-all-of-your-codespaces) + - [Create a new codespace](#create-a-new-codespace) + - [Stop a codespace](#stop-a-codespace) + - [Delete a codespace](#delete-a-codespace) + - [SSH into a codespace](#ssh-into-a-codespace) + - [Open a codespace in {% data variables.product.prodname_vscode %}](#open-a-codespace-in--data-variablesproductprodname_vscode-) + - [Open a codespace in JupyterLab](#open-a-codespace-in-jupyterlab) + - [Copy a file to/from a codespace](#copy-a-file-tofrom-a-codespace) + - [Examples](#examples) + - [Modify ports in a codespace](#modify-ports-in-a-codespace) + - [Access codespace logs](#access-codespace-logs) ## Installing {% data variables.product.prodname_cli %} diff --git a/data/reusables/gated-features/codespaces.md b/data/reusables/gated-features/codespaces.md index 4b85591f8f..572854b8ff 100644 --- a/data/reusables/gated-features/codespaces.md +++ b/data/reusables/gated-features/codespaces.md @@ -1 +1 @@ -Codespaces is available for organizations using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info-org-products %} +{% data variables.product.prodname_github_codespaces %} is available for organizations using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info-org-products %}