diff --git a/assets/images/help/codespaces/find-codespace-id.png b/assets/images/help/codespaces/find-codespace-id.png index 325d1a5734..07db492be6 100644 Binary files a/assets/images/help/codespaces/find-codespace-id.png and b/assets/images/help/codespaces/find-codespace-id.png differ diff --git a/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md b/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md index 506bde644b..0015e32246 100644 --- a/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md +++ b/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md @@ -73,7 +73,7 @@ You can use the `gh codespace edit --machine MACHINE-TYPE-NAME` {% data variable gh api /user/codespaces/CODESPACE-NAME ``` - Replace `CODESPACE-NAME` with the permanent name of the codespace, for example `octocat-literate-space-parakeet-mld5`. The permanent names are listed under the **NAME** column in the list returned by `gh codespace list`. + Replace `CODESPACE-NAME` with the permanent name of the codespace, for example `literate-space-parakeet-w5vg5ww5p793g7g9`. The permanent names are listed under the **NAME** column in the list returned by `gh codespace list`. If you're prompted to request the `codespace` scope, follow the instructions in the terminal. @@ -84,7 +84,7 @@ You can use the `gh codespace edit --machine MACHINE-TYPE-NAME` {% data variable gh api /user/codespaces/CODESPACE-NAME/machines ``` - Replace `CODESPACE-NAME` with the permanent name of the codespace, for example `octocat-literate-space-parakeet-mld5`. + Replace `CODESPACE-NAME` with the permanent name of the codespace, for example `literate-space-parakeet-w5vg5ww5p793g7g9`. 1. To change the machine type for a codespace, enter the following command. ```shell diff --git a/content/codespaces/customizing-your-codespace/renaming-a-codespace.md b/content/codespaces/customizing-your-codespace/renaming-a-codespace.md index d5001f8139..9dc5138142 100644 --- a/content/codespaces/customizing-your-codespace/renaming-a-codespace.md +++ b/content/codespaces/customizing-your-codespace/renaming-a-codespace.md @@ -31,16 +31,9 @@ To find the display name of a codespace: ### Permanent codespace names -In addition to the display name, when you create a codespace, a permanent name is also assigned to the codespace. The name is a combination of your {% data variables.product.company_short %} handle, and the auto-generated display name. For example: `octocat-literate-space-parakeet-mld5`. You can't change the permanent name. +In addition to a display name, every codespace also has a unique, permanent name. The permanent name is a combination of the initial display name, followed by some random characters - for example, `literate-space-parakeet-w5vg5ww5p793g7g9`. You can't change the permanent name. -To find the permanent name of a codespace: - -- On {% data variables.product.product_name %}, the permanent name is shown in a pop-up when you hover over the display name of a codespace on https://github.com/codespaces. - - ![Screenshot of the mouse pointer positioned over a display name, with the corresponding codespace name shown at the bottom of the browser page.](/assets/images/help/codespaces/find-codespace-name-github.png) - -- In a codespace, use this command in the terminal: `echo $CODESPACE_NAME`. -- In a terminal window on your local machine, use this {% data variables.product.prodname_cli %} command: `gh codespace list`. +{% data reusables.codespaces.permanent-codespace-names %} ## Renaming a codespace diff --git a/content/codespaces/troubleshooting/exporting-changes-to-a-branch.md b/content/codespaces/troubleshooting/exporting-changes-to-a-branch.md index 80815004ac..fd546fc956 100644 --- a/content/codespaces/troubleshooting/exporting-changes-to-a-branch.md +++ b/content/codespaces/troubleshooting/exporting-changes-to-a-branch.md @@ -36,6 +36,6 @@ The following steps describe how to export your changes to a branch or fork. For ![Screenshot of a list of codespaces with the dropdown menu for one of them displayed, showing the "Export changes to a branch" option.](/assets/images/help/codespaces/export-changes-to-a-branch.png) -1. From the popover or dialog box, select **Create branch** or **Create fork**. +1. In the dialog box, click **Create branch** or **Create fork**. -The name of the new branch will be the permanent name of your codespace prefixed by the string `codespace-`, for example `codespace-monalisa-ideal-space-engine-vj59xj67jg42xx7`. +The name of the new branch will be the permanent name of your codespace prefixed by the string `codespace-`, for example `codespace-ideal-space-engine-w5vg5ww5p793g7g9`. diff --git a/content/codespaces/troubleshooting/github-codespaces-logs.md b/content/codespaces/troubleshooting/github-codespaces-logs.md index 09df8038dc..d71dbb9a3d 100644 --- a/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -134,9 +134,10 @@ gh codespace logs -c > /path/to/logs.txt These logs are available for {% data variables.product.prodname_vscode_shortname %} desktop users only. They are useful if it seems like the {% data variables.product.prodname_github_codespaces %} extension or {% data variables.product.prodname_vscode_shortname %} editor are having issues that prevent creation or connection. 1. In {% data variables.product.prodname_vscode_shortname %}, open the Command Palette. -1. Type `logs` and select **Developer: Open Extension Logs Folder** from the list to open the extension log folder in your system's file explorer. +1. Type `logs` and select **Developer: Open Extension Logs Folder**. +1. Your system's file explorer is displayed showing various log files and folders. Open the folder `output_logging_DATETIME`. -From this view, you can access logs generated by the various extensions that you use in {% data variables.product.prodname_vscode_shortname %}. You will see logs for {% data variables.product.prodname_github_codespaces %}, {% data variables.product.prodname_dotcom %} Authentication, and Git, in addition to any other extensions you have enabled. +From this view, you can access logs generated by extensions you use in {% data variables.product.prodname_vscode_shortname %}, including {% data variables.product.prodname_github_codespaces %}. {% endvscode %} @@ -149,7 +150,9 @@ These logs are useful only if you want to debug problems with using {% data vari The following instructions are for Chrome. The steps for other browsers are similar. 1. In the browser window for the codespace you want to debug, open the developer tools window. -1. Display the "Console" tab and click **errors** in the left side bar to show only the errors. +1. Click the **Console** tab. +1. Show the console sidebar, if it is not already displayed. For more information, see "[Console features reference](https://developer.chrome.com/docs/devtools/console/reference#sidebar)" in the Chrome for Developers documentation. +1. In the sidebar, click **NUMBER errors** to show only the errors. 1. In the log area on the right, right-click and select **Save as** to save a copy of the errors to your local machine. ![Screenshot of the developer tools panel in the Chrome browser. The right-click menu is displayed, showing the option "Save as."](/assets/images/help/codespaces/browser-console-log-save.png) diff --git a/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md b/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md index 3d5be72922..a43da6a537 100644 --- a/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md +++ b/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md @@ -16,16 +16,9 @@ Before support can help you with problems with codespaces, you need to know the ## Codespace names -Each codespace has a unique name that is a combination of your {% data variables.product.company_short %} handle, two or three automatically generated words, and some random characters. For example: `octocat-literate-space-parakeet-mld5`. The two or three automatically generated words also form the initial display name of your codespace, in this case, `literate-space-parakeet`. You can change the display name for a codespace, but this will not affect the permanent name. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/renaming-a-codespace)." +Each codespace has two names: a display name, that you can change, and a unique, permanent name, that you cannot change. Unless you create a codespace with the {% data variables.product.prodname_cli %} and specify a display name of your choice, the display name is automatically generated when you create a codespace, consisting of two or three random words - for example, `literate space parakeet`. The permanent name is a combination of the initial display name, followed by some random characters - for example, `literate-space-parakeet-w5vg5ww5p793g7g9`. If you change the display name the permanent name remains unaffected. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/renaming-a-codespace)." -To find the name of a codespace: - -- Open the codespace in the browser. The subdomain of the URL is the name of the codespace. For example: `https://octocat-literate-space-parakeet-mld5.github.dev` is the URL for the `octocat-literate-space-parakeet-mld5` codespace. -- If you cannot open a codespace, you can access the name in {% data variables.product.product_name %} on https://github.com/codespaces. The name is shown in a pop-up when you hover over the display name of a codespace on https://github.com/codespaces. - - ![Screenshot of the mouse pointer positioned over a display name and the related codespace name shown at the bottom of the browser page.](/assets/images/help/codespaces/find-codespace-name-github.png) - -The name the codespace is also included in many of the log files. For example, in the codespace logs as the value of `friendlyName`, in the {% data variables.product.prodname_github_codespaces %} extension log after `making GET request for`, and in the browser console log after `clientUrl`. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs)." +{% data reusables.codespaces.permanent-codespace-names %} ## Codespaces IDs @@ -33,8 +26,8 @@ Every codespace also has an ID (identifier). This is not shown by default in {% 1. In {% data variables.product.prodname_vscode %}, browser or desktop, in the Activity Bar on the left, click **Remote Explorer** to show details for the codespace. {% indented_data_reference reusables.codespaces.remote-explorer spaces=3 %} -1. If the side bar includes a "Codespace Performance" section, hover over the "Codespace ID" and click the clipboard icon to copy the ID. -1. If the information is not shown, click {% octicon "gear" aria-label="Manage" %}, in the bottom-left corner of the Activity Bar, to display the "Settings" tab. -1. Expand **Extensions** and click **{% data variables.product.prodname_github_codespaces %}** to display the settings for the extension. Then enable **Show Performance Explorer** to display the "Codespace Performance" section in the side bar. +1. If the side bar includes a "Codespace Performance" section, hover over the **Codespace ID** and click the clipboard icon to copy the ID. +1. If the information is not shown, click {% octicon "gear" aria-label="Manage" %}, in the bottom-left corner of the Activity Bar, and click **Settings**. +1. In the **Settings** tab, search for "performance" then, under "{% data variables.product.prodname_dotcom %} > {% data variables.product.prodname_codespaces %}: Show Performance Explorer", select the checkbox labeled "Display the Codespace Performance window in the Remote Explorer." ![Screenshot of "Show Performance Explorer" selected in {% data variables.product.prodname_vscode_shortname %}'s "Settings" tab and a codespace ID highlighted in the "Remote Explorer" side bar.](/assets/images/help/codespaces/find-codespace-id.png) diff --git a/data/reusables/codespaces/linking-to-an-existing-codespace.md b/data/reusables/codespaces/linking-to-an-existing-codespace.md index 4de6c72d76..bb594f0c70 100644 --- a/data/reusables/codespaces/linking-to-an-existing-codespace.md +++ b/data/reusables/codespaces/linking-to-an-existing-codespace.md @@ -8,7 +8,7 @@ You can create links to your existing codespaces. This is useful if you have a l {% endnote %} -Create a link using one of the following URL patterns. In these URLs `CODESPACE-NAME` represents the unique name of the codespace, such as `monalisa-project-x-codespace-956j5pp5pjpc79wx`, not the codespace's display name. You can find the name of a codespace by copying the link to the codespace on your https://github.com/codespaces page and extracting the codespace name from the URL. +Create a link using one of the following URL patterns. In these URLs `CODESPACE-NAME` represents the unique, permanent name of the codespace, such as `literate-space-parakeet-w5vg5ww5p793g7g9`, not the codespace's display name. You can find the name of a codespace by copying the link to the codespace on your https://github.com/codespaces page and extracting the codespace name from the URL. | **Link opens in** | **Link syntax** | | --- | --- | diff --git a/data/reusables/codespaces/permanent-codespace-names.md b/data/reusables/codespaces/permanent-codespace-names.md new file mode 100644 index 0000000000..d778735852 --- /dev/null +++ b/data/reusables/codespaces/permanent-codespace-names.md @@ -0,0 +1,10 @@ +You will occasionally need to know the permanent name of a codespace. For example, when you use some {% data variables.product.prodname_cli %} commands, or when you discuss a particular codespace with {% data variables.product.prodname_dotcom %} support. + +To find the permanent name of a codespace, do one of the following: + +- Open the codespace in the browser. The subdomain of the URL is the name of the codespace. For example: `https://obscure-space-engine-grx7rgg6qp43v9j5.github.dev` is the URL for the `obscure-space-engine-grx7rgg6qp43v9j5` codespace. +- If you cannot open a codespace, you can access the name from your list of codespaces at https://github.com/codespaces. Right-click the display name of the codespace and select your browser's option for copying the link address. The final part of the URL you copy is the permanent name of the codespace. +- In a codespace, use this command in the terminal: `echo $CODESPACE_NAME`. +- If {% data variables.product.prodname_cli %} is installed, either locally or in a codespace, use this command in the terminal to list all of your codespaces: `gh codespace list`. + +The permanent name the codespace is also included in many of the log files. For example, in the {% data variables.product.prodname_github_codespaces %} extension log, after `fetching codespace` or `Connecting to codespace`, and in the browser console log after `clientUrl`. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs)."