1
0
mirror of synced 2025-12-30 03:01:36 -05:00

Merge branch 'main' into pwsh-commands

This commit is contained in:
Martin Lopes
2022-02-23 13:29:56 +10:00
committed by GitHub
1851 changed files with 9482 additions and 5854 deletions

3
.gitignore vendored
View File

@@ -17,6 +17,9 @@ blc_output.log
blc_output_internal.log
broken_links.md
lib/redirects/.redirects-cache.json
# This one is purely for historical reasons because so many people might
# still have thes files on their disk.
lib/redirects/.redirects-cache_*.json
# During the preview deploy untrusted user code may be cloned into this directory
# We ignore it from git to keep things deterministic

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

@@ -85,7 +85,12 @@ export const DefaultLayout = (props: Props) => {
Skip to main content
</a>
<SidebarNav />
<div className="flex-column flex-1 overflow-auto">
{/* Need to set an explicit height for sticky elements since we also
set overflow to auto */}
<div
className="flex-column flex-1 overflow-auto print-overflow-visible"
style={{ height: '100vh' }}
>
<Header />
<main id="main-content">
<DeprecationBanner />

View File

@@ -1,9 +1,9 @@
import { useRouter } from 'next/router'
import { ArrowRightIcon } from '@primer/octicons-react'
import { ArrowRightIcon, InfoIcon } from '@primer/octicons-react'
import { Link } from 'components/Link'
import { useMainContext } from 'components/context/MainContext'
import { useVersion } from 'components/hooks/useVersion'
import { DEFAULT_VERSION, useVersion } from 'components/hooks/useVersion'
import { useTranslation } from 'components/hooks/useTranslation'
import { Picker } from 'components/ui/Picker'
@@ -17,7 +17,7 @@ export const VersionPicker = ({ variant }: Props) => {
const { allVersions, page, enterpriseServerVersions } = useMainContext()
const { t } = useTranslation(['pages', 'picker'])
if (page.permalinks && page.permalinks.length <= 1) {
if (page.permalinks && page.permalinks.length < 1) {
return null
}
@@ -37,7 +37,7 @@ export const VersionPicker = ({ variant }: Props) => {
item: (
<Link
href={`/${router.locale}/${enterpriseServerVersions[0]}/admin/all-releases`}
className="f6 no-underline color-fg-muted"
className="f6 no-underline"
>
{t('all_enterprise_releases')}{' '}
<ArrowRightIcon verticalAlign="middle" size={15} className="mr-2" />
@@ -46,6 +46,23 @@ export const VersionPicker = ({ variant }: Props) => {
})
}
if (allLinks) {
const currentVersionPathSegment = currentVersion === DEFAULT_VERSION ? '' : `/${currentVersion}`
allLinks.push({
text: t('docs_versions'),
selected: false,
item: (
<Link
href={`/${router.locale}${currentVersionPathSegment}/get-started/learning-about-github/about-versions-of-github-docs`}
className="f6 no-underline"
>
{t('about_versions')} <InfoIcon verticalAlign="middle" size={15} className="mr-2" />
</Link>
),
})
}
return (
<Picker
variant={variant}

View File

@@ -36,7 +36,7 @@ When you sign up for an account, {% data variables.product.product_name %} provi
### Setting a profile picture
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
2. Under **Profile Picture**, click {% octicon "pencil" aria-label="The edit icon" %} **Edit**.
![Edit profile picture](/assets/images/help/profile/edit-profile-photo.png)
3. Click **Upload a photo...**.
@@ -46,7 +46,7 @@ When you sign up for an account, {% data variables.product.product_name %} provi
### Resetting your profile picture to the identicon
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
2. Under **Profile Picture**, click {% octicon "pencil" aria-label="The edit icon" %} **Edit**.
![Edit profile picture](/assets/images/help/profile/edit-profile-photo.png)
3. To revert to your identicon, click **Remove photo**. If your email address is associated with a [Gravatar](https://en.gravatar.com/), you cannot revert to your identicon. Click **Revert to Gravatar** instead.
@@ -64,7 +64,7 @@ You can change the name that is displayed on your profile. This name may also be
{% endnote %}
{% endif %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
2. Under "Name", type the name you want to be displayed on your profile.
![Name field in profile settings](/assets/images/help/profile/name-field.png)
@@ -85,7 +85,7 @@ For a longer-form and more prominent way of displaying customized information ab
{% endnote %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
2. Under **Bio**, add the content that you want displayed on your profile. The bio field is limited to 160 characters.
![Update bio on profile](/assets/images/help/profile/bio-field.png)
@@ -148,7 +148,7 @@ When you participate in certain programs, {% data variables.product.prodname_dot
You can disable some of the badges for {% data variables.product.prodname_dotcom %} programs you're participating in, including the PRO, {% data variables.product.prodname_arctic_vault %} and Mars 2020 Helicopter Contributor badges.
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
2. Under "Profile settings", deselect the badge you want you disable.
![Checkbox to no longer display a badge on your profile](/assets/images/help/profile/profile-badge-settings.png)
3. Click **Update preferences**.

View File

@@ -29,11 +29,11 @@ To request access to manage repositories as a successor, contact [GitHub Support
## Inviting a successor
The person you invite to be your successor must have a {% data variables.product.company_short %} account.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.account_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.account_settings %}
3. Under "Successor settings", to invite a successor, begin typing a username, full name, or email address, then click their name when it appears.
![Successor invitation search field](/assets/images/help/settings/settings-invite-successor-search-field.png)
4. Click **Add successor**.
{% data reusables.user_settings.sudo-mode-popup %}
{% data reusables.user-settings.sudo-mode-popup %}
5. The user you've invited will be listed as "Pending" until they agree to become your successor.
![Pending successor invitation](/assets/images/help/settings/settings-pending-successor.png)

View File

@@ -19,7 +19,7 @@ topics:
- Repositories
shortTitle: Remove yourself
---
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
2. In the "Code, planning, and automation" section of the sidebar, click **{% octicon "repo" aria-label="The repo icon" %} Repositories**.
{% else %}

View File

@@ -19,17 +19,17 @@ shortTitle: Add an email address
{% note %}
**Notes**:
- {% data reusables.user_settings.no-verification-disposable-emails %}
- {% data reusables.user-settings.no-verification-disposable-emails %}
- If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you cannot make changes to your email address on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.emu-more-info-account %}
{% endnote %}
{% endif %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.emails %}
{% data reusables.user_settings.add_and_verify_email %}
{% data reusables.user_settings.select_primary_email %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.emails %}
{% data reusables.user-settings.add_and_verify_email %}
{% data reusables.user-settings.select_primary_email %}
## Further reading

View File

@@ -15,11 +15,11 @@ shortTitle: Block push with personal email
---
When you push commits from the command line, the email address that you've [set in Git](/articles/setting-your-commit-email-address) is associated with your commits. If you enable this setting, each time you push to GitHub, well check the most recent commit. If the author email on that commit is a private email on your GitHub account, we will block the push and warn you about exposing your private email.
{% data reusables.user_settings.about-commit-email-addresses %}
{% data reusables.user-settings.about-commit-email-addresses %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.emails %}
{% data reusables.user_settings.keeping_your_email_address_private %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.emails %}
{% data reusables.user-settings.keeping_your_email_address_private %}
4. To keep your email address private in commits you push from the command line, select **Block command line pushes that expose my email**.
![Option to block command line pushes that expose your emails](/assets/images/help/settings/email_privacy_block_command_line_pushes.png)

View File

@@ -20,8 +20,8 @@ shortTitle: Primary email address
{% endnote %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.emails %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.emails %}
3. If you'd like to add a new email address to set as your primary email address, under "Add email address", type a new email address and click **Add**.
![Add another email address button](/assets/images/help/settings/add_another_email_address.png)
4. Under "Primary email address", use the drop-down menu to click the email address you'd like to set as your primary email address, and click **Save**.

View File

@@ -21,8 +21,8 @@ shortTitle: Marketing emails
{% endtip %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.emails %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.emails %}
3. Under *Email preferences*, select **Only receive account related emails, and those I subscribe to**.
![Screenshot of opting out of marketing email](/assets/images/help/notifications/email_preferences.png)
4. Click **Save email preferences**.

View File

@@ -15,8 +15,8 @@ topics:
- Notifications
shortTitle: Set backup email address
---
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.emails %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.emails %}
3. Under "Backup email address," select the address you want to set as your backup email address using the drop-down menu.
![Backup email address](/assets/images/help/settings/backup-email-address.png)
4. Click **Save**.

View File

@@ -34,7 +34,7 @@ For web-based Git operations, you can set your commit email address on {% ifvers
{% note %}
**Note**: {% data reusables.user_settings.no-verification-disposable-emails %}
**Note**: {% data reusables.user-settings.no-verification-disposable-emails %}
{% endnote %}
@@ -60,11 +60,11 @@ If you use your `noreply` email address for {% data variables.product.product_na
{% data reusables.files.commit-author-email-options %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.emails %}
{% data reusables.user_settings.add_and_verify_email %}
{% data reusables.user_settings.select_primary_email %}{% ifversion fpt or ghec %}
{% data reusables.user_settings.keeping_your_email_address_private %}{% endif %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.emails %}
{% data reusables.user-settings.add_and_verify_email %}
{% data reusables.user-settings.select_primary_email %}{% ifversion fpt or ghec %}
{% data reusables.user-settings.keeping_your_email_address_private %}{% endif %}
## Setting your commit email address in Git
@@ -73,16 +73,16 @@ You can use the `git config` command to change the email address you associate w
### Setting your email address for every repository on your computer
{% data reusables.command_line.open_the_multi_os_terminal %}
2. {% data reusables.user_settings.set_your_email_address_in_git %}
2. {% data reusables.user-settings.set_your_email_address_in_git %}
```shell
$ git config --global user.email "<em>email@example.com</em>"
```
3. {% data reusables.user_settings.confirm_git_email_address_correct %}
3. {% data reusables.user-settings.confirm_git_email_address_correct %}
```shell
$ git config --global user.email
<span class="output">email@example.com</span>
```
4. {% data reusables.user_settings.link_email_with_your_account %}
4. {% data reusables.user-settings.link_email_with_your_account %}
### Setting your email address for a single repository
@@ -92,13 +92,13 @@ You can change the email address associated with commits you make in a single re
{% data reusables.command_line.open_the_multi_os_terminal %}
2. Change the current working directory to the local repository where you want to configure the email address that you associate with your Git commits.
3. {% data reusables.user_settings.set_your_email_address_in_git %}
3. {% data reusables.user-settings.set_your_email_address_in_git %}
```shell
$ git config user.email "<em>email@example.com</em>"
```
4. {% data reusables.user_settings.confirm_git_email_address_correct %}
4. {% data reusables.user-settings.confirm_git_email_address_correct %}
```shell
$ git config user.email
<span class="output">email@example.com</span>
```
5. {% data reusables.user_settings.link_email_with_your_account %}
5. {% data reusables.user-settings.link_email_with_your_account %}

View File

@@ -74,8 +74,8 @@ After changing your username, links to your previous profile page, such as `http
## Changing your username
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.account_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.account_settings %}
3. In the "Change username" section, click **Change username**.
![Change Username button](/assets/images/help/settings/settings-change-username.png){% ifversion fpt or ghec %}
4. Read the warnings about changing your username. If you still want to change your username, click **I understand, let's change my username**.

View File

@@ -45,8 +45,8 @@ You can also convert your personal user account directly into an organization. C
1. Create a new personal account, which you'll use to sign into GitHub and access the organization and your repositories after you convert.
2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the user account you're converting has joined.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.organizations %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.organizations %}
5. Under "Transform account", click **Turn <username> into an organization**.
![Organization conversion button](/assets/images/help/settings/convert-to-organization.png)
6. In the Account Transformation Warning dialog box, review and confirm the conversion. Note that the information in this box is the same as the warning at the top of this article.

View File

@@ -37,8 +37,8 @@ Before you delete your user account, make a copy of all repositories, private fo
## Delete your user account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.account_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.account_settings %}
3. At the bottom of the Account Settings page, under "Delete account", click **Delete your account**. Before you can delete your user account:
- If you're the only owner in the organization, you must transfer ownership to another person or delete your organization.
- If there are other organization owners in the organization, you must remove yourself from the organization.

View File

@@ -10,8 +10,8 @@ versions:
ghae: '*'
shortTitle: Integrate Jira with projects
---
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.developer_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.oauth_apps %}
1. Click **Register a new application**.
2. Under **Application name**, type "Jira".
@@ -21,7 +21,7 @@ shortTitle: Integrate Jira with projects
![Register application button](/assets/images/help/oauth/register-application-button.png)
8. Under **Developer applications**, note the "Client ID" and "Client Secret" values.
![Client ID and Client Secret](/assets/images/help/oauth/client-id-and-secret.png)
{% data reusables.user_settings.jira_help_docs %}
{% data reusables.user-settings.jira_help_docs %}
## Further reading

View File

@@ -13,8 +13,8 @@ All keyboard shortcuts are enabled by default on {% data variables.product.produ
## Managing character key shortcuts
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.accessibility_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.accessibility_settings %}
1. Select or deselect the **Enable character key shortcuts** checkbox.
![Screenshot of the 'Enable character key shortcuts' checkbox](/assets/images/help/settings/disable-character-key-shortcuts.png)
2. Click **Save**.

View File

@@ -28,8 +28,8 @@ For an overview of repository-level security, see "[Securing your repository](/c
## Enabling or disabling features for existing repositories
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security-analysis %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security-analysis %}
3. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**.
{% ifversion ghes > 3.2 %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/enterprise/3.3/settings/security-and-analysis-disable-or-enable-all.png){% else %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/settings/security-and-analysis-disable-or-enable-all.png){% endif %}
6. Optionally, enable the feature by default for new repositories that you own.
@@ -41,8 +41,8 @@ For an overview of repository-level security, see "[Securing your repository](/c
## Enabling or disabling features for new repositories
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security-analysis %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security-analysis %}
3. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories that you own.
{% ifversion ghes > 3.2 %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% else %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% endif %}

View File

@@ -21,8 +21,8 @@ When you create a new repository on {% data variables.product.product_location %
## Setting the default branch name
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.repo-tab %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.repo-tab %}
3. Under "Repository default branch", click **Change default branch name now**.
![Override button](/assets/images/help/settings/repo-default-name-button.png)
4. Type the default name that you would like to use for new branches.

View File

@@ -13,7 +13,7 @@ shortTitle: Managing your tab size
If you feel that tabbed indentation in code rendered on {% data variables.product.product_name %} takes up too much, or too little space, you can change this in your settings.
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
1. In the left sidebar, click **{% octicon "paintbrush" aria-label="The paintbrush icon" %} Appearance**.
2. Under "Tab size preference", select the drop-down menu and choose your preference.
![Tab size preference button](/assets/images/help/settings/tab-size-preference.png )

View File

@@ -28,8 +28,8 @@ You may want to use a dark theme to reduce power consumption on certain devices,
{% endif %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.appearance-settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.appearance-settings %}
1. Under "Theme mode", select the drop-down menu, then click a theme preference.

View File

@@ -23,6 +23,6 @@ The [GitHub Jobs](https://jobs.github.com/) board is a great way to find employm
![GitHub Jobs ads on the dashboard](/assets/images/help/settings/jobs-ads-on-dashboard.png)
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
2. Under Jobs Profile, select **Available for hire**, then click **Save jobs profile**.
![Jobs profile settings](/assets/images/help/settings/jobs-profile-settings.png)

View File

@@ -23,4 +23,4 @@ topics:
{% endtip %}
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}

View File

@@ -23,7 +23,7 @@ You can set scheduled reminders for personal or team-level review requests for p
## Creating scheduled reminders for your user account
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to schedule reminders for, click **Edit**.
![Scheduled reminders edit button](/assets/images/help/settings/scheduled-reminders-org-choice.png)
@@ -40,7 +40,7 @@ You can set scheduled reminders for personal or team-level review requests for p
{% data reusables.reminders.create-reminder %}
## Managing scheduled reminders for your user account
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to edit scheduled reminders for, click **Edit**.
![Scheduled reminders edit button](/assets/images/help/settings/scheduled-reminders-org-choice.png)
@@ -48,7 +48,7 @@ You can set scheduled reminders for personal or team-level review requests for p
{% data reusables.reminders.update-buttons %}
## Deleting scheduled reminders for your user account
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to delete reminders for, click **Edit**.
![Scheduled reminders edit button](/assets/images/help/settings/scheduled-reminders-org-choice.png)

View File

@@ -20,7 +20,7 @@ shortTitle: Show or hide membership
## Changing the visibility of your organization membership
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.people %}
4. Locate your username in the list of members. If the list is large, you can search for your username in the search box.
![Organization member search box](/assets/images/help/organizations/member-search-box.png)

View File

@@ -27,7 +27,7 @@ For more information, see "[Transferring organization ownership](/articles/trans
{% endif %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.organizations %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.organizations %}
3. Under "Organizations", find the organization you'd like to remove yourself from, then click **Leave**.
![Leave organization button with roles shown](/assets/images/help/organizations/context-leave-organization-with-roles-shown.png)

View File

@@ -16,9 +16,9 @@ shortTitle: Request OAuth App approval
---
## Requesting organization approval for an {% data variables.product.prodname_oauth_app %} you've already authorized for your personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.access_applications %}
{% data reusables.user_settings.access_authorized_oauth_apps %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.access_applications %}
{% data reusables.user-settings.access_authorized_oauth_apps %}
3. In the list of applications, click the name of the {% data variables.product.prodname_oauth_app %} you'd like to request access for.
![View application button](/assets/images/help/settings/settings-third-party-view-app.png)
4. Next to the organization you'd like the {% data variables.product.prodname_oauth_app %} to access, click **Request access**.

View File

@@ -20,7 +20,7 @@ shortTitle: View people in an organization
## View organization roles
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.people %}
4. You will see a list of the people in your organization. To filter the list by role, click **Role** and select the role you're searching for.
![click-role](/assets/images/help/organizations/view-list-of-people-in-org-by-role.png)
@@ -55,7 +55,7 @@ To review all roles in an organization, see "[Roles in an organization](/organiz
For more information about the enterprise owner role, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)."
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.people %}
4. In the left sidebar, under "Enterprise permissions", click **Enterprise owners**.
![Screenshot of "Enterprise owners" option in sidebar menu](/assets/images/help/organizations/enterprise-owners-sidebar.png)

View File

@@ -479,11 +479,39 @@ The background color of the badge. Can be one of: `white`, `yellow`, `blue`, `gr
### `branding.icon`
The name of the [Feather](https://feathericons.com/) icon to use.
The name of the v4.28.0 [Feather](https://feathericons.com/) icon to use. Brand icons are omitted as well as the following:
<table>
<tr>
<td>coffee</td>
<td>columns</td>
<td>divide-circle</td>
<td>divide-square</td>
</tr>
<tr>
<td>divide</td>
<td>frown</td>
<td>hexagon</td>
<td>key</td>
</tr>
<tr>
<td>meh</td>
<td>mouse-pointer</td>
<td>smile</td>
<td>tool</td>
</tr>
<tr>
<td>x-octagon</td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
Here is an exhaustive list of all currently supported icons:
<!--
This table should match the icon list in `app/models/repository_actions/icons.rb` in the internal github repo.
This table does not match the latest version the feather library.
(Brand icons are omitted, and our supported list is not necessarily up-to-date with the latest version of the feather icon library.)
To support a new icon, update `app/models/repository_actions/icons.rb` and add the svg to `/static/images/icons/feather` in the internal github repo.
-->

View File

@@ -86,7 +86,7 @@ The following table shows the permissions granted to the `GITHUB_TOKEN` by defau
| checks | read/write | none | read |
| contents | read/write | read | read |
| deployments | read/write | none | read |{% ifversion fpt or ghec %}
| id-token | read/write | none | read |{% endif %}
| id-token | none | none | read |{% endif %}
| issues | read/write | none | read |
| metadata | read | read | read |
| packages | read/write | none | read |

View File

@@ -141,6 +141,16 @@ In this example, the attempted script injection is unsuccessful:
With this approach, the value of the {% raw %}`${{ github.event.issue.title }}`{% endraw %} expression is stored in memory and used as a variable, and doesn't interact with the script generation process. In addition, consider using double quote shell variables to avoid [word splitting](https://github.com/koalaman/shellcheck/wiki/SC2086), but this is [one of many](https://mywiki.wooledge.org/BashPitfalls) general recommendations for writing shell scripts, and is not specific to {% data variables.product.prodname_actions %}.
{% ifversion fpt or ghec %}
### Using starter workflows for code scanning
{% data reusables.advanced-security.starter-workflows-beta %}
{% data variables.product.prodname_code_scanning_capc %} allows you to find security vulnerabilities before they reach production. {% data variables.product.product_name %} provides starter workflows for {% data variables.product.prodname_code_scanning %}. You can use these suggested workflows to construct your {% data variables.product.prodname_code_scanning %} workflows, instead of starting from scratch. {% data variables.product.company_short%}'s workflow, the {% data variables.product.prodname_codeql_workflow %}, is powered by {% data variables.product.prodname_codeql %}. There are also third-party starter workflows available.
For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[Setting up {% data variables.product.prodname_code_scanning %} using starter workflows](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository#setting-up-code-scanning-using-starter-workflows)."
{% endif %}
### Restricting permissions for tokens
To help mitigate the risk of an exposed token, consider restricting the assigned permissions. For more information, see "[Modifying the permissions for the GITHUB_TOKEN](/actions/reference/authentication-in-a-workflow#modifying-the-permissions-for-the-github_token)."

View File

@@ -24,6 +24,8 @@ topics:
{% data reusables.actions.workflow-organization-templates %}
{% data reusables.actions.starter-workflow-categories %}
## Creating a starter workflow
Starter workflows can be created by users with write access to the organization's `.github` repository. These can then be used by organization members who have permission to create workflows.

View File

@@ -63,7 +63,7 @@ The assignment of {% data variables.product.prodname_dotcom %}-hosted runners is
{% endif %}
Called workflows can access self-hosted runners from caller's context. This means that a called workflow can access self-hosted runners that are:
Called workflows that are owned by the same user or organization{% ifversion ghes or ghec or ghae %} or enterprise{% endif %} as the caller workflow can access self-hosted runners from the caller's context. This means that a called workflow can access self-hosted runners that are:
* In the caller repository
* In the caller repository's organization{% ifversion ghes or ghec or ghae %} or enterprise{% endif %}, provided that the runner has been made available to the caller repository

View File

@@ -28,6 +28,8 @@ topics:
{% data variables.product.product_name %} offers starter workflows for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a starter workflow file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant starter workflows.{% endif %}
{% data reusables.actions.starter-workflow-categories %}
You can also create your own starter workflow to share with your organization. These starter workflows will appear alongside the {% data variables.product.product_name %}-provided starter workflows. For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)."
## Using starter workflows

View File

@@ -0,0 +1,56 @@
---
title: Generating a Health Check for your enterprise
intro: 'You can gain insight into the general health and Git and API requests of {% data variables.product.product_location %} by generating a Health Check.'
versions:
ghes: '*'
type: how_to
topics:
- Enterprise
- Fundamentals
- Infrastructure
- Monitoring
- Performance
product: '{% data reusables.gated-features.generated-health-checks %}'
---
{% note %}
**Note:** Generating a Health Check is currently in beta for {% data variables.product.prodname_ghe_server %} and subject to change.
{% endnote %}
## About generated Health Checks
You can create a support bundle for {% data variables.product.product_location %} that contains a lot of data, such as diagnostics and log files. To help analyze and interpret this data, you can generate a Health Check. For more information about support bundles, see "[Providing data to {% data variables.contact.github_support %}](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)."
A Health Check provides the following information about {% data variables.product.product_location %}.
- Insights into the general health of {% data variables.product.product_location %}, such as upgrade status, storage, and license seat consumption
- A security section, which focuses on subdomain isolation and user authentication
- Analysis of Git requests, with details about the busiest repositories and Git users
- Analysis of API requests, including the busiest times, most frequently requested endpoints, and most active callers
## Generating a Health Check
Before you can generate a Health Check, you must create a support bundle. For more information, see "[Providing data to {% data variables.contact.github_support %}](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)."
1. Navigate to the [{% data variables.contact.support_portal %}](https://support.github.com/).
2. In the upper-right corner of the page, click **Premium**.
![Screenshot of the "Premium" link in the GitHub Support Portal header.](/assets/images/enterprise/support/support-portal-header-premium.png)
3. To the right of **Health Checks**, click **Request Health Check**.
![Screenshot of the "Request Health Check" button.](/assets/images/enterprise/support/support-portal-request-health-check.png)
4. Under "Select an enterprise account", select the dropdown menu and click an enterprise account.
![Screenshot of the "enterprise account" dropdown menu.](/assets/images/enterprise/support/health-check-dialog-ea.png)
5. Under "Upload a support bundle", click **Chose File** and choose a file to upload. Then, click **Request Health Check**.
![Screenshot of the "Choose file" and "Request Health Check" buttons.](/assets/images/enterprise/support/health-check-dialog-choose-file.png)
After you request a Health Check, a job is scheduled to generate the Health Check. After several hours to one day, the generated Health Check will appear in the "Health Checks" section of the {% data variables.contact.support_portal %}.
![Screenshot of the Health Checks section of the {% data variables.contact.support_portal %}.](/assets/images/enterprise/support/support-portal-health-checks-section.png)

View File

@@ -16,5 +16,6 @@ children:
- /setting-up-external-monitoring
- /configuring-collectd
- /monitoring-using-snmp
- /generating-a-health-check-for-your-enterprise
---

View File

@@ -65,7 +65,7 @@ When you push an Okta group and map the group to a team, all of the group's memb
You can map a team in your enterprise to an Okta group you previously pushed to {% data variables.product.prodname_ghe_managed %}. Members of the Okta group will then automatically becomes members of the {% data variables.product.prodname_ghe_managed %} team. Any subsequent changes to the Okta group's membership are automatically synchronized with the {% data variables.product.prodname_ghe_managed %} team.
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.specific_team %}
{% data reusables.organizations.team_settings %}
6. Under "Identity Provider Group", select the drop-down menu and click an identity provider group.

View File

@@ -36,10 +36,10 @@ To configure provisioning for your {% data variables.product.prodname_emu_enterp
{% endwarning %}
1. Sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user for your new enterprise with the username **@<em>SHORT-CODE</em>_admin**.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.developer_settings %}
{% data reusables.user_settings.personal_access_tokens %}
{% data reusables.user_settings.generate_new_token %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.personal_access_tokens %}
{% data reusables.user-settings.generate_new_token %}
1. Under **Note**, give your token a descriptive name.
![Screenshot showing the token's name](/assets/images/help/enterprises/emu-pat-name.png)
1. Select the **Expiration** drop-down menu, then click **No expiration**.

View File

@@ -37,7 +37,7 @@ To manage repository access for any team in your enterprise, including teams con
Any member of an organization can create a new team and connect the team to an IdP group.
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.new_team %}
{% data reusables.organizations.team_name %}
{% data reusables.organizations.team_description %}

View File

@@ -25,7 +25,7 @@ Each team has its own individually defined [access permissions for repositories
## Setting up a team
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.specific_team %}
{% data reusables.organizations.invite_to_team %}
{% data reusables.organizations.review-team-repository-access %}

View File

@@ -25,7 +25,7 @@ Organizations can create multiple levels of nested teams to reflect a company or
A prudent combination of teams is a powerful way to control repository access. For example, if your organization allows only your release engineering team to push code to the default branch of any repository, you could give only the release engineering team **admin** permissions to your organization's repositories and give all other teams **read** permissions.
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.new_team %}
{% data reusables.organizations.team_name %}
{% data reusables.organizations.team_description %}
@@ -54,7 +54,7 @@ You must be a site admin and an organization owner to create a team with LDAP sy
1. Ensure that [LDAP Sync is enabled](/enterprise/admin/authentication/using-ldap#enabling-ldap-sync).
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.new_team %}
{% data reusables.organizations.team_name %}
6. Search for an LDAP group's DN to map the team to. If you don't know the DN, type the LDAP group's name. {% data variables.product.prodname_ghe_server %} will search for and autocomplete any matches.

View File

@@ -38,7 +38,7 @@ To remove an existing member of a team synced to an LDAP group, contact your LDA
{% endif %}
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.specific_team %}
4. Select the person or people you'd like to remove.
![Check box next to organization member](/assets/images/help/teams/team-member-check-box.png)
@@ -48,7 +48,7 @@ To remove an existing member of a team synced to an LDAP group, contact your LDA
## Removing a user from an organization
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.people %}
4. Next to the name of the users you want to remove from the organization, click the check box.
![Remove user checkbox](/assets/images/help/organizations/Organization-remove-user.png)

View File

@@ -16,9 +16,9 @@ You can authorize an existing personal access token, or [create a new personal a
{% data reusables.saml.authorized-creds-info %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.developer_settings %}
{% data reusables.user_settings.personal_access_tokens %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.personal_access_tokens %}
3. Next to the token you'd like to authorize, click **Configure SSO**.
![Screenshot of the dropdown menu to configure SSO for a personal access token](/assets/images/help/settings/sso-allowlist-button.png)
4. To the right of the organization you'd like to authorize the token for, click **Authorize**.

View File

@@ -22,8 +22,8 @@ You can authorize an existing SSH key, or create a new SSH key and then authoriz
{% endnote %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
3. Next to the SSH key you'd like to authorize, click **Enable SSO** or **Disable SSO**.
![SSO token authorize button](/assets/images/help/settings/ssh-sso-button.png)
4. Find the organization you'd like to authorize the SSH key for.

View File

@@ -11,8 +11,8 @@ topics:
- SSO
shortTitle: Active SAML sessions
---
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
3. Under "Sessions," you can see your active SAML sessions.
![List of active SAML sessions](/assets/images/help/settings/saml-active-sessions.png)
4. To see the session details, click **See more**.

View File

@@ -41,8 +41,8 @@ After adding a new SSH key to your account on {% ifversion ghae %}{% data variab
{% endtip %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
4. Click **New SSH key** or **Add SSH key**.
![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png)
5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".
@@ -50,7 +50,7 @@ After adding a new SSH key to your account on {% ifversion ghae %}{% data variab
![The key field](/assets/images/help/settings/ssh-key-paste.png)
7. Click **Add SSH key**.
![The Add key button](/assets/images/help/settings/ssh-add-key.png)
{% data reusables.user_settings.sudo-mode-popup %}
{% data reusables.user-settings.sudo-mode-popup %}
{% endwebui %}
@@ -75,8 +75,8 @@ After adding a new SSH key to your account on {% ifversion ghae %}{% data variab
{% endtip %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
4. Click **New SSH key** or **Add SSH key**.
![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png)
5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".
@@ -111,8 +111,8 @@ After adding a new SSH key to your account on {% ifversion ghae %}{% data variab
{% endtip %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
4. Click **New SSH key** or **Add SSH key**.
![SSH Key button](/assets/images/help/settings/ssh-add-ssh-key.png)
5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".

View File

@@ -64,7 +64,7 @@ You can work with all repositories on {% data variables.product.product_name %}
If you authenticate with {% data variables.product.prodname_cli %}, you can either authenticate with a personal access token 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 personal access token. {% data reusables.user_settings.password-authentication-deprecation %} Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your credentials to authenticate with {% data variables.product.product_name %}, unless you cache them a [credential helper](/github/getting-started-with-github/caching-your-github-credentials-in-git).
If you authenticate without {% data variables.product.prodname_cli %}, you must authenticate with a personal access token. {% data reusables.user-settings.password-authentication-deprecation %} Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your credentials to authenticate with {% data variables.product.product_name %}, unless you cache them a [credential helper](/github/getting-started-with-github/caching-your-github-credentials-in-git).
### SSH

View File

@@ -35,7 +35,7 @@ When an {% data variables.product.prodname_oauth_app %} wants to identify you by
{% tip %}
**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %}
**Tip:** {% data reusables.user-settings.review_oauth_tokens_tip %}
{% endtip %}

View File

@@ -54,7 +54,7 @@ There are several types of data that applications can request.
{% tip %}
**Tip:** {% data reusables.user_settings.review_oauth_tokens_tip %}
**Tip:** {% data reusables.user-settings.review_oauth_tokens_tip %}
{% endtip %}

View File

@@ -30,17 +30,17 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti
{% ifversion fpt or ghec %}If you want to use a PAT to access resources owned by an organization that uses SAML SSO, you must authorize the PAT. For more information, see "[About authentication with SAML single sign-on](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)" and "[Authorizing a personal access token for use with SAML single sign-on](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}{% endif %}
{% ifversion fpt or ghec %}{% data reusables.user_settings.removes-personal-access-tokens %}{% endif %}
{% ifversion fpt or ghec %}{% data reusables.user-settings.removes-personal-access-tokens %}{% endif %}
A token with no assigned scopes can only access public information. To use your token to access repositories from the command line, select `repo`. For more information, see "[Available scopes](/apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)".
## Creating a token
{% ifversion fpt or ghec %}1. [Verify your email address](/github/getting-started-with-github/verifying-your-email-address), if it hasn't been verified yet.{% endif %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.developer_settings %}
{% data reusables.user_settings.personal_access_tokens %}
{% data reusables.user_settings.generate_new_token %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.personal_access_tokens %}
{% data reusables.user-settings.generate_new_token %}
5. Give your token a descriptive name.
![Token description field](/assets/images/help/settings/token_description.png){% ifversion fpt or ghes > 3.2 or ghae-issue-4374 or ghec %}
6. To give your token an expiration, select the **Expiration** drop-down menu, then click a default or use the calendar picker.

View File

@@ -30,7 +30,7 @@ To keep your account secure, we recommend you follow these best practices:
You can only use your password to log on to {% data variables.product.product_name %} using your browser. When you authenticate to {% data variables.product.product_name %} with other means, such as the command line or API, you should use other credentials. For more information, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)."
{% ifversion fpt or ghec %}{% data reusables.user_settings.password-authentication-deprecation %}{% endif %}
{% ifversion fpt or ghec %}{% data reusables.user-settings.password-authentication-deprecation %}{% endif %}
## Further reading

View File

@@ -15,10 +15,10 @@ topics:
- Access management
shortTitle: Review OAuth apps
---
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.access_applications %}
{% data reusables.user_settings.access_authorized_oauth_apps %}
{% data reusables.user_settings.review-oauth-apps %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.access_applications %}
{% data reusables.user-settings.access_authorized_oauth_apps %}
{% data reusables.user-settings.review-oauth-apps %}
## Further reading
{% ifversion fpt or ghec %}

View File

@@ -17,15 +17,15 @@ shortTitle: Authorized integrations
---
## Reviewing your authorized {% data variables.product.prodname_oauth_apps %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.access_applications %}
{% data reusables.user_settings.access_authorized_oauth_apps %}
{% data reusables.user_settings.review-oauth-apps %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.access_applications %}
{% data reusables.user-settings.access_authorized_oauth_apps %}
{% data reusables.user-settings.review-oauth-apps %}
## Reviewing your authorized {% data variables.product.prodname_github_apps %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.access_applications %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.access_applications %}
3. Click the **Authorized {% data variables.product.prodname_github_apps %}** tab.
![Authorized {% data variables.product.prodname_github_apps %} tab](/assets/images/help/settings/settings-authorized-github-apps-tab.png)
3. Review the {% data variables.product.prodname_github_apps %} that have access to your account. For those that you don't recognize or that are out of date, click **Revoke**. To revoke all {% data variables.product.prodname_github_apps %}, click **Revoke all**.

View File

@@ -20,7 +20,7 @@ shortTitle: Security log
The security log lists all actions performed within the last 90 days.
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
1. In the "Archives" section of the sidebar, click **{% octicon "log" aria-label="The log icon" %} Security log**.
{% else %}

View File

@@ -20,8 +20,8 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
{% mac %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
3. On the SSH Settings page, take note of the SSH keys associated with your account. For those that you don't recognize, or that are out-of-date, click **Delete**. If there are valid SSH keys you'd like to keep, click **Approve**.
![SSH key list](/assets/images/help/settings/settings-ssh-key-review.png)
@@ -47,8 +47,8 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
{% windows %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
3. On the SSH Settings page, take note of the SSH keys associated with your account. For those that you don't recognize, or that are out-of-date, click **Delete**. If there are valid SSH keys you'd like to keep, click **Approve**.
![SSH key list](/assets/images/help/settings/settings-ssh-key-review.png)
@@ -76,8 +76,8 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
{% linux %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
3. On the SSH Settings page, take note of the SSH keys associated with your account. For those that you don't recognize, or that are out-of-date, click **Delete**. If there are valid SSH keys you'd like to keep, click **Approve**.
![SSH key list](/assets/images/help/settings/settings-ssh-key-review.png)

View File

@@ -41,8 +41,8 @@ To avoid losing your password in the future, we suggest using a secure password
{% data reusables.repositories.blocked-passwords %}
1. {% data variables.product.signin_link %} to {% data variables.product.product_name %}.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
4. Under "Change password", type your old password, a strong new password, and confirm your new password. For help creating a strong password, see "[Creating a strong password](/articles/creating-a-strong-password)"
5. Click **Update password**.

View File

@@ -25,8 +25,8 @@ When verifying a signature, we extract the signature and attempt to parse its ke
## Adding a GPG key
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
3. Click **New GPG key**.
![GPG Key button](/assets/images/help/settings/gpg-add-gpg-key.png)
4. In the "Key" field, paste the GPG key you copied when you [generated your GPG key](/articles/generating-a-new-gpg-key).

View File

@@ -32,8 +32,8 @@ You should only enable vigilant mode if you sign all of your commits and tags an
## Enabling vigilant mode
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
3. On the SSH Settings page, under "Vigilant mode," select **Flag unsigned commits as unverified**.
![Flag unsigned commits as unverified checkbox](/assets/images/help/commits/vigilant-mode-checkbox.png)

View File

@@ -19,8 +19,8 @@ shortTitle: Change 2FA delivery method
{% endnote %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
3. Next to "SMS delivery", click **Edit**.
![Edit SMS delivery options](/assets/images/help/2fa/edit-sms-delivery-option.png)
4. Under "Delivery options", click **Reconfigure two-factor authentication**.

View File

@@ -30,8 +30,8 @@ To keep your account secure, don't share or distribute your recovery codes. We r
If you generate new recovery codes or disable and re-enable 2FA, the recovery codes in your security settings automatically update.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
{% data reusables.two_fa.show-recovery-codes %}
4. Save your recovery codes in a safe place. Your recovery codes can help you get back into your account if you lose access.
- To save your recovery codes on your device, click **Download**.
@@ -43,8 +43,8 @@ If you generate new recovery codes or disable and re-enable 2FA, the recovery co
Once you use a recovery code to regain access to your account, it cannot be reused. If you've used all 16 recovery codes, you can generate another list of codes. Generating a new set of recovery codes will invalidate any codes you previously generated.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
{% data reusables.two_fa.show-recovery-codes %}
3. To create another batch of recovery codes, click **Generate new recovery codes**.
![Generate new recovery codes button](/assets/images/help/2fa/generate-new-recovery-codes.png)
@@ -69,8 +69,8 @@ You can use a fallback number regardless of whether you've configured authentica
{% endwarning %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
3. Next to "Fallback SMS number", click **Add**.
![Add fallback SMS number button](/assets/images/help/2fa/add-fallback-sms-number-button.png)
4. Under "Fallback SMS number", click **Add fallback SMS number**.

View File

@@ -49,8 +49,8 @@ A time-based one-time password (TOTP) application automatically generates an aut
{% endtip %}
1. Download a TOTP app.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
{% data reusables.two_fa.enable-two-factor-authentication %}
{%- ifversion fpt or ghes > 3.1 %}
5. Under "Two-factor authentication", select **Set up using an app** and click **Continue**.
@@ -92,8 +92,8 @@ Before using this method, be sure that you can receive text messages. Carrier ra
{% endwarning %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
{% data reusables.two_fa.enable-two-factor-authentication %}
4. Under "Two-factor authentication", select **Set up using SMS** and click **Continue**.
5. Under "Authentication verification", select your country code and type your mobile phone number, including the area code. When your information is correct, click **Send authentication code**.
@@ -118,8 +118,8 @@ Authentication with a security key is *secondary* to authentication with a TOTP
1. You must have already configured 2FA via a TOTP mobile app{% ifversion fpt or ghec %} or via SMS{% endif %}.
2. Ensure that you have a WebAuthn compatible security key inserted into your computer.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
5. Next to "Security keys", click **Add**.
![Add security keys option](/assets/images/help/2fa/add-security-keys-option.png)
6. Under "Security keys", click **Register new security key**.

View File

@@ -27,8 +27,8 @@ To remove yourself from your organization:
- As an organization member or owner, see "[Removing yourself from an organization](/articles/removing-yourself-from-an-organization/)."
- As an outside collaborator, ask an organization owner or repository administrator to remove you from the organization's repositories. For more information, see "[Viewing people's roles in an organization](/articles/viewing-people-s-roles-in-an-organization)" and "[Removing an outside collaborator from an organization repository](/articles/removing-an-outside-collaborator-from-an-organization-repository/)."
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.security %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.security %}
3. Click **Disable**.
![Disable two-factor authentication button](/assets/images/help/2fa/disable-two-factor-authentication.png)

View File

@@ -153,8 +153,8 @@ You must provide your public key to {% data variables.product.product_name %} to
> 2048 <em>SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)
```
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
6. Compare the list of SSH keys with the output from the `ssh-add` command.
![SSH key listing in {% data variables.product.product_name %}](/assets/images/help/settings/ssh_key_listing.png)
@@ -174,8 +174,8 @@ You must provide your public key to {% data variables.product.product_name %} to
> 2048 <em>SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)
```
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
6. Compare the list of SSH keys with the output from the `ssh-add` command.
![SSH key listing in {% data variables.product.product_name %}](/assets/images/help/settings/ssh_key_listing.png)
@@ -201,8 +201,8 @@ You must provide your public key to {% data variables.product.product_name %} to
> 2048 <em>MD5:a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d</em> /Users/<em>USERNAME</em>/.ssh/id_rsa (RSA)
```
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.ssh %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.ssh %}
6. Compare the list of SSH keys with the output from the `ssh-add` command.
![SSH key listing in {% data variables.product.product_name %}](/assets/images/help/settings/ssh_key_listing.png)

View File

@@ -20,7 +20,7 @@ shortTitle: About Git LFS billing
{% data reusables.large_files.owner_quota_only %}
{% data reusables.user_settings.context_switcher %}
{% data reusables.user-settings.context_switcher %}
## Purchasing additional storage and bandwidth

View File

@@ -22,8 +22,8 @@ When you downgrade your number of data packs, your change takes effect on your n
## Downgrading storage and bandwidth for a personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.lfs-remove-data %}
{% data reusables.large_files.downgrade_data_packs %}

View File

@@ -20,8 +20,8 @@ shortTitle: Upgrade Git LFS storage
---
## Purchasing additional storage and bandwidth for a personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.lfs-add-data %}
{% data reusables.large_files.pack_selection %}
{% data reusables.large_files.pack_confirm %}

View File

@@ -21,8 +21,8 @@ shortTitle: View Git LFS usage
## Viewing storage and bandwidth usage for a personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.lfs-data %}
## Viewing storage and bandwidth usage for an organization

View File

@@ -65,7 +65,7 @@ The storage used by a repository is the total storage used by {% data variables.
The number of jobs you can run concurrently across all repositories in your user or organization account depends on your GitHub plan. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits.
{% data reusables.user_settings.context_switcher %}
{% data reusables.user-settings.context_switcher %}
## Calculating minute and storage spending

View File

@@ -36,8 +36,8 @@ Because you have not enabled overages, your next attempt to create a workflow ar
Anyone can manage the spending limit for {% data variables.product.prodname_actions %} for their own user account.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.manage-spending-limit %}
{% data reusables.dotcom_billing.monthly-spending-limit %}
{% data reusables.dotcom_billing.update-spending-limit %}

View File

@@ -21,8 +21,8 @@ You can also view the billable job execution minutes for an individual workflow
Anyone can view {% data variables.product.prodname_actions %} usage for their own user account.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.actions-minutes %}
{% data reusables.dotcom_billing.actions-packages-storage %}
{% data reusables.dotcom_billing.actions-packages-report-download %}

View File

@@ -40,7 +40,7 @@ When you choose a paid plan with a free trial:
- If you have other paid plans or subscriptions, once your 14-day free trial ends, the payment method on file is immediately charged a prorated amount based on the time remaining until your next billing date.
- If you have other paid plans or subscriptions, on your next billing date, your receipt lists charges for your paid {% data variables.product.prodname_dotcom %} plan and your app subscription.
{% data reusables.user_settings.context_switcher %}
{% data reusables.user-settings.context_switcher %}
## Unit plan limits

View File

@@ -27,15 +27,15 @@ When you cancel a free trial on a paid plan, your subscription is immediately ca
## Canceling an app for your personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.marketplace.cancel-app-billing-settings %}
{% data reusables.marketplace.cancel-app %}
## Canceling a free trial for an app for your personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.marketplace.cancel-free-trial-billing-settings %}
{% data reusables.marketplace.cancel-app %}

View File

@@ -24,8 +24,8 @@ When you downgrade an app, your subscription remains active until the end of you
## Downgrading an app for your personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.marketplace.downgrade-app-billing-settings %}
{% data reusables.marketplace.choose-new-plan %}
{% data reusables.marketplace.choose-new-quantity %}

View File

@@ -22,8 +22,8 @@ When you upgrade an app, your payment method is charged a prorated amount based
## Upgrading an app for your personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.marketplace.upgrade-app-billing-settings %}
{% data reusables.marketplace.choose-new-plan %}
{% data reusables.marketplace.choose-new-quantity %}

View File

@@ -66,7 +66,7 @@ At the end of the month, {% data variables.product.prodname_dotcom %} rounds you
Your {% data variables.product.prodname_registry %} usage shares your account's existing billing date, payment method, and receipt. {% data reusables.dotcom_billing.view-all-subscriptions %}
{% data reusables.user_settings.context_switcher %}
{% data reusables.user-settings.context_switcher %}
## About spending limits

View File

@@ -37,8 +37,8 @@ Because you have not enabled overages, your next attempt to publish a version of
Anyone can manage the spending limit for {% data variables.product.prodname_registry %} for their own user account.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.manage-spending-limit %}
{% data reusables.dotcom_billing.monthly-spending-limit %}
{% data reusables.dotcom_billing.update-spending-limit %}

View File

@@ -20,8 +20,8 @@ shortTitle: View your usage
Anyone can view {% data variables.product.prodname_registry %} usage for their own user account.
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.packages-data %}
{% data reusables.dotcom_billing.actions-packages-storage %}
{% data reusables.dotcom_billing.actions-packages-report-download %}

View File

@@ -19,7 +19,7 @@ shortTitle: About billing
{% data reusables.dotcom_billing.view-all-subscriptions %}
{% data reusables.user_settings.context_switcher %}
{% data reusables.user-settings.context_switcher %}
## Further reading

View File

@@ -30,8 +30,8 @@ When you downgrade or cancel a sponsorship, the change will become effective on
## Canceling a sponsorship
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.sponsors.billing-switcher %}
3. Under "{% data variables.product.prodname_sponsors %}", to the right of the sponsored open source contributor, click {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to your sponsored amount, then click **Cancel sponsorship**.
![Cancel sponsorship button](/assets/images/help/billing/edit-sponsor-billing.png)

View File

@@ -32,7 +32,7 @@ You can purchase other features and products with your existing {% data variable
{% data reusables.accounts.accounts-billed-separately %}
{% data reusables.user_settings.context_switcher %}
{% data reusables.user-settings.context_switcher %}
{% tip %}

View File

@@ -36,8 +36,8 @@ When you downgrade your user account or organization's subscription, pricing and
If you downgrade your user account from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, the account will lose access to advanced code review tools on private repositories. {% data reusables.gated-features.more-info %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
1. Under "Current plan", use the **Edit** drop-down and click **Downgrade to Free**.
![Downgrade to free button](/assets/images/help/billing/downgrade-to-free.png)
5. Read the information about the features your user account will no longer have access to on your next billing date, then click **I understand. Continue with downgrade**.

View File

@@ -57,8 +57,8 @@ Existing sponsorships will remain in place during this period and maintainers wi
{% endnote %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
3. At the top of the page, click **Pay now**.
![One-time payment pay now button](/assets/images/help/billing/pay-now-button.png)
4. Review your billing and payment information. If you need to make an edit, click **Edit** next to the relevant section. Otherwise, click **Submit payment**.

View File

@@ -42,8 +42,8 @@ When you upgrade the subscription for an account, the upgrade changes the paid f
You can upgrade your personal account from {% data variables.product.prodname_free_user %} to {% data variables.product.prodname_pro %} to get advanced code review tools on private repositories owned by your user account. Upgrading your personal account does not affect any organizations you may manage or repositories owned by those organizations. {% data reusables.gated-features.more-info %}
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
1. Next to "Current plan", click **Upgrade**.
![Upgrade button](/assets/images/help/billing/settings_billing_user_upgrade.png)
2. Under "Pro" on the "Compare plans" page, click **Upgrade to Pro**.

View File

@@ -23,8 +23,8 @@ When you cancel a pending change, your subscription will not change on your next
## Viewing and managing pending changes to your personal account's subscription
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.review-pending-changes %}
{% data reusables.dotcom_billing.cancel-pending-changes %}
{% data reusables.dotcom_billing.confirm-cancel-pending-changes %}

View File

@@ -32,7 +32,7 @@ For more information, see "[Managing your {% data variables.product.prodname_dot
If you're an organization or enterprise owner, you can switch between settings for your different accounts using the context switcher in your settings.
{% data reusables.user_settings.access_settings %}
{% data reusables.user-settings.access_settings %}
1. At the top of the page, to the right of your username, click **Switch to another account**.
![Context switcher button](/assets/images/help/settings/context-switcher-button.png)
1. Start typing the name of the account you want to switch to, then click the name of the account.

View File

@@ -33,9 +33,9 @@ Your receipts include your {% data variables.product.prodname_dotcom %} subscrip
## Adding information to your personal account's receipts
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user_settings.payment-info-link %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.user-settings.payment-info-link %}
{% data reusables.dotcom_billing.extra_info_receipt %}
## Adding information to your organization's receipts
@@ -48,5 +48,5 @@ Your receipts include your {% data variables.product.prodname_dotcom %} subscrip
{% data reusables.organizations.billing-settings %}
{% data reusables.user_settings.payment-info-link %}
{% data reusables.user-settings.payment-info-link %}
{% data reusables.dotcom_billing.extra_info_receipt %}

View File

@@ -32,7 +32,7 @@ We don't provide invoicing or support purchase orders for personal accounts. We
## Updating your personal account's payment method
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.update_payment_method %}
1. If your account has existing billing information that you want to update, click **Edit**.
![Billing New Card button](/assets/images/help/billing/billing-information-edit-button.png)

View File

@@ -22,8 +22,8 @@ When you change your billing cycle's duration, your {% data variables.product.pr
## Changing the duration of your personal account's billing cycle
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.change_plan_duration %}
{% data reusables.dotcom_billing.confirm_duration_change %}

View File

@@ -21,8 +21,8 @@ shortTitle: View history & receipts
---
## Viewing receipts for your personal account
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.view-payment-history %}
{% data reusables.dotcom_billing.download_receipt %}

View File

@@ -21,8 +21,8 @@ shortTitle: Subscriptions & billing date
---
## Finding your personal account's next billing date
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.billing_plans %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.billing_plans %}
{% data reusables.dotcom_billing.next_billing_date %}
## Finding your organization's next billing date

View File

@@ -38,8 +38,8 @@ If you already have a personal {% data variables.product.prodname_dotcom %} user
## Step 2: Create the organization
{% data reusables.user_settings.access_settings %}
{% data reusables.user_settings.organizations %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.organizations %}
{% data reusables.organizations.new-organization %}
3. Under "Choose a plan", click **Choose {% data variables.product.prodname_free_team %}**. You will upgrade the organization in the next step.
{% data reusables.organizations.organization-name %}
@@ -73,7 +73,7 @@ If you already have a personal {% data variables.product.prodname_dotcom %} user
## Step 5: Invite your client to join the organization
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.people %}
{% data reusables.organizations.invite_member_from_people_tab %}
5. Type your client's {% data variables.product.prodname_dotcom %} username and press **Enter**.
@@ -85,7 +85,7 @@ If you already have a personal {% data variables.product.prodname_dotcom %} user
## Step 6: Transfer organization ownership to your client
{% data reusables.profile.access_org %}
{% data reusables.user_settings.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.people %}
4. Confirm that your client is listed among the members of the organization and is assigned the *owner* role.
5. To the right of your username, use the {% octicon "gear" aria-label="The Settings gear" %} drop-down menu, and click **Manage**.

Some files were not shown because too many files have changed in this diff Show More