add short titles to frontmatter (#20131)
This commit is contained in:
Rachael Sewell
@@ -10,6 +10,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSO
|
||||
shortTitle: SAML single sign-on
|
||||
---
|
||||
## About authentication with SAML SSO
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- SSO
|
||||
shortTitle: PAT with SAML
|
||||
---
|
||||
You can authorize an existing personal access token, or [create a new personal access token](/github/authenticating-to-github/creating-a-personal-access-token) and then authorize it.
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- SSO
|
||||
shortTitle: SSH Key with SAML
|
||||
---
|
||||
You can authorize an existing SSH key, or create a new SSH key and then authorize it. For more information about creating a new SSH key, see "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)."
|
||||
|
||||
|
||||
@@ -15,5 +15,6 @@ children:
|
||||
- /authorizing-an-ssh-key-for-use-with-saml-single-sign-on
|
||||
- /authorizing-a-personal-access-token-for-use-with-saml-single-sign-on
|
||||
- /viewing-and-managing-your-active-saml-sessions
|
||||
shortTitle: Authenticate with SAML
|
||||
---
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- SSO
|
||||
shortTitle: Active SAML sessions
|
||||
---
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.security %}
|
||||
|
||||
@@ -10,6 +10,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Add a new SSH key
|
||||
---
|
||||
Before adding a new SSH key to your {% data variables.product.product_name %} account, you should have:
|
||||
* [Checked for existing SSH keys](/articles/checking-for-existing-ssh-keys)
|
||||
|
||||
@@ -10,6 +10,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Check for existing SSH key
|
||||
---
|
||||
{% data reusables.ssh.dsa-support %}
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Generate new SSH key
|
||||
---
|
||||
## About SSH key generation
|
||||
|
||||
|
||||
@@ -23,5 +23,6 @@ children:
|
||||
- /adding-a-new-ssh-key-to-your-github-account
|
||||
- /testing-your-ssh-connection
|
||||
- /working-with-ssh-key-passphrases
|
||||
shortTitle: Connect with SSH
|
||||
---
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Test your SSH connection
|
||||
---
|
||||
Before testing your SSH connection, you should have:
|
||||
- [Checked for existing SSH keys](/articles/checking-for-existing-ssh-keys)
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: SSH key passphrases
|
||||
---
|
||||
With SSH keys, if someone gains access to your computer, they also gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. You can use `ssh-agent` to securely save your passphrase so you don't have to reenter it.
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ topics:
|
||||
- Access management
|
||||
redirect_from:
|
||||
- /github/authenticating-to-github/about-authentication-to-github
|
||||
shortTitle: Authentication to GitHub
|
||||
---
|
||||
## About authentication to {% data variables.product.prodname_dotcom %}
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: GitHub's IP addresses
|
||||
---
|
||||
|
||||
You can retrieve a list of {% data variables.product.prodname_dotcom %}'s IP addresses from the [meta](https://api.github.com/meta) API endpoint. For more information, see "[Meta](/rest/reference/meta)."
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Third-party applications
|
||||
---
|
||||
When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested.
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Create a PAT
|
||||
---
|
||||
Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line).
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Create a strong password
|
||||
---
|
||||
You must choose or generate a password for your {% data variables.product.product_name %} account that is at least:
|
||||
- {% ifversion ghes %}Seven{% else %}Eight{% endif %} characters long, if it includes a number and a lowercase letter, or
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: SSH key fingerprints
|
||||
---
|
||||
These are {% data variables.product.prodname_dotcom %}'s public key fingerprints:
|
||||
|
||||
|
||||
@@ -28,5 +28,6 @@ children:
|
||||
- /githubs-ssh-key-fingerprints
|
||||
- /sudo-mode
|
||||
- /preventing-unauthorized-access
|
||||
shortTitle: Account security
|
||||
---
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Unauthorized access
|
||||
---
|
||||
{% data variables.product.product_name %} requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members.
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Remove sensitive data
|
||||
---
|
||||
The `git filter-branch` command and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository.
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Review OAuth apps
|
||||
---
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.access_applications %}
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Authorized integrations
|
||||
---
|
||||
## Reviewing your authorized {% data variables.product.prodname_oauth_app %}s
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Deploy keys
|
||||
---
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Security log
|
||||
---
|
||||
## Accessing your security log
|
||||
|
||||
|
||||
@@ -13,6 +13,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Update access credentials
|
||||
---
|
||||
{% ifversion not ghae %}
|
||||
## Requesting a new password
|
||||
|
||||
@@ -13,6 +13,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Commit signature verification
|
||||
---
|
||||
## About commit signature verification
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Add a new GPG key
|
||||
---
|
||||
Before adding a new GPG key to your {% data variables.product.product_name %} account, you should have:
|
||||
- [Checked for existing GPG keys](/articles/checking-for-existing-gpg-keys)
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Associate email with GPG key
|
||||
---
|
||||
{% note %}
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Existing GPG keys
|
||||
---
|
||||
{% data reusables.gpg.supported-gpg-key-algorithms %}
|
||||
|
||||
|
||||
@@ -22,5 +22,6 @@ children:
|
||||
- /associating-an-email-with-your-gpg-key
|
||||
- /signing-commits
|
||||
- /signing-tags
|
||||
shortTitle: Verify commit signatures
|
||||
---
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Tell Git your signing key
|
||||
---
|
||||
{% mac %}
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: About 2FA
|
||||
---
|
||||
For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% ifversion fpt %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your {% data variables.product.product_name %} account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone.
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: Access GitHub with 2FA
|
||||
---
|
||||
With two-factor authentication enabled, you'll need to provide an authentication code when accessing {% data variables.product.product_name %} through your browser. If you access {% data variables.product.product_name %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)."
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: Change 2FA delivery method
|
||||
---
|
||||
{% note %}
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: Configure 2FA recovery
|
||||
---
|
||||
In addition to securely storing your two-factor authentication recovery codes, we strongly recommend configuring one or more additional recovery methods.
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: Configure 2FA
|
||||
---
|
||||
You can configure two-factor authentication using a mobile app{% ifversion fpt %} or via text message{% endif %}. You can also add a security key.
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: Countries supporting SMS
|
||||
---
|
||||
If we don't support two-factor authentication via text message for your country of residence, you can set up authentication via a TOTP mobile application. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)."
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: Disable 2FA
|
||||
---
|
||||
We strongly recommend using two-factor authentication to secure your account. If you need to disable 2FA, we recommend re-enabling it as soon as possible.
|
||||
|
||||
|
||||
@@ -19,5 +19,6 @@ children:
|
||||
- /changing-two-factor-authentication-delivery-methods-for-your-mobile-device
|
||||
- /countries-where-sms-authentication-is-supported
|
||||
- /disabling-two-factor-authentication-for-your-personal-account
|
||||
shortTitle: Secure your account with 2FA
|
||||
---
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- 2FA
|
||||
shortTitle: Recover an account with 2FA
|
||||
---
|
||||
{% ifversion fpt %}
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Check verification status
|
||||
---
|
||||
## Checking your commit signature verification status
|
||||
|
||||
|
||||
@@ -15,5 +15,6 @@ children:
|
||||
- /checking-your-commit-and-tag-signature-verification-status
|
||||
- /updating-an-expired-gpg-key
|
||||
- /using-a-verified-email-address-in-your-gpg-key
|
||||
shortTitle: Troubleshoot verification
|
||||
---
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Update expired GPG key
|
||||
---
|
||||
If your key is expired, you must [update the expiration](https://www.gnupg.org/gph/en/manual/c235.html#AEN328), export the new key, delete the expired key in your GitHub account, and [upload the new key to GitHub](/articles/adding-a-new-gpg-key-to-your-github-account/). Your previous commits and tags will show as verified, as long as the key meets all other verification requirements.
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
topics:
|
||||
- Identity
|
||||
- Access management
|
||||
shortTitle: Use verified email in GPG key
|
||||
---
|
||||
{% ifversion fpt %}
|
||||
If you need to verify your GitHub email address, see "[Verifying your email address](/articles/verifying-your-email-address/)." {% endif %}If you need to update or add an email address to your GPG key, see "[Associating an email with your GPG key](/articles/associating-an-email-with-your-gpg-key)."
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Deleted or missing SSH keys
|
||||
---
|
||||
{% data variables.product.prodname_dotcom %} automatically deletes inactive SSH keys to help keep accounts safe, such as after someone leaves a job or loses a computer.
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Agent failure to sign
|
||||
---
|
||||
When trying to SSH into {% data variables.product.product_location %} on a Linux computer, you may see the following message in your terminal:
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Permission denied (publickey)
|
||||
---
|
||||
## Should the `sudo` command be used with Git?
|
||||
|
||||
|
||||
@@ -11,5 +11,6 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Permission denied other-user
|
||||
---
|
||||
To fix this, the owner of the repository (`user`) needs to add your account (`other-user`) as a collaborator on the repository or to a team that has write access to the repository.
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Permission denied other-repo
|
||||
---
|
||||
To fix this, remove the deploy key from the repository, and [add the key to your user account](/articles/adding-a-new-ssh-key-to-your-github-account) instead.
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: 'ssh-add: illegal option -- K'
|
||||
---
|
||||
The `-K` option is in Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you have installed a different version of `ssh-add`, it may lack support for `-K`.
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: SSL certificate problem
|
||||
---
|
||||
The error you receive may look like the following:
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: SSH key audit
|
||||
---
|
||||
When using an unverified key to perform Git operations, you will be prompted to perform an audit of your SSH keys.
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ versions:
|
||||
ghae: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Recover SSH key passphrase
|
||||
---
|
||||
{% mac %}
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- SSH
|
||||
shortTitle: Use SSH over HTTPS port
|
||||
---
|
||||
{% tip %}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user