Skip to content

Commit

Permalink
Merge pull request github#36529 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Feb 26, 2025
2 parents b3a70c4 + 6b37bf8 commit 4ccf89d
Show file tree
Hide file tree
Showing 53 changed files with 92 additions and 79 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use the table of contents icon <img alt="Table of contents icon" src="/contribut
To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions:

- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git)
- [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Date: Sun, 27 Apr 2014 15:36:39 +0530
Subject: [PATCH] updated index for better welcome message
```

The email address in the `From:` field is the address that was set in the [local git config settings](/get-started/getting-started-with-git/set-up-git). In this example, the email address used for the commit is `octocat@nowhere.com`.
The email address in the `From:` field is the address that was set in the [local git config settings](/get-started/git-basics/set-up-git). In this example, the email address used for the commit is `octocat@nowhere.com`.

If the email address used for the commit is not connected to your account on {% data variables.product.prodname_dotcom %}, you must [add the email address](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to your account on {% data variables.product.prodname_dotcom %}. Your contributions graph will be rebuilt automatically when you add the new address.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ shortTitle: Find your username or email

## Finding your username in your `user.name` configuration

During set up, you may have [set your username in Git](/get-started/getting-started-with-git/setting-your-username-in-git). If so, you can review the value of this configuration setting:
During set up, you may have [set your username in Git](/get-started/git-basics/setting-your-username-in-git). If so, you can review the value of this configuration setting:

```shell
$ git config user.name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ After you change your username, {% data variables.product.github %} will automat
* Web links to your existing repositories will continue to work. This can take a few minutes to complete after you make the change.
* Command line pushes from your local repository clones to the old remote tracking URLs will continue to work.

If the new owner of your old username creates a repository with the same name as your repository, that will override the redirect entry and your redirect will stop working. Because of this possibility, we recommend you update all existing remote repository URLs after changing your username. For more information, see [AUTOTITLE](/get-started/getting-started-with-git/managing-remote-repositories).
If the new owner of your old username creates a repository with the same name as your repository, that will override the redirect entry and your redirect will stop working. Because of this possibility, we recommend you update all existing remote repository URLs after changing your username. For more information, see [AUTOTITLE](/get-started/git-basics/managing-remote-repositories).

## Links to your previous profile page

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ shortTitle: Merge multiple accounts
> * Achievements are not able to be transferred between accounts.
1. [Transfer any repositories](/repositories/creating-and-managing-repositories/transferring-a-repository) from the account you want to delete to the account you want to keep. Issues, pull requests, and wikis are transferred as well. Verify the repositories exist on the account you want to keep.
1. [Update the remote URLs](/get-started/getting-started-with-git/managing-remote-repositories) in any local clones of the repositories that were moved.
1. [Update the remote URLs](/get-started/git-basics/managing-remote-repositories) in any local clones of the repositories that were moved.
1. To attribute past commits to the new account, add the email address you used to author the commits to the account you're keeping. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)
1. [Delete the account](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account) you no longer want to use.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following sections will lead you through setting up the following components
1. Create a repository to store the code for your app. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository).
1. Clone your repository from the previous step. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository). You may use a local clone or {% data variables.product.prodname_github_codespaces %}.
1. In a terminal, navigate to the directory where your clone is stored.
1. If the directory doesn't already include a `.gitignore` file, add a `.gitignore` file. You will add content to this file later. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/getting-started-with-git/ignoring-files).
1. If the directory doesn't already include a `.gitignore` file, add a `.gitignore` file. You will add content to this file later. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/git-basics/ignoring-files).

You will add more code to this repository in later steps.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ This tutorial will show you how to store the client ID and client secret in envi
1. On the app's settings page, click **Generate a new client secret**. You will add the client secret to a `.env` file in a following step.
1. Create a file called `.env` at the same level as your `Gemfile`.
1. If your project doesn't already have a `.gitignore` file, create a `.gitignore` file at the same level as your `Gemfile`.
1. Add `.env` to your `.gitignore` file. This will prevent you from accidentally committing your client secret. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/getting-started-with-git/ignoring-files).
1. Add `.env` to your `.gitignore` file. This will prevent you from accidentally committing your client secret. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/git-basics/ignoring-files).
1. Add the following contents to your `.env` file. Replace `YOUR_CLIENT_ID` with the client ID of your app. Replace `YOUR_CLIENT_SECRET` with the client secret for your app.

```text
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The following sections will lead you through setting up the following components
1. Clone your repository from the previous step. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository). You may use a local clone or {% data variables.product.prodname_github_codespaces %}.
1. In a terminal, navigate to the directory where your clone is stored.
1. Create a Ruby file named `server.rb`. This file will contain all the code for your app. You will add content to this file later.
1. If the directory doesn't already include a `.gitignore` file, add a `.gitignore` file. You will add content to this file later. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/getting-started-with-git/ignoring-files).
1. If the directory doesn't already include a `.gitignore` file, add a `.gitignore` file. You will add content to this file later. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/git-basics/ignoring-files).
1. Create a file named `Gemfile`. This file will describe the gem dependencies that your Ruby code needs. Add the following contents to your `Gemfile`:

```ruby copy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Make sure that you are on a secure machine before performing these steps since y

### Create a `.env` file

Your cloned repository includes `.env` in the `.gitignore` file. This will prevent you from accidentally committing your app's credentials. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/getting-started-with-git/ignoring-files).
Your cloned repository includes `.env` in the `.gitignore` file. This will prevent you from accidentally committing your app's credentials. For more information about `.gitignore` files, see [AUTOTITLE](/get-started/git-basics/ignoring-files).

1. Navigate to the directory where your clone of [github/github-app-js-sample](https://github.com/github/github-app-js-sample) is stored.
1. Create a file called `.env` at the top level of this directory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Before adding a new SSH key to your account on {% data variables.location.produc

You can add an SSH key and use it for authentication, or commit signing, or both. If you want to use the same SSH key for both authentication and signing, you need to upload it twice.

After adding a new SSH authentication key to your account on {% data variables.location.product_location %}, you can reconfigure any local repositories to use SSH. For more information, see [AUTOTITLE](/get-started/getting-started-with-git/managing-remote-repositories#switching-remote-urls-from-https-to-ssh).
After adding a new SSH authentication key to your account on {% data variables.location.product_location %}, you can reconfigure any local repositories to use SSH. For more information, see [AUTOTITLE](/get-started/git-basics/managing-remote-repositories#switching-remote-urls-from-https-to-ssh).

{% data reusables.ssh.key-type-support %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,15 @@ For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-a

## Authenticating with the command line

You can access repositories on {% data variables.product.github %} from the command line in two ways, HTTPS and SSH, and both have a different way of authenticating. The method of authenticating is determined based on whether you choose an HTTPS or SSH remote URL when you clone the repository. For more information about which way to access, see [AUTOTITLE](/get-started/getting-started-with-git/about-remote-repositories).
You can access repositories on {% data variables.product.github %} from the command line in two ways, HTTPS and SSH, and both have a different way of authenticating. The method of authenticating is determined based on whether you choose an HTTPS or SSH remote URL when you clone the repository. For more information about which way to access, see [AUTOTITLE](/get-started/git-basics/about-remote-repositories).

### HTTPS

You can work with all repositories on {% data variables.product.github %} over HTTPS, even if you are behind a firewall or proxy.

If you authenticate with {% data variables.product.prodname_cli %}, you can either authenticate with a {% data variables.product.pat_generic %} or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login).

If you authenticate without {% data variables.product.prodname_cli %}, you must authenticate with a {% data variables.product.pat_generic %}. {% data reusables.user-settings.password-authentication-deprecation %} Every time you use Git to authenticate with {% data variables.product.github %}, you'll be prompted to enter your credentials, unless you cache them with a [credential helper](/get-started/getting-started-with-git/caching-your-github-credentials-in-git).
If you authenticate without {% data variables.product.prodname_cli %}, you must authenticate with a {% data variables.product.pat_generic %}. {% data reusables.user-settings.password-authentication-deprecation %} Every time you use Git to authenticate with {% data variables.product.github %}, you'll be prompted to enter your credentials, unless you cache them with a [credential helper](/get-started/git-basics/caching-your-github-credentials-in-git).

### SSH

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ You can only use your password to log on to {% data variables.product.github %}

## Further reading

* [AUTOTITLE](/get-started/getting-started-with-git/caching-your-github-credentials-in-git)
* [AUTOTITLE](/get-started/git-basics/caching-your-github-credentials-in-git)
* [AUTOTITLE](/authentication/keeping-your-account-and-data-secure)
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,11 @@ Username: YOUR-USERNAME
Password: YOUR-PERSONAL-ACCESS-TOKEN
```

{% data variables.product.pat_generic_caps %}s can only be used for HTTPS Git operations. If your repository uses an SSH remote URL, you will need to [switch the remote from SSH to HTTPS](/get-started/getting-started-with-git/managing-remote-repositories#switching-remote-urls-from-ssh-to-https).
{% data variables.product.pat_generic_caps %}s can only be used for HTTPS Git operations. If your repository uses an SSH remote URL, you will need to [switch the remote from SSH to HTTPS](/get-started/git-basics/managing-remote-repositories#switching-remote-urls-from-ssh-to-https).

If you are not prompted for your username and password, your credentials may be cached on your computer. You can [update your credentials in the Keychain](/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain) to replace your old password with the token.
If you are not prompted for your username and password, your credentials may be cached on your computer. You can [update your credentials in the Keychain](/get-started/git-basics/updating-credentials-from-the-macos-keychain) to replace your old password with the token.

Instead of manually entering your {% data variables.product.pat_generic %} for every HTTPS Git operation, you can cache your {% data variables.product.pat_generic %} with a Git client. Git will temporarily store your credentials in memory until an expiry interval has passed. You can also store the token in a plain text file that Git can read before every request. For more information, see [AUTOTITLE](/get-started/getting-started-with-git/caching-your-github-credentials-in-git).
Instead of manually entering your {% data variables.product.pat_generic %} for every HTTPS Git operation, you can cache your {% data variables.product.pat_generic %} with a Git client. Git will temporarily store your credentials in memory until an expiry interval has passed. You can also store the token in a plain text file that Git can read before every request. For more information, see [AUTOTITLE](/get-started/git-basics/caching-your-github-credentials-in-git).

## Further reading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ $ ssh -vT git@{% data variables.product.product_url %}

### Use HTTPS

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:
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/git-basics/about-remote-repositories) you're using:

```shell
$ git clone https://{% data variables.product.product_url %}/USERNAME/REPO-NAME.git
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ $ ssh -T GITHUB-USERNAME@{% data variables.product.product_url %}
> Permission denied (publickey).
```

If your connection failed and you're using a remote URL with your {% data variables.product.github %} username, you can [change the remote URL to use the "git" user](/get-started/getting-started-with-git/managing-remote-repositories).
If your connection failed and you're using a remote URL with your {% data variables.product.github %} username, you can [change the remote URL to use the "git" user](/get-started/git-basics/managing-remote-repositories).

You should verify your connection by typing:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ If you [configured your SSH passphrase with the macOS keychain](/authentication/

{% windows %}

If you lose your SSH key passphrase, there's no way to recover it. You'll need to [generate a brand new SSH keypair](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) or [switch to HTTPS cloning](/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls) so you can use a {% data variables.product.pat_generic %} instead.
If you lose your SSH key passphrase, there's no way to recover it. You'll need to [generate a brand new SSH keypair](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) or [switch to HTTPS cloning](/get-started/git-basics/about-remote-repositories#cloning-with-https-urls) so you can use a {% data variables.product.pat_generic %} instead.

{% endwindows %}

{% linux %}

If you lose your SSH key passphrase, there's no way to recover it. You'll need to [generate a brand new SSH keypair](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) or [switch to HTTPS cloning](/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls) so you can use a {% data variables.product.pat_generic %} instead.
If you lose your SSH key passphrase, there's no way to recover it. You'll need to [generate a brand new SSH keypair](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) or [switch to HTTPS cloning](/get-started/git-basics/about-remote-repositories#cloning-with-https-urls) so you can use a {% data variables.product.pat_generic %} instead.

{% endlinux %}
Original file line number Diff line number Diff line change
Expand Up @@ -403,17 +403,17 @@ Because the site is dynamic, it does not build HTML files for each different ver
For example, an article that is available in currently supported versions will have permalink URLs like the following:

* `/en/get-started/getting-started-with-git/set-up-git`
* `/en/enterprise-cloud@latest/get-started/getting-started-with-git/set-up-git`
* `/en/enterprise-server@3.10/get-started/getting-started-with-git/set-up-git`
* `/en/enterprise-server@3.9/get-started/getting-started-with-git/set-up-git`
* `/en/enterprise-server@3.8/get-started/getting-started-with-git/set-up-git`
* `/en/enterprise-server@3.7/get-started/getting-started-with-git/set-up-git`
* `/en/enterprise-server@3.6/get-started/getting-started-with-git/set-up-git`
* `/en/get-started/git-basics/set-up-git`
* `/en/enterprise-cloud@latest/get-started/git-basics/set-up-git`
* `/en/enterprise-server@3.10/get-started/git-basics/set-up-git`
* `/en/enterprise-server@3.9/get-started/git-basics/set-up-git`
* `/en/enterprise-server@3.8/get-started/git-basics/set-up-git`
* `/en/enterprise-server@3.7/get-started/git-basics/set-up-git`
* `/en/enterprise-server@3.6/get-started/git-basics/set-up-git`

An article that is not available in {% data variables.product.prodname_ghe_server %} will have just one permalink:

* `/en/get-started/getting-started-with-git/set-up-git`
* `/en/get-started/git-basics/set-up-git`

> [!NOTE]
> If you are a content contributor, you don't need to worry about supported versions when adding a link to a document. Following the examples above, if you want to reference an article, you can just use its relative location: `/github/getting-started-with-github/set-up-git`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ You can create an alias for a local repository to help differentiate between rep

## Further reading

* [About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)
* [About remote repositories](/get-started/git-basics/about-remote-repositories)
Loading

0 comments on commit 4ccf89d

Please sign in to comment.