Skip to content

Commit 52b841b

Browse files
authored
Consolidate product name variables for base URL (#50519)
1 parent ffa3daf commit 52b841b

File tree

32 files changed

+114
-121
lines changed

32 files changed

+114
-121
lines changed

Diff for: content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Email notifications from {% data variables.product.prodname_dotcom %} contain he
130130
| `From` address | This address will always be {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. |
131131
| `To` field | This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation. |
132132
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% ifversion fpt or ghec %}`@noreply.github.com`{% else %}based on the no-reply email address configured by your site administrator{% endif %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li><li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li><li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
133-
| `List-Id` field | This field identifies the name of the repository and its owner. The format of this address is always `OWNER/REPOSITORY <REPOSITORY.OWNER>`, e.g. `List-Id: grain-lang/grain <grain.grain-lang.{% data variables.command_line.backticks %}>`. |
133+
| `List-Id` field | This field identifies the name of the repository and its owner. The format of this address is always `OWNER/REPOSITORY <REPOSITORY.OWNER>`, e.g. `List-Id: grain-lang/grain <grain.grain-lang.{% data variables.product.product_url %}>`. |
134134
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:<ul><li>`low`</li><li>`moderate`</li><li>`high`</li><li>`critical`</li></ul>For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." |
135135

136136
## Choosing your notification settings

Diff for: content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ If you have any local copies of personal repositories you have created or forked
6363
$ cd YOUR-REPOSITORY
6464
# Change directories to the initialized Git repository
6565
$ git remote -v
66-
origin https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git (fetch)
67-
origin https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git (push)
66+
origin https://{% data variables.product.product_url %}/YOUR-USERNAME/YOUR-REPOSITORY.git (fetch)
67+
origin https://{% data variables.product.product_url %}/YOUR-USERNAME/YOUR-REPOSITORY.git (push)
6868
```
6969

70-
Your user name is what immediately follows the `https://{% data variables.command_line.backticks %}/`.
70+
Your user name is what immediately follows the `https://{% data variables.product.product_url %}/`.
7171

7272
{% ifversion fpt or ghec %}
7373

Diff for: content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/changing-your-github-username.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ If the new owner of your old username creates a repository with the same name as
7676

7777
## Links to your previous profile page
7878

79-
After changing your username, links to your previous profile page, such as `https://{% data variables.command_line.backticks %}/previoususername`, will return a 404 error. We recommend updating any links to your account on {% data variables.location.product_location %} from elsewhere{% ifversion fpt or ghec %}, such as your LinkedIn or Twitter profile{% endif %}.
79+
After changing your username, links to your previous profile page, such as `https://{% data variables.product.product_url %}/previoususername`, will return a 404 error. We recommend updating any links to your account on {% data variables.location.product_location %} from elsewhere{% ifversion fpt or ghec %}, such as your LinkedIn or Twitter profile{% endif %}.
8080

8181
## Your Git commits
8282

Diff for: content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ You'll need to authenticate this action using your password, which is the SSH ke
2525
1. Enter the following:
2626

2727
```shell replacedomain copy
28-
ssh -T git@{% data variables.command_line.codeblock %}
28+
ssh -T git@{% data variables.product.product_url %}
2929
# Attempts to ssh to {% data variables.product.product_name %}
3030
```
3131

3232
You may see a warning like this:
3333

3434
```shell replacedomain
35-
> The authenticity of host '{% data variables.command_line.codeblock %} (IP ADDRESS)' can't be established.
35+
> The authenticity of host '{% data variables.product.product_url %} (IP ADDRESS)' can't be established.
3636
> ED25519 key fingerprint is SHA256:+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU.
3737
> Are you sure you want to continue connecting (yes/no)?
3838
```

Diff for: content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Once you have a {% data variables.product.pat_generic %}, you can enter it inste
166166
For example, to clone a repository on the command line you would enter the following `git clone` command. You would then be prompted to enter your username and password. When prompted for your password, enter your {% data variables.product.pat_generic %} instead of a password.
167167

168168
```shell
169-
$ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPO.git
169+
$ git clone https://{% data variables.product.product_url %}/USERNAME/REPO.git
170170
Username: YOUR-USERNAME
171171
Password: YOUR-PERSONAL-ACCESS-TOKEN
172172
```

Diff for: content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil
9595
1. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/repositories/creating-and-managing-repositories/cloning-a-repository) to your local computer.
9696

9797
```shell
98-
$ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY
98+
$ git clone https://{% data variables.product.product_url %}/YOUR-USERNAME/YOUR-REPOSITORY
9999
> Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/
100100
> remote: Counting objects: 1301, done.
101101
> remote: Compressing objects: 100% (769/769), done.
@@ -159,7 +159,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil
159159
> Compressing objects: 100% (677/677), done.
160160
> Writing objects: 100% (1058/1058), 148.85 KiB, done.
161161
> Total 1058 (delta 590), reused 602 (delta 378)
162-
> To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git
162+
> To https://{% data variables.product.product_url %}/YOUR-USERNAME/YOUR-REPOSITORY.git
163163
> + 48dc599...051452f main -> main (forced update)
164164
```
165165
@@ -172,7 +172,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil
172172
> Compressing objects: 100% (166/166), done.
173173
> Writing objects: 100% (321/321), 331.74 KiB | 0 bytes/s, done.
174174
> Total 321 (delta 124), reused 269 (delta 108)
175-
> To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git
175+
> To https://{% data variables.product.product_url %}/YOUR-USERNAME/YOUR-REPOSITORY.git
176176
> + 48dc599...051452f main -> main (forced update)
177177
```
178178

Diff for: content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ shortTitle: Agent failure to sign
1717
When trying to SSH into {% data variables.location.product_location %} on a Linux computer, you may see the following message in your terminal:
1818

1919
```shell
20-
$ ssh -vT git@{% data variables.command_line.codeblock %}
20+
$ ssh -vT git@{% data variables.product.product_url %}
2121
> ...
2222
> Agent admitted failure to sign using the key.
2323
> debug1: No more authentication methods to try.

Diff for: content/authentication/troubleshooting-ssh/error-bad-file-number.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ topics:
1515
When running remote Git commands or SSH, your connection might time out:
1616

1717
```shell
18-
$ ssh -vT git@{% data variables.command_line.codeblock %}
18+
$ ssh -vT git@{% data variables.product.product_url %}
1919
> OpenSSH_8.1p1, LibreSSL 2.7.3
20-
> debug1: Connecting to {% data variables.command_line.codeblock %} [207.97.227.239] port 22.
20+
> debug1: Connecting to {% data variables.product.product_url %} [207.97.227.239] port 22.
2121
> debug1: connect to address 207.97.227.239 port 22: Connection timed out
22-
> ssh: connect to host {% data variables.command_line.codeblock %} port 22: Connection timed out
23-
> ssh: connect to host {% data variables.command_line.codeblock %} port 22: Bad file number
22+
> ssh: connect to host {% data variables.product.product_url %} port 22: Connection timed out
23+
> ssh: connect to host {% data variables.product.product_url %} port 22: Bad file number
2424
```
2525

2626
## Solving the issue
@@ -30,7 +30,7 @@ $ ssh -vT git@{% data variables.command_line.codeblock %}
3030
Often, the simplest solution is to simply avoid SSH entirely. Most firewalls and proxies allow HTTPS traffic without issue. To take advantage of this, change [the remote URL](/get-started/getting-started-with-git/about-remote-repositories) you're using:
3131

3232
```shell
33-
$ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPO-NAME.git
33+
$ git clone https://{% data variables.product.product_url %}/USERNAME/REPO-NAME.git
3434
> Cloning into 'reponame'...
3535
> remote: Counting objects: 84, done.
3636
> remote: Compressing objects: 100% (45/45), done.

Diff for: content/authentication/troubleshooting-ssh/error-key-already-in-use.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ topics:
1717
To determine where the key has already been used, open a terminal and type the `ssh` command. Use the `-i` flag to provide the path to the key you want to check:
1818

1919
```shell
20-
$ ssh -T -ai ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %}
20+
$ ssh -T -ai ~/.ssh/id_rsa git@{% data variables.product.product_url %}
2121
# Connect to {% data variables.location.product_location %} using a specific ssh key
2222
> Hi USERNAME! You've successfully authenticated, but GitHub does not
2323
> provide shell access.
@@ -28,7 +28,7 @@ The _username_ in the response is the account on {% data variables.location.prod
2828
To force SSH to use only the key provided on the command line, use `-o` to add the `IdentitiesOnly=yes` option:
2929
3030
```shell
31-
ssh -v -o "IdentitiesOnly=yes" -i ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %}
31+
ssh -v -o "IdentitiesOnly=yes" -i ~/.ssh/id_rsa git@{% data variables.product.product_url %}
3232
```
3333
3434
## Fixing the issue

Diff for: content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ If you have a _very good reason_ you must use `sudo`, then ensure you are using
2525
To make sure you are connecting to the right domain, you can enter the following command:
2626

2727
```shell replacedomain copy
28-
ssh -vT git@{% data variables.command_line.codeblock %}
28+
ssh -vT git@{% data variables.product.product_url %}
2929
```
3030

3131
You should see this output:
@@ -35,7 +35,7 @@ You should see this output:
3535
> debug1: Reading configuration data /Users/YOU/.ssh/config
3636
> debug1: Reading configuration data /etc/ssh/ssh_config
3737
> debug1: /etc/ssh/ssh_config line 47: Applying options for *
38-
> debug1: Connecting to {% data variables.command_line.codeblock %} port 22.
38+
> debug1: Connecting to {% data variables.product.product_url %} port 22.
3939
```
4040

4141
The connection should be made on port 22{% ifversion fpt or ghec %}, unless you're overriding settings to use [SSH over HTTPS](/authentication/troubleshooting-ssh/using-ssh-over-the-https-port){% endif %}.
@@ -45,7 +45,7 @@ The connection should be made on port 22{% ifversion fpt or ghec %}, unless you'
4545
All connections, including those for remote URLs, must be made as the "git" user. If you try to connect with your {% data variables.product.product_name %} username, it will fail:
4646

4747
```shell replacedomain
48-
$ ssh -T GITHUB-USERNAME@{% data variables.command_line.codeblock %}
48+
$ ssh -T GITHUB-USERNAME@{% data variables.product.product_url %}
4949
> Permission denied (publickey).
5050
```
5151

@@ -54,7 +54,7 @@ If your connection failed and you're using a remote URL with your {% data variab
5454
You should verify your connection by typing:
5555

5656
```shell replacedomain copy
57-
ssh -T git@{% data variables.command_line.codeblock %}
57+
ssh -T git@{% data variables.product.product_url %}
5858
```
5959

6060
You should see this output:
@@ -122,10 +122,10 @@ The `ssh-add` command _should_ print out a long string of numbers and letters. I
122122

123123
### Getting more details
124124

125-
You can also check that the key is being used by trying to connect to `git@{% data variables.command_line.backticks %}`:
125+
You can also check that the key is being used by trying to connect to `git@{% data variables.product.product_url %}`:
126126

127127
```shell replacedomain copy
128-
ssh -vT git@{% data variables.command_line.codeblock %}
128+
ssh -vT git@{% data variables.product.product_url %}
129129
```
130130

131131
You'll see output like this:

Diff for: content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ $ ssh -T -p 443 git@ssh.github.com
2828
2929
{% note %}
3030
31-
**Note**: The hostname for port 443 is `ssh.{% data variables.command_line.backticks %}`, not `{% data variables.command_line.backticks %}`.
31+
**Note**: The hostname for port 443 is `ssh.{% data variables.product.product_url %}`, not `{% data variables.product.product_url %}`.
3232
3333
{% endnote %}
3434
@@ -37,26 +37,26 @@ If that worked, great! If not, you may need to [follow our troubleshooting guide
3737
Now, to clone the repository, you can run the following command:
3838
3939
```shell
40-
git clone ssh://git@ssh.{% data variables.command_line.codeblock %}:443/YOUR-USERNAME/YOUR-REPOSITORY.git
40+
git clone ssh://git@ssh.{% data variables.product.product_url %}:443/YOUR-USERNAME/YOUR-REPOSITORY.git
4141
```
4242
4343
## Enabling SSH connections over HTTPS
4444
45-
If you are able to SSH into `git@ssh.{% data variables.command_line.backticks %}` over port 443, you can override your SSH settings to force any connection to {% data variables.location.product_location %} to run through that server and port.
45+
If you are able to SSH into `git@ssh.{% data variables.product.product_url %}` over port 443, you can override your SSH settings to force any connection to {% data variables.location.product_location %} to run through that server and port.
4646
4747
To set this in your SSH configuration file, edit the file at `~/.ssh/config`, and add this section:
4848
4949
```text
50-
Host {% data variables.command_line.codeblock %}
51-
Hostname ssh.{% data variables.command_line.codeblock %}
50+
Host {% data variables.product.product_url %}
51+
Hostname ssh.{% data variables.product.product_url %}
5252
Port 443
5353
User git
5454
```
5555
5656
You can test that this works by connecting once more to {% data variables.location.product_location %}:
5757
5858
```shell
59-
$ ssh -T git@{% data variables.command_line.codeblock %}
59+
$ ssh -T git@{% data variables.product.product_url %}
6060
> Hi USERNAME! You've successfully authenticated, but GitHub does not
6161
> provide shell access.
6262
```

Diff for: content/get-started/exploring-projects-on-github/contributing-to-a-project.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ You can clone your fork with the command line, {% data variables.product.prodnam
6262
1. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`:
6363

6464
```shell
65-
git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife
65+
git clone https://{% data variables.product.product_url %}/YOUR-USERNAME/Spoon-Knife
6666
```
6767

6868
1. Press **Enter**. Your local clone will be created.
6969

7070
```shell
71-
$ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife
71+
$ git clone https://{% data variables.product.product_url %}/YOUR-USERNAME/Spoon-Knife
7272
> Cloning into `Spoon-Knife`...
7373
> remote: Counting objects: 10, done.
7474
> remote: Compressing objects: 100% (8/8), done.

Diff for: content/get-started/getting-started-with-git/about-remote-repositories.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ A remote URL is Git's fancy way of saying "the place where your code is stored."
2222

2323
You can only push to two types of URL addresses:
2424

25-
- An HTTPS URL like `https://{% data variables.command_line.backticks %}/user/repo.git`
26-
- An SSH URL, like `git@{% data variables.command_line.backticks %}:user/repo.git`
25+
- An HTTPS URL like `https://{% data variables.product.product_url %}/user/repo.git`
26+
- An SSH URL, like `git@{% data variables.product.product_url %}:user/repo.git`
2727

2828
Git associates a remote URL with a name, and your default remote is usually called `origin`.
2929

0 commit comments

Comments
 (0)