Skip to content

Commit 7c5dfd7

Browse files
author
Peter Bengtsson
authored
Correct internal links to codespaces/reference/ (#44921)
1 parent 4490206 commit 7c5dfd7

File tree

51 files changed

+116
-116
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+116
-116
lines changed

content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ type: how_to
1616

1717
{% data reusables.codespaces.codespaces-machine-types %} You can choose an alternative machine type either when you create a codespace or at any time after you've created a codespace.
1818

19-
For information on choosing a machine type when you create a codespace, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)."
19+
For information on choosing a machine type when you create a codespace, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)."
2020

21-
{% data reusables.codespaces.machine-types-for-unpublished-codespaces %} For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template)."
21+
{% data reusables.codespaces.machine-types-for-unpublished-codespaces %} For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template)."
2222

2323
## Changing the machine type
2424

content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Changing the shell in a codespace
33
shortTitle: Change your shell
4-
intro: 'You can change your shell in a codespace to keep the setup you''re used to.'
4+
intro: You can change your shell in a codespace to keep the setup you're used to.
55
versions:
66
fpt: '*'
77
ghec: '*'
@@ -99,7 +99,7 @@ You can set a default terminal profile to choose the default shell used for all
9999

100100
When you connect to a codespace from the command line over SSH, you connect to a `bash` session in the codespace by default.
101101

102-
If you have enabled a dotfiles repository for {% data variables.product.prodname_github_codespaces %}, you can change the default shell you connect to by adding a command to an installation script such as `install.sh` in your dotfiles. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli#ssh-into-a-codespace)" and "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." For example, the following command changes the default shell to `zsh`.
102+
If you have enabled a dotfiles repository for {% data variables.product.prodname_github_codespaces %}, you can change the default shell you connect to by adding a command to an installation script such as `install.sh` in your dotfiles. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli#ssh-into-a-codespace)" and "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." For example, the following command changes the default shell to `zsh`.
103103

104104
```shell copy
105105
sudo chsh "$(id -un)" --shell "/usr/bin/zsh"

content/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ However, because {% data variables.product.prodname_github_codespaces %} incurs
1616

1717
{% note %}
1818

19-
**Note**: Whether or not you have set a personal codespace retention period, it's a good idea to get into the habit of deleting codespaces that you no longer need. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/deleting-a-codespace)."
19+
**Note**: Whether or not you have set a personal codespace retention period, it's a good idea to get into the habit of deleting codespaces that you no longer need. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/deleting-a-codespace)."
2020

2121
{% endnote %}
2222

content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Your updates will take effect in new codespaces. However, you can turn on Settin
8282

8383
{% note %}
8484

85-
**Note:** You should only turn on Settings Sync in codespaces created from repositories you trust. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)."
85+
**Note:** You should only turn on Settings Sync in codespaces created from repositories you trust. For more information, see "[AUTOTITLE](/codespaces/reference/security-in-github-codespaces#using-settings-sync)."
8686

8787
{% endnote %}
8888

content/codespaces/customizing-your-codespace/renaming-a-codespace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ gh codespace edit -c PERMANENT-CODESPACE-NAME -d NEW-DISPLAY-NAME
5858

5959
In this example, replace `PERMANENT-CODESPACE-NAME` with the permanent name of the codespace whose display name you want to change. Replace `NEW-DISPLAY-NAME` with the display name you want to use for this codespace.
6060

61-
For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli#rename-a-codespace)."
61+
For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli#rename-a-codespace)."
6262

6363
{% endcli %}
6464

content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ On the settings page, you can set your editor preference so that when you create
2323

2424
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).
2525

26-
If you want to work on a codespace in a JetBrains IDE you must install the JetBrains Gateway. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide)."
26+
If you want to work on a codespace in a JetBrains IDE you must install the JetBrains Gateway. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)."
2727

2828
## Setting your default editor
2929

@@ -45,7 +45,7 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr
4545

4646
The first time you open a codespace this way you must give permission to open the application.
4747

48-
The Gateway application will open and the codespace will then be automatically selected. You can then choose a JetBrains IDE, if you have not previously done so, and click **Connect** to open the codespace in the JetBrains client. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide)."
48+
The Gateway application will open and the codespace will then be automatically selected. You can then choose a JetBrains IDE, if you have not previously done so, and click **Connect** to open the codespace in the JetBrains client. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)."
4949

5050
To connect to a codespace from the Gateway application, you must have an SSH server running on the codespace. {% indented_data_reference reusables.codespaces.ssh-server-installed spaces=5 %}
5151

content/codespaces/developing-in-a-codespace/connecting-to-a-private-network.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ These third party solutions include:
4747

4848
### Allowlisting private resources for codespaces
4949

50-
While {% data variables.product.prodname_dotcom %} publishes IP ranges for several products on its Meta API, IP addresses for codespaces are dynamically assigned, meaning your codespace is not guaranteed to have the same IP address day to day. For more information about the Meta API, see "[Meta](/rest/reference/meta)."
50+
While {% data variables.product.prodname_dotcom %} publishes IP ranges for several products on its Meta API, IP addresses for codespaces are dynamically assigned, meaning your codespace is not guaranteed to have the same IP address day to day. For more information about the Meta API, see "[AUTOTITLE](/rest/meta/meta)."
5151

5252
Allowlisting an entire IP range would give overly broad access to all codespaces (including users not affiliated with your codespaces), so for this reason codespace creation is disabled if you enable IP allow lists. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#enabling-allowed-ip-addresses)."
5353

5454
## Restricting access to the public internet
5555

5656
At present, there is no way to restrict codespaces from accessing the public internet, or to restrict appropriately authenticated users from accessing a forwarded port.
5757

58-
For more information on how to secure your codespaces, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces)."
58+
For more information on how to secure your codespaces, see "[AUTOTITLE](/codespaces/reference/security-in-github-codespaces)."

content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ Organizations can enable members and outside collaborators to create and use cod
3535
{% endnote %}
3636
{% endif %}
3737

38-
{% data reusables.codespaces.starting-new-project-template %} For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template)."
38+
{% data reusables.codespaces.starting-new-project-template %} For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template)."
3939

4040
{% note %}
4141

42-
**Note**: If you use a JetBrains IDE, you can use {% data variables.product.prodname_cli %} to create a codespace. You can then use the JetBrains Gateway application to open the codespace in a JetBrains IDE. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide)."
42+
**Note**: If you use a JetBrains IDE, you can use {% data variables.product.prodname_cli %} to create a codespace. You can then use the JetBrains Gateway application to open the codespace in a JetBrains IDE. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)."
4343

4444
{% endnote %}
4545

@@ -58,7 +58,7 @@ When you create a codespace, a number of steps happen to create and connect you
5858

5959
For more information on what happens when you create a codespace, see "[AUTOTITLE](/codespaces/getting-started/deep-dive)."
6060

61-
For more information on the lifecycle of a codespace, see "[AUTOTITLE](/codespaces/getting-started/the-codespace-lifecycle)."
61+
For more information on the lifecycle of a codespace, see "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)."
6262

6363
If you want to use Git hooks for your codespace, then you should set up hooks using the `devcontainer.json` lifecycle scripts, such as `postCreateCommand`. These get executed during step 4, above. For information about the lifecycle scripts, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. 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.
6464

@@ -167,6 +167,6 @@ For full details of the options for this command, see [the {% data variables.pro
167167

168168
## Further reading
169169

170-
- "[AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace)"
170+
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/opening-an-existing-codespace)"
171171
- "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces)"
172172
- "[AUTOTITLE](/rest/codespaces)" (REST API reference)

content/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ You can create a codespace from any template repository, then publish your work
6565

6666
{% note %}
6767

68-
**Note:** If you're a maintainer of the template repository, and want to commit changes to the template repository itself, you should create a codespace from the **{% octicon "code" aria-hidden="true" %} Code** dropdown. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)."
68+
**Note:** If you're a maintainer of the template repository, and want to commit changes to the template repository itself, you should create a codespace from the **{% octicon "code" aria-hidden="true" %} Code** dropdown. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)."
6969

7070
{% endnote %}
7171

@@ -102,6 +102,6 @@ You can publish an unpublished codespace from the "Your codespaces" page on {% d
102102

103103
## Further reading
104104

105-
- "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository)"
106-
- "[AUTOTITLE](/codespaces/getting-started/the-codespace-lifecycle)"
107-
- "[AUTOTITLE](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace)"
105+
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)"
106+
- "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)"
107+
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace)"

content/codespaces/developing-in-a-codespace/default-environment-variables-for-your-codespace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ redirect_from:
3737
| `GITHUB_GRAPHQL_URL` | Returns the GraphQL API URL. For example, `{% data variables.product.graphql_url_code %}`. |
3838
| `GITHUB_REPOSITORY` | The owner and repository name. For example, `octocat/Hello-World`. |
3939
| `GITHUB_SERVER_URL`| Returns the URL of the {% data variables.product.product_name %} server. For example, `https://{% data variables.product.product_url %}`. |
40-
| `GITHUB_TOKEN` | A signed auth token representing the user in the codespace. You can use this to make authenticated calls to the GitHub API. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#authentication)." |
40+
| `GITHUB_TOKEN` | A signed auth token representing the user in the codespace. You can use this to make authenticated calls to the GitHub API. For more information, see "[AUTOTITLE](/codespaces/reference/security-in-github-codespaces#authentication)." |
4141
| `GITHUB_USER` | The name of the user that initiated the codespace. For example, `octocat`. |

0 commit comments

Comments
 (0)