diff --git a/content/README.md b/content/README.md index 2e4d4a4c9e7e..229305732b67 100644 --- a/content/README.md +++ b/content/README.md @@ -407,8 +407,8 @@ The homepage is the main Table of Contents file for the docs site. The homepage To create a product guides page (e.g. [Actions' Guide page](https://docs.github.com/en/actions/guides)), create or modify an existing markdown file with these specific frontmatter values: 1. Use the product guides page template by referencing `layout: product-guides`. -2. (optional) Include the learning tracks in [`learningTracks`](#learningTracks). -3. (optional) Define which articles to include with [`includeGuides`](#includeGuides). +1. (optional) Include the learning tracks in [`learningTracks`](#learningTracks). +1. (optional) Define which articles to include with [`includeGuides`](#includeGuides). If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md). If using `includeGuides`, make sure each of the articles in this list has [`topics`](#topics) and [`type`](#type) in its frontmatter. diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md index 6a1e0f4e55ae..038433cfb6f2 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md @@ -45,7 +45,7 @@ When you unsubscribe from notifications in your inbox, they will automatically d {% data reusables.notifications.access_notifications %} 1. From the notifications inbox, select the notifications you want to unsubscribe to. -2. Click **Unsubscribe.** +1. Click **Unsubscribe.** ![Screenshot of the "Notifications" page. A button, titled "Unsubscribe", is highlighted with an orange outline.](/assets/images/help/notifications-v2/unsubscribe-from-main-inbox.png) @@ -56,7 +56,7 @@ When you unsubscribe from notifications in your inbox, they will automatically d ![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Select the notifications you want to unsubscribe from. In the top right, click **Unsubscribe**. +1. Select the notifications you want to unsubscribe from. In the top right, click **Unsubscribe**. ## Unwatching repositories @@ -67,7 +67,7 @@ When you unwatch a repository, you unsubscribe from future updates from that rep ![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. On the watched repositories page, after you've evaluated the repositories you're watching, choose whether to: +1. On the watched repositories page, after you've evaluated the repositories you're watching, choose whether to: - Unwatch a repository - Ignore all notifications for a repository diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md index 1c955b110052..7775bfd80ec2 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md @@ -48,7 +48,7 @@ Many people forget about repositories that they've chosen to watch in the past. 1. In the left sidebar, under the list of repositories that you have notifications from, use the "Manage notifications" drop-down to click **Subscriptions**. ![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Use the filters and sort to narrow the list of subscriptions and begin unsubscribing to conversations you no longer want to receive notifications for. +1. Use the filters and sort to narrow the list of subscriptions and begin unsubscribing to conversations you no longer want to receive notifications for. ![Screenshot of the "Subscriptions" tab. Three dropdown menus, titled "Reason", "Repository", and "Sort", are highlighted with an orange outline.](/assets/images/help/notifications-v2/all-subscriptions.png) @@ -65,7 +65,7 @@ Many people forget about repositories that they've chosen to watch in the past. 1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**. ![Screenshot of the "Notifications" page. A dropdown menu, titled "Manage notifications", is highlighted with an orange outline.](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository. +1. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository. {% tip %} diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index ac67c771728f..875378acec83 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -147,7 +147,7 @@ Email notifications from {% data variables.location.product_location %} contain {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. On the notifications settings page, choose how you receive notifications when: +1. On the notifications settings page, choose how you receive notifications when: - There are updates in repositories {% ifversion team-discussions %}or team discussions{% endif %} you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)." - You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)." - There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% ifversion fpt or ghec %} @@ -275,16 +275,16 @@ You can also schedule when {% data variables.product.prodname_mobile %} will sen ### Managing your notification settings with {% data variables.product.prodname_ios %} 1. In the bottom menu, tap **Profile**. -2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. -3. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications. -4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. +1. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +1. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +1. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. ### Managing your notification settings with {% data variables.product.prodname_android %} 1. In the bottom menu, tap **Profile**. -2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. -3. To update your notification settings, tap **Configure Notifications** and then use the toggles to enable or disable your preferred types of push notifications. -4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. +1. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}. +1. To update your notification settings, tap **Configure Notifications** and then use the toggles to enable or disable your preferred types of push notifications. +1. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications. ## Configuring your watch settings for an individual repository with {% data variables.product.prodname_mobile %} diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index 4a667133bf34..698f5e5185b0 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -59,7 +59,7 @@ By default, your inbox has filters for when you are assigned, participating in a You can add up to 15 of your own custom filters. {% data reusables.notifications.access_notifications %} -2. To open the filter settings, in the left sidebar, next to "Filters", click {% octicon "gear" aria-label="Customize filters" %}. +1. To open the filter settings, in the left sidebar, next to "Filters", click {% octicon "gear" aria-label="Customize filters" %}. {% tip %} @@ -67,11 +67,11 @@ You can add up to 15 of your own custom filters. {% endtip %} -3. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see "[Supported queries for custom filters](#supported-queries-for-custom-filters)." +1. Add a name for your filter and a filter query. For example, to only see notifications for a specific repository, you can create a filter using the query `repo:octocat/open-source-project-name reason:participating`. You can also add emojis with a native emoji keyboard. For a list of supported search queries, see "[Supported queries for custom filters](#supported-queries-for-custom-filters)." ![Screenshot showing notification filters. Two input fields, with an example name and filter query filled in, are highlighted with an orange outline.](/assets/images/help/notifications-v2/custom-filter-example.png) -4. Click **Create**. +1. Click **Create**. ## Custom filter limitations diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md index 582149dc3c02..2dafa4ef6433 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md @@ -40,6 +40,6 @@ You can choose how you want to receive future notifications for a specific issue ![Screenshot of the "Notifications" element on an issue or pull request. A link, titled "Customize", is highlighted with an orange outline.](/assets/images/help/notifications-v2/customize-notifications-for-specific-thread.png) -2. In the dialog box, select **Custom**, then choose when you'd like to receive a notification update for this thread. For example, you can choose to receive an update when the pull request has been merged, closed, or reopened. You will be subscribed again if you participate in the thread, your username is @mentioned, or a team you're a member of is @mentioned. +1. In the dialog box, select **Custom**, then choose when you'd like to receive a notification update for this thread. For example, you can choose to receive an update when the pull request has been merged, closed, or reopened. You will be subscribed again if you participate in the thread, your username is @mentioned, or a team you're a member of is @mentioned. -3. Click **Save**. +1. Click **Save**. diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md index a4d4d5c59178..aff1948930df 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md @@ -74,7 +74,7 @@ You can change the name that is displayed on your profile. This name may also be {% endif %} {% data reusables.user-settings.access_settings %} -2. Under "Public profile", in the "Name" field, type the name you want to be displayed on your profile. +1. Under "Public profile", in the "Name" field, type the name you want to be displayed on your profile. ## Adding a bio to your profile @@ -94,7 +94,7 @@ For a longer-form and more prominent way of displaying customized information ab {% endnote %} {% data reusables.user-settings.access_settings %} -2. Under "Public profile", in the "Bio" field, type the content that you want displayed on your profile. The bio field is limited to 160 characters. +1. Under "Public profile", in the "Bio" field, type the content that you want displayed on your profile. The bio field is limited to 160 characters. {% tip %} @@ -167,12 +167,12 @@ If you select the "Busy" option, when people @mention your username, assign you 1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Set status** or, if you already have a status set, click your current status. ![Screenshot of the dropdown menu under @octocat's profile picture. A smiley icon and "Set status" are outlined in dark orange.](/assets/images/help/profile/set-status-on-profile.png) -2. In the "What's happening" field, type a status message. -3. Optionally, to set an emoji status, click {% octicon "smiley" aria-label="Choose an emoji" %}, then click an emoji from the list. -4. Optionally, if you'd like to share that you have limited availability, select "Busy." -5. Select the **Clear status** dropdown menu, then click when you want your status to expire. If you don't select a status expiration, you will keep your status until you clear or edit your status. -6. Select the **Visible to** dropdown menu, then click who you want your status visible to. If you don't select an organization, your status will be public. -7. Click **Set status**. +1. In the "What's happening" field, type a status message. +1. Optionally, to set an emoji status, click {% octicon "smiley" aria-label="Choose an emoji" %}, then click an emoji from the list. +1. Optionally, if you'd like to share that you have limited availability, select "Busy." +1. Select the **Clear status** dropdown menu, then click when you want your status to expire. If you don't select a status expiration, you will keep your status until you clear or edit your status. +1. Select the **Visible to** dropdown menu, then click who you want your status visible to. If you don't select an organization, your status will be public. +1. Click **Set status**. {% ifversion fpt or ghec %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md index 021ddb1d0f5c..c8a7919c7e3b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md @@ -25,6 +25,6 @@ shortTitle: Show an overview ## Managing the visibility of the activity overview on your profile {% data reusables.profile.access_profile %} -2. Above your contributions graph, select the **Contribution settings** dropdown menu, then click **Activity overview**. +1. Above your contributions graph, select the **Contribution settings** dropdown menu, then click **Activity overview**. ![Screenshot of the contributions graph on a user profile. A dropdown menu, labeled "Contribution settings", is highlighted with an orange outline.](/assets/images/help/profile/activity-overview.png) diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md index a1d6e6891883..0f875cea42f3 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md @@ -33,11 +33,12 @@ The person you invite to be your successor must have a {% data variables.product {% 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. + +1. Under "Successor settings", to invite a successor, begin typing a username, full name, or email address, then click their name when it appears. ![Screenshot of the "Successor settings" section. The string "octocat" is entered in a search field, and Octocat's profile is listed in a dropdown below.](/assets/images/help/settings/settings-invite-successor-search-field.png) -4. Click **Add successor**. +1. Click **Add successor**. {% data reusables.user-settings.sudo-mode-popup %} The user you've invited will be listed as "Pending" until they agree to become your successor. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md index 8c975bee7e65..c533ccf6d050 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md @@ -21,7 +21,7 @@ When you push commits from the command line, the email address that you've [set {% 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**. +1. To keep your email address private in commits you push from the command line, select **Block command line pushes that expose my email**. ## Further reading diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md index 3915e17b4530..fcc7a1092ab9 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md @@ -23,9 +23,9 @@ shortTitle: Primary email address {% 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**. -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**. -5. To remove the old email address from your account, next to the old email, click {% octicon "trash" aria-label="The trash symbol" %}. +1. 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**. +1. 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**. +1. To remove the old email address from your account, next to the old email, click {% octicon "trash" aria-label="The trash symbol" %}. {% ifversion fpt or ghec %} -6. Verify your new primary email address. Without a verified email address, you won't be able to use all of {% data variables.product.product_name %}'s features. For more information, see "[AUTOTITLE](/get-started/signing-up-for-github/verifying-your-email-address)." +1. Verify your new primary email address. Without a verified email address, you won't be able to use all of {% data variables.product.product_name %}'s features. For more information, see "[AUTOTITLE](/get-started/signing-up-for-github/verifying-your-email-address)." {% endif %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md index f3a02d49fb2a..a6065dc86c0a 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md @@ -24,8 +24,8 @@ shortTitle: Marketing 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**. -4. Click **Save email preferences**. +1. Under _Email preferences_, select **Only receive account related emails, and those I subscribe to**. +1. Click **Save email preferences**. ## Further reading diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md index 133236626286..7de6e88bb289 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md @@ -24,7 +24,7 @@ shortTitle: Find your username or email {% mac %} 1. In the **GitHub Desktop** menu, click **Preferences**. -2. In the Preferences window, verify the following: +1. In the Preferences window, verify the following: - To view your {% data variables.product.product_name %} username, click **Accounts**. - To view your Git email, click **Git**. Note that this email is not guaranteed to be [your primary {% data variables.product.product_name %} email](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address). @@ -33,7 +33,7 @@ shortTitle: Find your username or email {% windows %} 1. In the **File** menu, click **Options**. -2. In the Options window, verify the following: +1. In the Options window, verify the following: - To view your {% data variables.product.product_name %} username, click **Accounts**. - To view your Git email, click **Git**. Note that this email is not guaranteed to be [your primary {% data variables.product.product_name %} email](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address). diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md index d8e8bff07ffa..5847e267dc21 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md @@ -18,8 +18,8 @@ shortTitle: Set backup email address --- {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.emails %} -3. Under "Backup email address," use the dropdown menu to select the address you want to set as your backup email address. -4. Click **Save**. +1. Under "Backup email address," use the dropdown menu to select the address you want to set as your backup email address. +1. Click **Save**. ## Further reading diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md index 8ce844741278..7c33a063367d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md @@ -74,20 +74,21 @@ 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 %} + +1. {% data reusables.user-settings.set_your_email_address_in_git %} ```shell git config --global user.email "YOUR_EMAIL" ``` -3. {% data reusables.user-settings.confirm_git_email_address_correct %} +1. {% data reusables.user-settings.confirm_git_email_address_correct %} ```shell $ git config --global user.email email@example.com ``` -4. {% data reusables.user-settings.link_email_with_your_account %} +1. {% data reusables.user-settings.link_email_with_your_account %} ### Setting your email address for a single repository @@ -96,18 +97,19 @@ You can use the `git config` command to change the email address you associate w You can change the email address associated with commits you make in a single repository. This will override your global Git configuration settings in this one repository, but will not affect any other repositories. {% 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 %} + +1. Change the current working directory to the local repository where you want to configure the email address that you associate with your Git commits. +1. {% data reusables.user-settings.set_your_email_address_in_git %} ```shell git config user.email "YOUR_EMAIL" ``` -4. {% data reusables.user-settings.confirm_git_email_address_correct %} +1. {% data reusables.user-settings.confirm_git_email_address_correct %} ```shell $ git config user.email email@example.com ``` -5. {% data reusables.user-settings.link_email_with_your_account %} +1. {% data reusables.user-settings.link_email_with_your_account %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username.md index 2fbe3543b1d0..2a284241bf22 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username.md @@ -95,10 +95,10 @@ After changing your username, CODEOWNERS files that include your old username wi {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.account_settings %} -3. In the "Change username" section, click **Change username**.{% 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**. -5. Type a new username. -6. If the username you've chosen is available, click **Change my username**. If the username you've chosen is unavailable, you can try a different username or one of the suggestions you see. +1. In the "Change username" section, click **Change username**.{% ifversion fpt or ghec %} +1. Read the warnings about changing your username. If you still want to change your username, click **I understand, let's change my username**. +1. Type a new username. +1. If the username you've chosen is available, click **Change my username**. If the username you've chosen is unavailable, you can try a different username or one of the suggestions you see. {% endif %} ## Further reading diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/integrating-jira-with-your-personal-projects.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/integrating-jira-with-your-personal-projects.md index 5d36e0c0e17d..75ccb235d003 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/integrating-jira-with-your-personal-projects.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/integrating-jira-with-your-personal-projects.md @@ -15,11 +15,11 @@ shortTitle: Integrate Jira with projects {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} 1. Click **Register a new application**. -2. Under **Application name**, type "Jira". -3. Under **Homepage URL**, type the full URL to your Jira instance. -4. Under **Authorization callback URL**, type the full URL to your Jira instance. -5. Click **Register application**. -8. Under **Developer applications**, note the "Client ID" and "Client Secret" values. +1. Under **Application name**, type "Jira". +1. Under **Homepage URL**, type the full URL to your Jira instance. +1. Under **Authorization callback URL**, type the full URL to your Jira instance. +1. Click **Register application**. +1. Under **Developer applications**, note the "Client ID" and "Client Secret" values. {% data reusables.user-settings.jira_help_docs %} ## Further reading diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-access-to-your-personal-accounts-project-boards.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-access-to-your-personal-accounts-project-boards.md index 276580631eed..eff14c0f7a70 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-access-to-your-personal-accounts-project-boards.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-access-to-your-personal-accounts-project-boards.md @@ -25,9 +25,9 @@ A collaborator is a person who has permissions to a project board you own. A col {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} {% data reusables.project-management.collaborator-option %} -5. Under "Search by username, full name or email address", type the collaborator's name, username, or {% data variables.product.prodname_dotcom %} email. +1. Under "Search by username, full name or email address", type the collaborator's name, username, or {% data variables.product.prodname_dotcom %} email. {% data reusables.project-management.add-collaborator %} -7. The new collaborator has read permissions by default. Optionally, next to the new collaborator's name, use the drop-down menu and choose a different permission level. +1. The new collaborator has read permissions by default. Optionally, next to the new collaborator's name, use the drop-down menu and choose a different permission level. ## Removing a collaborator from a user-owned project board diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-security-and-analysis-settings-for-your-personal-account.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-security-and-analysis-settings-for-your-personal-account.md index 13085f94665e..d438b0fb41fd 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-security-and-analysis-settings-for-your-personal-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-security-and-analysis-settings-for-your-personal-account.md @@ -44,7 +44,7 @@ For an overview of repository-level security, see "[AUTOTITLE](/code-security/ge {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security-analysis %} -3. Under "Code security and analysis", to the right of the feature, enable or disable the feature by default for new repositories that you own. +1. Under "Code security and analysis", to the right of the feature, enable or disable the feature by default for new repositories that you own. ## Further reading diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-tab-size-rendering-preference.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-tab-size-rendering-preference.md index 948f02e5bb80..85289bd92295 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-tab-size-rendering-preference.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-tab-size-rendering-preference.md @@ -17,4 +17,4 @@ If you feel that tabbed indentation in code rendered on {% data variables.produc {% data reusables.user-settings.access_settings %} 1. In the left sidebar, click **{% octicon "paintbrush" aria-hidden="true" %} Appearance**. -2. Scroll down to "Tab size preference" and use the dropdown menu to choose your preference. +1. Scroll down to "Tab size preference" and use the dropdown menu to choose your preference. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/what-does-the-available-for-hire-checkbox-do.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/what-does-the-available-for-hire-checkbox-do.md index f0da519be8c0..884c5c085e57 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/what-does-the-available-for-hire-checkbox-do.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/what-does-the-available-for-hire-checkbox-do.md @@ -23,4 +23,4 @@ Deprecation note: GitHub Jobs is now deprecated. The last date to post a job was The [GitHub Jobs](https://jobs.github.com/) board is a great way to find employment in tech. You can opt to see jobs posted there on your GitHub dashboard. {% data reusables.user-settings.access_settings %} -2. Under Jobs Profile, select **Available for hire**, then click **Save jobs profile**. +1. Under Jobs Profile, select **Available for hire**, then click **Save jobs profile**. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md index 1e2a90f9c06f..d8becc67a9d4 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md @@ -34,7 +34,7 @@ You can set scheduled reminders for personal or team-level review requests for p {% data reusables.reminders.days-dropdown %} {% data reusables.reminders.times-dropdowns %} 1. Optionally, to receive scheduled reminders for reviews you've been assigned to, select **Review requests assigned to you**. -2. Optionally, to receive scheduled reminders for reviews assigned to a team you're a member of, select **Review requests assigned to your team**. +1. Optionally, to receive scheduled reminders for reviews assigned to a team you're a member of, select **Review requests assigned to your team**. {% data reusables.reminders.real-time-alerts %} {% data reusables.reminders.create-reminder %} {% data reusables.reminders.test-reminder %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md index d0de94e1b3df..489c90921186 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md @@ -39,8 +39,8 @@ shortTitle: User into an organization If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your personal account into an organization. 1. To retain your current personal account name for your personal use, [change the name of your personal account](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username) to something new and wonderful. -2. [Create a new organization](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch) with the original name of your personal account. -3. [Transfer your repositories](/repositories/creating-and-managing-repositories/transferring-a-repository) to your new organization account.{% endif %} +1. [Create a new organization](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch) with the original name of your personal account. +1. [Transfer your repositories](/repositories/creating-and-managing-repositories/transferring-a-repository) to your new organization account.{% endif %} ## Convert your personal account into an organization automatically @@ -52,7 +52,7 @@ You can also convert your personal account directly into an organization. Conver When you convert a personal account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as outside collaborators. You can then invite outside collaborators to become members of your new organization if you wish. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." 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](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization) the personal account you're converting has joined. +1. [Leave any organizations](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization) the personal account you're converting has joined. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.organizations %} 1. In the "Transform account" section, click **Turn USERNAME into an organization**. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index c2359f9aa998..8c84da2b37f7 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -63,10 +63,10 @@ Before you delete your personal account, make a copy of all repositories, privat {% 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 personal account: +1. At the bottom of the Account Settings page, under "Delete account", click **Delete your account**. Before you can delete your personal 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. -4. In the "Make sure you want to do this" dialog box, complete the steps to confirm you understand what happens when your account is deleted: +1. In the "Make sure you want to do this" dialog box, complete the steps to confirm you understand what happens when your account is deleted: {% ifversion fpt or ghec %}- Recall that all repositories, forks of private repositories, wikis, issues, pull requests and {% data variables.product.prodname_pages %} sites owned by your account will be deleted and your billing will end immediately, and your username will be available to anyone for use on {% data variables.product.product_name %} after 90 days.{% else %} - Recall that all repositories, forks of private repositories, wikis, issues, pull requests and pages owned by your account will be deleted, and your username will be available for use on {% data variables.product.product_name %}.{% endif %} - In the first field, type your {% data variables.product.product_name %} username or email. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md index 692b67aa6078..177c4edde0c4 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -109,8 +109,8 @@ If you want to use the SSH protocol for both accounts, you can use different SSH To use a different SSH key for different repositories that you clone to your workstation, you must write a shell wrapper function for Git operations. The function should perform the following steps. 1. Determine the repository's full name with owner, using a command such as `git config --get remote.origin.url`. -2. Choose the correct SSH key for authentication. -3. Modify `GIT_SSH_COMMAND` accordingly. For more information about `GIT_SSH_COMMAND`, see [Environment Variables](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) in the Git documentation. +1. Choose the correct SSH key for authentication. +1. Modify `GIT_SSH_COMMAND` accordingly. For more information about `GIT_SSH_COMMAND`, see [Environment Variables](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) in the Git documentation. For example, the following command sets the `GIT_SSH_COMMAND` environment variable to specify an SSH command that uses the private key file at **_PATH/TO/KEY/FILE_** for authentication to clone the repository named OWNER/REPOSITORY on {% data variables.location.product_location %}. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index e5e428c15d35..c124d2d5fa07 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -40,9 +40,9 @@ shortTitle: Merge multiple accounts {% endwarning %} 1. [Transfer any repositories](/repositories/creating-and-managing-repositories/transferring-a-repository) from the account you want to delete to the account you want to keep. Issues, pull requests, and wikis are transferred as well. Verify the repositories exist on the account you want to keep. -2. [Update the remote URLs](/get-started/getting-started-with-git/managing-remote-repositories) in any local clones of the repositories that were moved. -3. [Delete the account](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account) you no longer want to use. -4. To attribute past commits to the new account, add the email address you used to author the commits to the account you're keeping. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" +1. [Update the remote URLs](/get-started/getting-started-with-git/managing-remote-repositories) in any local clones of the repositories that were moved. +1. [Delete the account](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account) you no longer want to use. +1. To attribute past commits to the new account, add the email address you used to author the commits to the account you're keeping. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)" ## Further reading diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md index 68880c25d299..7db8f5494d9e 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md @@ -70,8 +70,8 @@ jobs: This workflow performs the following steps: 1. The `checkout` step downloads a copy of your repository on the runner. -2. The `setup-java` step configures the Eclipse Temurin (Java) 17 JDK by Eclipse Adoptium. -3. The "Build with Ant" step runs the default target in your `build.xml` in non-interactive mode. +1. The `setup-java` step configures the Eclipse Temurin (Java) 17 JDK by Eclipse Adoptium. +1. The "Build with Ant" step runs the default target in your `build.xml` in non-interactive mode. The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md index cf92659ccf13..3135a700a04f 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md @@ -78,9 +78,9 @@ jobs: This workflow performs the following steps: 1. The `checkout` step downloads a copy of your repository on the runner. -2. The `setup-java` step configures the Eclipse Temurin (Java) 17 JDK by Eclipse Adoptium. -3. The "Validate Gradle wrapper" step validates the checksums of Gradle Wrapper JAR files present in the source tree. -4. The "Build with Gradle" step does a build using the `gradle/gradle-build-action` action provided by the Gradle organization on {% data variables.product.prodname_dotcom %}. The action takes care of invoking Gradle, collecting results, and caching state between jobs. For more information see [`gradle/gradle-build-action`](https://github.com/gradle/gradle-build-action). +1. The `setup-java` step configures the Eclipse Temurin (Java) 17 JDK by Eclipse Adoptium. +1. The "Validate Gradle wrapper" step validates the checksums of Gradle Wrapper JAR files present in the source tree. +1. The "Build with Gradle" step does a build using the `gradle/gradle-build-action` action provided by the Gradle organization on {% data variables.product.prodname_dotcom %}. The action takes care of invoking Gradle, collecting results, and caching state between jobs. For more information see [`gradle/gradle-build-action`](https://github.com/gradle/gradle-build-action). The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md index 853939783e7d..c45b60a491ba 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md @@ -70,8 +70,8 @@ jobs: This workflow performs the following steps: 1. The `checkout` step downloads a copy of your repository on the runner. -2. The `setup-java` step configures the Eclipse Temurin (Java) 17 JDK by Eclipse Adoptium. -3. The "Build with Maven" step runs the Maven `package` target in non-interactive mode to ensure that your code builds, tests pass, and a package can be created. +1. The `setup-java` step configures the Eclipse Temurin (Java) 17 JDK by Eclipse Adoptium. +1. The "Build with Maven" step runs the Maven `package` target in non-interactive mode to ensure that your code builds, tests pass, and a package can be created. The default starter workflows are excellent starting points when creating your build and test workflow, and you can customize the starter workflow to suit your project’s needs. diff --git a/content/actions/creating-actions/creating-a-composite-action.md b/content/actions/creating-actions/creating-a-composite-action.md index 3bc61819e0c0..d25a7c5e705b 100644 --- a/content/actions/creating-actions/creating-a-composite-action.md +++ b/content/actions/creating-actions/creating-a-composite-action.md @@ -38,13 +38,13 @@ Before you begin, you'll create a repository on {% ifversion ghae %}{% data vari cd hello-world-composite-action ``` -2. In the `hello-world-composite-action` repository, create a new file called `goodbye.sh`, and add the following example code: +1. In the `hello-world-composite-action` repository, create a new file called `goodbye.sh`, and add the following example code: ```bash copy echo "Goodbye" ``` -3. From your terminal, make `goodbye.sh` executable. +1. From your terminal, make `goodbye.sh` executable. ```shell copy chmod +x goodbye.sh diff --git a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index e0b97a320196..41b729991ea3 100644 --- a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -61,8 +61,8 @@ To remove a published action from {% data variables.product.prodname_marketplace {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} {% data reusables.releases.edit-release %} -4. Select **Publish this action to the {% data variables.product.prodname_marketplace %}** to remove the check from the box. -5. Click **Update release** at the bottom of the page. +1. Select **Publish this action to the {% data variables.product.prodname_marketplace %}** to remove the check from the box. +1. Click **Update release** at the bottom of the page. ## About badges in {% data variables.product.prodname_marketplace %} diff --git a/content/actions/creating-actions/releasing-and-maintaining-actions.md b/content/actions/creating-actions/releasing-and-maintaining-actions.md index c412aaedf397..8c476da878f3 100644 --- a/content/actions/creating-actions/releasing-and-maintaining-actions.md +++ b/content/actions/creating-actions/releasing-and-maintaining-actions.md @@ -50,7 +50,7 @@ JavaScript actions are Node.js repositories with metadata. However, JavaScript a To support the developer process in the next section, add two {% data variables.product.prodname_actions %} workflows to your repository: 1. Add a workflow that triggers when a commit is pushed to a feature branch or to `main` or when a pull request is created. Configure the workflow to run your unit and integration tests. For an example, see [this workflow](https://github.com/github-developer/javascript-action/blob/963a3b9a9c662fd499419a240ed8c49411ff5add/.github/workflows/test.yml). -2. Add a workflow that triggers when a release is published or edited. Configure the workflow to ensure semantic tags are in place. You can use an action like [JasonEtco/build-and-tag-action](https://github.com/JasonEtco/build-and-tag-action) to compile and bundle the JavaScript and metadata file and force push semantic major, minor, and patch tags. For an example, see [this workflow](https://github.com/github-developer/javascript-action/blob/963a3b9a9c662fd499419a240ed8c49411ff5add/.github/workflows/publish.yml). For more information about semantic tags, see "[About semantic versioning](https://docs.npmjs.com/about-semantic-versioning)." +1. Add a workflow that triggers when a release is published or edited. Configure the workflow to ensure semantic tags are in place. You can use an action like [JasonEtco/build-and-tag-action](https://github.com/JasonEtco/build-and-tag-action) to compile and bundle the JavaScript and metadata file and force push semantic major, minor, and patch tags. For an example, see [this workflow](https://github.com/github-developer/javascript-action/blob/963a3b9a9c662fd499419a240ed8c49411ff5add/.github/workflows/publish.yml). For more information about semantic tags, see "[About semantic versioning](https://docs.npmjs.com/about-semantic-versioning)." ### Example developer process @@ -59,13 +59,13 @@ Here is an example process that you can follow to automatically run tests, creat 1. Do feature work in branches per GitHub flow. For more information, see "[AUTOTITLE](/get-started/quickstart/github-flow)." - Whenever a commit is pushed to the feature branch, your testing workflow will automatically run the tests. -2. Create pull requests to the `main` branch to initiate discussion and review, merging when ready. +1. Create pull requests to the `main` branch to initiate discussion and review, merging when ready. - When a pull request is opened, either from a branch or a fork, your testing workflow will again run the tests, this time with the merge commit. - **Note:** for security reasons, workflows triggered by `pull_request` from forks have restricted `GITHUB_TOKEN` permissions and do not have access to secrets. If your tests or other workflows triggered upon pull request require access to secrets, consider using a different event like a [manual trigger](/actions/using-workflows/events-that-trigger-workflows#manual-events) or a [`pull_request_target`](/actions/using-workflows/events-that-trigger-workflows#pull_request_target). Read more [here](/actions/using-workflows/events-that-trigger-workflows#pull-request-events-for-forked-repositories). -3. Create a semantically tagged release. {% ifversion fpt or ghec %} You may also publish to {% data variables.product.prodname_marketplace %} with a simple checkbox. {% endif %} For more information, see "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)"{% ifversion fpt or ghec %} and "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)"{% endif %}. +1. Create a semantically tagged release. {% ifversion fpt or ghec %} You may also publish to {% data variables.product.prodname_marketplace %} with a simple checkbox. {% endif %} For more information, see "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)"{% ifversion fpt or ghec %} and "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)"{% endif %}. - When a release is published or edited, your release workflow will automatically take care of compilation and adjusting tags. diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service.md index 4c24ef2517f6..701a45f67899 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-amazon-elastic-container-service.md @@ -54,13 +54,13 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you Ensure that you use the same AWS region value for the `AWS_REGION` (represented here by `MY_AWS_REGION`) variable in the workflow below. -2. Create an Amazon ECS task definition, cluster, and service. +1. Create an Amazon ECS task definition, cluster, and service. For details, follow the [Getting started wizard on the Amazon ECS console](https://us-east-2.console.aws.amazon.com/ecs/home?region=us-east-2#/firstRun), or the [Getting started guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/getting-started-fargate.html) in the Amazon ECS documentation. Ensure that you note the names you set for the Amazon ECS service and cluster, and use them for the `ECS_SERVICE` and `ECS_CLUSTER` variables in the workflow below. -3. Store your Amazon ECS task definition as a JSON file in your {% data variables.product.company_short %} repository. +1. Store your Amazon ECS task definition as a JSON file in your {% data variables.product.company_short %} repository. The format of the file should be the same as the output generated by: @@ -73,13 +73,13 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you Ensure that you set the `CONTAINER_NAME` variable in the workflow below as the container name in the `containerDefinitions` section of the task definition. -4. Create {% data variables.product.prodname_actions %} secrets named `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` to store the values for your Amazon IAM access key. +1. Create {% data variables.product.prodname_actions %} secrets named `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` to store the values for your Amazon IAM access key. For more information on creating secrets for {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)." See the documentation for each action used below for the recommended IAM policies for the IAM user, and methods for handling the access key credentials. -5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} ## Creating the workflow diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md index 253ac247bfc5..6d46361034c5 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service.md @@ -66,7 +66,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you ``` -5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} ## Creating the workflow diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md index 067c0f59dd2e..b83e1084cf14 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service.md @@ -34,7 +34,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you {% data reusables.actions.create-azure-app-plan %} -2. Create a web app. +1. Create a web app. For example, you can use the Azure CLI to create an Azure App Service web app with a .NET runtime: @@ -50,7 +50,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you {% data reusables.actions.create-azure-publish-profile %} -5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} ## Creating the workflow diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md index 73e36e818c9d..0652fbf61c26 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service.md @@ -40,7 +40,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you {% data reusables.actions.create-azure-app-plan %} -2. Create a web app. +1. Create a web app. For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime: @@ -56,7 +56,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you {% data reusables.actions.create-azure-publish-profile %} -5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} ## Creating the workflow diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md index ab5065e84cff..433eab7169db 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service.md @@ -34,7 +34,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you {% data reusables.actions.create-azure-app-plan %} -2. Create a web app. +1. Create a web app. For example, you can use the Azure CLI to create an Azure App Service web app with a PHP runtime: @@ -50,7 +50,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you {% data reusables.actions.create-azure-publish-profile %} -5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} ## Creating the workflow diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md index f7066d203c92..9222bd06fd19 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service.md @@ -53,7 +53,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you 1. Add an app setting called `SCM_DO_BUILD_DURING_DEPLOYMENT` and set the value to `1`. -5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} +1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %} ## Creating the workflow diff --git a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md index 544e70e9e5f2..d2647c09855b 100644 --- a/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md +++ b/content/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app.md @@ -34,7 +34,7 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you 1. Create an Azure Static Web App using the 'Other' option for deployment source. For more information, see "[Quickstart: Building your first static site in the Azure portal](https://docs.microsoft.com/azure/static-web-apps/get-started-portal)" in the Azure documentation. -2. Create a secret called `AZURE_STATIC_WEB_APPS_API_TOKEN` with the value of your static web app deployment token. For more information about how to find your deployment token, see "[Reset deployment tokens in Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/deployment-token-management)" in the Azure documentation. +1. Create a secret called `AZURE_STATIC_WEB_APPS_API_TOKEN` with the value of your static web app deployment token. For more information about how to find your deployment token, see "[Reset deployment tokens in Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/deployment-token-management)" in the Azure documentation. ## Creating the workflow diff --git a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index a057e01412aa..94b9203a5b6d 100644 --- a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -36,9 +36,9 @@ The following diagram gives an overview of how {% data variables.product.prodnam ![Diagram of how a cloud provider integrates with {% data variables.product.prodname_actions %} through access tokens and JSON web token cloud role IDs.](/assets/images/help/actions/oidc-architecture.png) 1. In your cloud provider, create an OIDC trust between your cloud role and your {% data variables.product.prodname_dotcom %} workflow(s) that need access to the cloud. -2. Every time your job runs, {% data variables.product.prodname_dotcom %}'s OIDC Provider auto-generates an OIDC token. This token contains multiple claims to establish a security-hardened and verifiable identity about the specific workflow that is trying to authenticate. -3. You could include a step or action in your job to request this token from {% data variables.product.prodname_dotcom %}'s OIDC provider, and present it to the cloud provider. -4. Once the cloud provider successfully validates the claims presented in the token, it then provides a short-lived cloud access token that is available only for the duration of the job. +1. Every time your job runs, {% data variables.product.prodname_dotcom %}'s OIDC Provider auto-generates an OIDC token. This token contains multiple claims to establish a security-hardened and verifiable identity about the specific workflow that is trying to authenticate. +1. You could include a step or action in your job to request this token from {% data variables.product.prodname_dotcom %}'s OIDC provider, and present it to the cloud provider. +1. Once the cloud provider successfully validates the claims presented in the token, it then provides a short-lived cloud access token that is available only for the duration of the job. ## Configuring the OIDC trust with the cloud diff --git a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md index cc513b111c47..5fca0d41c94d 100644 --- a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md +++ b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services.md @@ -81,7 +81,7 @@ In the following example, `StringLike` is used with a wildcard operator (`*`) to To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. -2. Use the [`aws-actions/configure-aws-credentials`](https://github.com/aws-actions/configure-aws-credentials) action to exchange the OIDC token (JWT) for a cloud access token. +1. Use the [`aws-actions/configure-aws-credentials`](https://github.com/aws-actions/configure-aws-credentials) action to exchange the OIDC token (JWT) for a cloud access token. ### Adding permissions settings diff --git a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md index 5c2f501bf90e..a7205f216557 100644 --- a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md +++ b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure.md @@ -32,8 +32,8 @@ This guide gives an overview of how to configure Azure to trust {% data variable To configure the OIDC identity provider in Azure, you will need to perform the following configuration. For instructions on making these changes, refer to [the Azure documentation](https://docs.microsoft.com/en-us/azure/developer/github/connect-from-azure). 1. Create an Azure Active Directory application and a service principal. -2. Add federated credentials for the Azure Active Directory application. -3. Create {% data variables.product.prodname_dotcom %} secrets for storing Azure configuration. +1. Add federated credentials for the Azure Active Directory application. +1. Create {% data variables.product.prodname_dotcom %} secrets for storing Azure configuration. Additional guidance for configuring the identity provider: @@ -44,7 +44,7 @@ Additional guidance for configuring the identity provider: To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. -2. Use the [`azure/login`](https://github.com/Azure/login) action to exchange the OIDC token (JWT) for a cloud access token. +1. Use the [`azure/login`](https://github.com/Azure/login) action to exchange the OIDC token (JWT) for a cloud access token. ### Adding permissions settings diff --git a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md index db0c1d26ecdf..bd58a4a29997 100644 --- a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md +++ b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers.md @@ -29,7 +29,7 @@ To use OIDC, you will first need to configure your cloud provider to trust {% da To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. -2. Use the official action from your cloud provider to exchange the OIDC token (JWT) for a cloud access token. +1. Use the official action from your cloud provider to exchange the OIDC token (JWT) for a cloud access token. If your cloud provider doesn't yet offer an official action, you can update your workflows to perform these steps manually. @@ -50,8 +50,8 @@ If you're not using an official action, then {% data variables.product.prodname_ To update your workflows using this approach, you will need to make three changes to your YAML: 1. Add permissions settings for the token. -2. Add code that requests the OIDC token from {% data variables.product.prodname_dotcom %}'s OIDC provider. -3. Add code that exchanges the OIDC token with your cloud provider for an access token. +1. Add code that requests the OIDC token from {% data variables.product.prodname_dotcom %}'s OIDC provider. +1. Add code that exchanges the OIDC token with your cloud provider for an access token. ### Requesting the JWT using the Actions core toolkit diff --git a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md index 829de6dfa240..cf4b1adcd9ca 100644 --- a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md +++ b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md @@ -30,8 +30,8 @@ This guide gives an overview of how to configure GCP to trust {% data variables. To configure the OIDC identity provider in GCP, you will need to perform the following configuration. For instructions on making these changes, refer to [the GCP documentation](https://github.com/google-github-actions/auth). 1. Create a new identity pool. -2. Configure the mapping and add conditions. -3. Connect the new pool to a service account. +1. Configure the mapping and add conditions. +1. Connect the new pool to a service account. Additional guidance for configuring the identity provider: @@ -43,7 +43,7 @@ Additional guidance for configuring the identity provider: To update your workflows for OIDC, you will need to make two changes to your YAML: 1. Add permissions settings for the token. -2. Use the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) action to exchange the OIDC token (JWT) for a cloud access token. +1. Use the [`google-github-actions/auth`](https://github.com/google-github-actions/auth) action to exchange the OIDC token (JWT) for a cloud access token. ### Adding permissions settings diff --git a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index e91601ff4511..081bcc019fdf 100644 --- a/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -52,7 +52,7 @@ To configure your Vault server to accept JSON Web Tokens (JWT) for authenticatio {% endnote %} {% endif %} -2. Configure a policy that only grants access to the specific paths your workflows will use to retrieve secrets. For more advanced policies, see the HashiCorp Vault [Policies documentation](https://www.vaultproject.io/docs/concepts/policies). +1. Configure a policy that only grants access to the specific paths your workflows will use to retrieve secrets. For more advanced policies, see the HashiCorp Vault [Policies documentation](https://www.vaultproject.io/docs/concepts/policies). ```sh copy vault policy write myproject-production - < 1. {% data variables.product.prodname_actions_runner_controller %} is installed using the supplied Helm charts, and the controller manager pod is deployed in the specified namespace. A new AutoScalingRunnerSet resource is deployed via the supplied Helm charts or a customized manifest file. The AutoScalingRunnerSet Controller calls GitHub's APIs to fetch the runner group ID that the runner scale set will belong to. -2. The AutoScalingRunnerSet Controller calls the APIs one more time to either fetch or create a runner scale set in the {% data variables.product.prodname_actions %} service before creating the Runner ScaleSet Listener resource. -3. A Runner ScaleSet Listener pod is deployed by the AutoScalingListener Controller. In this pod, the listener application connects to the {% data variables.product.prodname_actions %} Service to authenticate and establish an HTTPS long poll connection. The listener stays idle until it receives a `Job Available` message from the {% data variables.product.prodname_actions %} Service. -4. When a workflow run is triggered from a repository, the {% data variables.product.prodname_actions %} Service dispatches individual job runs to the runners or runner scalesets where the `runs-on` key matches the name of the runner scaleset or labels of self-hosted runners. -5. When the Runner ScaleSet Listener receives the `Job Available` message, it checks whether it can scale up to the desired count. If it can, the Runner ScaleSet Listener acknowledges the message. -6. The Runner ScaleSet Listener uses a Service Account and a Role bound to that account to make an HTTPS call through the Kubernetes APIs to patch the Ephemeral RunnerSet resource with the number of desired replicas count. -7. The Ephemeral RunnerSet attempts to create new runners and the EphemeralRunner Controller requests a Just-in-Time (JIT) configuration token to register these runners. The controller attempts to create runner pods. If the pod's status is `failed`, the controller retries up to 5 times. After 24 hours the {% data variables.product.prodname_actions %} Service unassigns the job if no runner accepts it. -8. Once the runner pod is created, the runner application in the pod uses the JIT configuration token to register itself with the {% data variables.product.prodname_actions %} Service. It then establishes another HTTPS long poll connection to receive the job details it needs to execute. -9. The {% data variables.product.prodname_actions %} Service acknowledges the runner registration and dispatches the job run details. -10. Throughout the job run execution, the runner continuously communicates the logs and job run status back to the {% data variables.product.prodname_actions %} Service. -11. When the runner completes its job successfully, the EphemeralRunner Controller checks with the {% data variables.product.prodname_actions %} Service to see if runner can be deleted. If it can, the Ephemeral RunnerSet deletes the runner. +1. The AutoScalingRunnerSet Controller calls the APIs one more time to either fetch or create a runner scale set in the {% data variables.product.prodname_actions %} service before creating the Runner ScaleSet Listener resource. +1. A Runner ScaleSet Listener pod is deployed by the AutoScalingListener Controller. In this pod, the listener application connects to the {% data variables.product.prodname_actions %} Service to authenticate and establish an HTTPS long poll connection. The listener stays idle until it receives a `Job Available` message from the {% data variables.product.prodname_actions %} Service. +1. When a workflow run is triggered from a repository, the {% data variables.product.prodname_actions %} Service dispatches individual job runs to the runners or runner scalesets where the `runs-on` key matches the name of the runner scaleset or labels of self-hosted runners. +1. When the Runner ScaleSet Listener receives the `Job Available` message, it checks whether it can scale up to the desired count. If it can, the Runner ScaleSet Listener acknowledges the message. +1. The Runner ScaleSet Listener uses a Service Account and a Role bound to that account to make an HTTPS call through the Kubernetes APIs to patch the Ephemeral RunnerSet resource with the number of desired replicas count. +1. The Ephemeral RunnerSet attempts to create new runners and the EphemeralRunner Controller requests a Just-in-Time (JIT) configuration token to register these runners. The controller attempts to create runner pods. If the pod's status is `failed`, the controller retries up to 5 times. After 24 hours the {% data variables.product.prodname_actions %} Service unassigns the job if no runner accepts it. +1. Once the runner pod is created, the runner application in the pod uses the JIT configuration token to register itself with the {% data variables.product.prodname_actions %} Service. It then establishes another HTTPS long poll connection to receive the job details it needs to execute. +1. The {% data variables.product.prodname_actions %} Service acknowledges the runner registration and dispatches the job run details. +1. Throughout the job run execution, the runner continuously communicates the logs and job run status back to the {% data variables.product.prodname_actions %} Service. +1. When the runner completes its job successfully, the EphemeralRunner Controller checks with the {% data variables.product.prodname_actions %} Service to see if runner can be deleted. If it can, the Ephemeral RunnerSet deletes the runner. ## {% data variables.product.prodname_actions_runner_controller %} components diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md index 8faa6785157d..8a95b85bb690 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md @@ -62,7 +62,7 @@ You can deploy runner scale sets with ARC's Helm charts or by deploying the nece {% data reusables.actions.actions-runner-controller-helm-chart-options %} -2. To check your installation, run the following command in your terminal. +1. To check your installation, run the following command in your terminal. ```bash copy helm list -A @@ -76,7 +76,7 @@ You can deploy runner scale sets with ARC's Helm charts or by deploying the nece arc-runner-set arc-systems 1 2023-04-12 11:46:13.451041354 +0000 UTC deployed gha-runner-scale-set-0.4.0 0.4.0 ``` -3. To check the manager pod, run the following command in your terminal. +1. To check the manager pod, run the following command in your terminal. ```bash copy kubectl get pods -n arc-systems diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller.md index 4d01016b7edd..9eb543619f49 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller.md @@ -93,7 +93,7 @@ In order to use ARC, ensure you have the following. For additional Helm configuration options, see [`values.yaml`](https://github.com/actions/actions-runner-controller/blob/master/charts/gha-runner-scale-set/values.yaml) in the ARC documentation. -2. From your terminal, run the following command to check your installation. +1. From your terminal, run the following command to check your installation. ```bash copy helm list -A @@ -107,7 +107,7 @@ In order to use ARC, ensure you have the following. arc-runner-set arc-runners 1 2023-04-12 11:46:13.451041354 +0000 UTC deployed gha-runner-scale-set-0.4.0 0.4.0 ``` -3. To check the manager pod, run the following command in your terminal. +1. To check the manager pod, run the following command in your terminal. ```bash copy kubectl get pods -n arc-systems diff --git a/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md b/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md index ea146776aba6..30caedf28116 100644 --- a/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md +++ b/content/actions/managing-issues-and-pull-requests/adding-labels-to-issues.md @@ -28,8 +28,8 @@ In the tutorial, you will first make a workflow file that uses the [`actions/git ## Creating the workflow 1. {% data reusables.actions.choose-repo %} -2. {% data reusables.actions.make-workflow-file %} -3. Copy the following YAML contents into your workflow file. +1. {% data reusables.actions.make-workflow-file %} +1. Copy the following YAML contents into your workflow file. ```yaml copy name: Label issues @@ -55,10 +55,10 @@ In the tutorial, you will first make a workflow file that uses the [`actions/git }) ``` -4. Customize the `script` parameter in your workflow file: +1. Customize the `script` parameter in your workflow file: - The `issue_number`, `owner`, and `repo` values are automatically set using the `context` object. You do not need to change these. - Change the value for `labels` to the list of labels that you want to add to the issue. Separate multiple labels with commas. For example, `["help wanted", "good first issue"]`. For more information about labels, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-labels-to-issues-and-pull-requests)." -5. {% data reusables.actions.commit-workflow %} +1. {% data reusables.actions.commit-workflow %} ## Testing the workflow @@ -67,8 +67,8 @@ Every time an issue in your repository is opened or reopened, this workflow will Test out your workflow by creating an issue in your repository. 1. Create an issue in your repository. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." -2. To see the workflow run that was triggered by creating the issue, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." -3. When the workflow completes, the issue that you created should have the specified labels added. +1. To see the workflow run that was triggered by creating the issue, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." +1. When the workflow completes, the issue that you created should have the specified labels added. ## Next steps diff --git a/content/actions/managing-issues-and-pull-requests/closing-inactive-issues.md b/content/actions/managing-issues-and-pull-requests/closing-inactive-issues.md index b19f22424278..2e35f3c72656 100644 --- a/content/actions/managing-issues-and-pull-requests/closing-inactive-issues.md +++ b/content/actions/managing-issues-and-pull-requests/closing-inactive-issues.md @@ -26,8 +26,8 @@ In the tutorial, you will first make a workflow file that uses the [`actions/sta ## Creating the workflow 1. {% data reusables.actions.choose-repo %} -2. {% data reusables.actions.make-workflow-file %} -3. Copy the following YAML contents into your workflow file. +1. {% data reusables.actions.make-workflow-file %} +1. Copy the following YAML contents into your workflow file. ```yaml copy name: Close inactive issues @@ -54,14 +54,14 @@ In the tutorial, you will first make a workflow file that uses the [`actions/sta repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} ``` -4. Customize the parameters in your workflow file: +1. Customize the parameters in your workflow file: - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every day at 1:30 UTC. For more information about scheduled workflows, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#scheduled-events)." - Change the value for `days-before-issue-stale` to the number of days without activity before the `actions/stale` action labels an issue. If you never want this action to label issues, set this value to `-1`. - Change the value for `days-before-issue-close` to the number of days without activity before the `actions/stale` action closes an issue. If you never want this action to close issues, set this value to `-1`. - Change the value for `stale-issue-label` to the label that you want to apply to issues that have been inactive for the amount of time specified by `days-before-issue-stale`. - Change the value for `stale-issue-message` to the comment that you want to add to issues that are labeled by the `actions/stale` action. - Change the value for `close-issue-message` to the comment that you want to add to issues that are closed by the `actions/stale` action. -5. {% data reusables.actions.commit-workflow %} +1. {% data reusables.actions.commit-workflow %} ## Expected results diff --git a/content/actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added.md b/content/actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added.md index 983db10e7dc2..629ee9422c55 100644 --- a/content/actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added.md +++ b/content/actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added.md @@ -26,8 +26,8 @@ In the tutorial, you will first make a workflow file that uses the [`peter-evans ## Creating the workflow 1. {% data reusables.actions.choose-repo %} -2. {% data reusables.actions.make-workflow-file %} -3. Copy the following YAML contents into your workflow file. +1. {% data reusables.actions.make-workflow-file %} +1. Copy the following YAML contents into your workflow file. ```yaml copy @@ -55,10 +55,10 @@ In the tutorial, you will first make a workflow file that uses the [`peter-evans This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles: ``` -4. Customize the parameters in your workflow file: +1. Customize the parameters in your workflow file: - Replace `help-wanted` in `if: github.event.label.name == 'help-wanted'` with the label that you want to act on. If you want to act on more than one label, separate the conditions with `||`. For example, `if: github.event.label.name == 'bug' || github.event.label.name == 'fix me'` will comment whenever the `bug` or `fix me` labels are added to an issue. - Change the value for `body` to the comment that you want to add. GitHub flavored markdown is supported. For more information about markdown, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." -5. {% data reusables.actions.commit-workflow %} +1. {% data reusables.actions.commit-workflow %} ## Testing the workflow @@ -67,9 +67,9 @@ Every time an issue in your repository is labeled, this workflow will run. If th Test your workflow by applying your specified label to an issue. 1. Open an issue in your repository. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." -2. Label the issue with the specified label in your workflow file. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-labels-to-issues-and-pull-requests)." -3. To see the workflow run triggered by labeling the issue, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." -4. When the workflow completes, the issue that you labeled should have a comment added. +1. Label the issue with the specified label in your workflow file. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-labels-to-issues-and-pull-requests)." +1. To see the workflow run triggered by labeling the issue, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." +1. When the workflow completes, the issue that you labeled should have a comment added. ## Next steps diff --git a/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md b/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md index d83b7c55be44..c7862ca6c4ce 100644 --- a/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md +++ b/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md @@ -26,9 +26,9 @@ In the tutorial, you will first make a workflow file that uses the [`alex-page/g ## Creating the workflow 1. {% data reusables.actions.choose-repo %} -2. In your repository, choose a project board. You can use an existing project, or you can create a new project. For more information about creating a project, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board)." -3. {% data reusables.actions.make-workflow-file %} -4. Copy the following YAML contents into your workflow file. +1. In your repository, choose a project board. You can use an existing project, or you can create a new project. For more information about creating a project, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board)." +1. {% data reusables.actions.make-workflow-file %} +1. Copy the following YAML contents into your workflow file. ```yaml copy @@ -52,14 +52,14 @@ In the tutorial, you will first make a workflow file that uses the [`alex-page/g repo-token: {% raw %}${{ secrets.PERSONAL_ACCESS_TOKEN }}{% endraw %} ``` -5. Customize the parameters in your workflow file: +1. Customize the parameters in your workflow file: - Change the value for `project` to the name of your project board. If you have multiple project boards with the same name, the `alex-page/github-project-automation-plus` action will act on all projects with the specified name. - Change the value for `column` to the name of the column where you want issues to move when they are assigned. - Change the value for `repo-token`: 1. Create a {% data variables.product.pat_v1 %} with the `repo` scope. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." 1. Store this {% data variables.product.pat_generic %} as a secret in your repository. For more information about storing secrets, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." 1. In your workflow file, replace `PERSONAL_ACCESS_TOKEN` with the name of your secret. -6. {% data reusables.actions.commit-workflow %} +1. {% data reusables.actions.commit-workflow %} ## Testing the workflow @@ -70,9 +70,9 @@ If your repository is user-owned, the `alex-page/github-project-automation-plus` Test your workflow by assigning an issue in your repository. 1. Open an issue in your repository. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." -2. Assign the issue. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)." -3. To see the workflow run that assigning the issue triggered, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." -4. When the workflow completes, the issue that you assigned should be added to the specified project board column. +1. Assign the issue. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)." +1. To see the workflow run that assigning the issue triggered, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." +1. When the workflow completes, the issue that you assigned should be added to the specified project board column. ## Next steps diff --git a/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md b/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md index 0225ca23ad2b..7bc7c9d1d67e 100644 --- a/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md +++ b/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md @@ -26,9 +26,9 @@ In the tutorial, you will first make a workflow file that uses the [`actions/git ## Creating the workflow 1. {% data reusables.actions.choose-repo %} -2. Choose a {% data variables.projects.projects_v1_board %} that belongs to the repository. This workflow cannot be used with projects that belong to users or organizations. You can use an existing {% data variables.projects.projects_v1_board %}, or you can create a new {% data variables.projects.projects_v1_board %}. For more information about creating a project, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board)." -3. {% data reusables.actions.make-workflow-file %} -4. Copy the following YAML contents into your workflow file. +1. Choose a {% data variables.projects.projects_v1_board %} that belongs to the repository. This workflow cannot be used with projects that belong to users or organizations. You can use an existing {% data variables.projects.projects_v1_board %}, or you can create a new {% data variables.projects.projects_v1_board %}. For more information about creating a project, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board)." +1. {% data reusables.actions.make-workflow-file %} +1. Copy the following YAML contents into your workflow file. ```yaml copy name: Remove a label @@ -57,14 +57,14 @@ In the tutorial, you will first make a workflow file that uses the [`actions/git }) ``` -5. Customize the parameters in your workflow file: +1. Customize the parameters in your workflow file: - In `github.event.project_card.column_id == '12345678'`, replace `12345678` with the ID of the column where you want to un-label issues and pull requests that are moved there. To find the column ID, navigate to your {% data variables.projects.projects_v1_board %}. Next to the title of the column, click {% octicon "kebab-horizontal" aria-label="Column menu" %} then click **Copy column link**. The column ID is the number at the end of the copied link. For example, `24687531` is the column ID for `https://github.com/octocat/octo-repo/projects/1#column-24687531`. If you want to act on more than one column, separate the conditions with `||`. For example, `if github.event.project_card.column_id == '12345678' || github.event.project_card.column_id == '87654321'` will act whenever a project card is added to column `12345678` or column `87654321`. The columns may be on different project boards. - Change the value for `name` in the `github.rest.issues.removeLabel()` function to the name of the label that you want to remove from issues or pull requests that are moved to the specified column(s). For more information on labels, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-labels-to-issues-and-pull-requests)." -6. {% data reusables.actions.commit-workflow %} +1. {% data reusables.actions.commit-workflow %} ## Testing the workflow @@ -73,10 +73,10 @@ Every time a project card on a {% data variables.projects.projects_v1_board %} i Test your workflow out by moving an issue on your {% data variables.projects.projects_v1_board %} into the target column. 1. Open an issue in your repository. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." -2. Label the issue with the label that you want the workflow to remove. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-labels-to-issues-and-pull-requests)." -3. Add the issue to the {% data variables.projects.projects_v1_board %} column that you specified in your workflow file. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board)." -4. To see the workflow run that was triggered by adding the issue to the project, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." -5. When the workflow completes, the issue that you added to the project column should have the specified label removed. +1. Label the issue with the label that you want the workflow to remove. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-labels-to-issues-and-pull-requests)." +1. Add the issue to the {% data variables.projects.projects_v1_board %} column that you specified in your workflow file. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board)." +1. To see the workflow run that was triggered by adding the issue to the project, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." +1. When the workflow completes, the issue that you added to the project column should have the specified label removed. ## Next steps diff --git a/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md b/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md index 27cff80ef171..785c5e54e312 100644 --- a/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md +++ b/content/actions/managing-issues-and-pull-requests/scheduling-issue-creation.md @@ -26,8 +26,8 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is ## Creating the workflow 1. {% data reusables.actions.choose-repo %} -2. {% data reusables.actions.make-workflow-file %} -3. Copy the following YAML contents into your workflow file. +1. {% data reusables.actions.make-workflow-file %} +1. Copy the following YAML contents into your workflow file. ```yaml copy @@ -71,7 +71,7 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} ``` -4. Customize the parameters in your workflow file: +1. Customize the parameters in your workflow file: - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every Monday at 7:20 UTC. For more information about scheduled workflows, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#scheduled-events)." - Change the value for `assignees` to the list of {% data variables.product.prodname_dotcom %} usernames that you want to assign to the issue. - Change the value for `labels` to the list of labels that you want to apply to the issue. @@ -79,7 +79,7 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is - Change the value for `body` to the text that you want in the issue body. The `|` character allows you to use a multi-line value for this parameter. - If you want to pin this issue in your repository, set `pinned` to `true`. For more information about pinned issues, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - If you want to close the previous issue generated by this workflow each time a new issue is created, set `close-previous` to `true`. The workflow will close the most recent issue that has the labels defined in the `labels` field. To avoid closing the wrong issue, use a unique label or combination of labels. -5. {% data reusables.actions.commit-workflow %} +1. {% data reusables.actions.commit-workflow %} ## Expected results diff --git a/content/actions/managing-workflow-runs/canceling-a-workflow.md b/content/actions/managing-workflow-runs/canceling-a-workflow.md index 720743f5da12..4f288edea216 100644 --- a/content/actions/managing-workflow-runs/canceling-a-workflow.md +++ b/content/actions/managing-workflow-runs/canceling-a-workflow.md @@ -27,7 +27,7 @@ versions: When canceling workflow run, you may be running other software that uses resources that are related to the workflow run. To help you free up resources related to the workflow run, it may help to understand the steps {% data variables.product.prodname_dotcom %} performs to cancel a workflow run. 1. To cancel the workflow run, the server re-evaluates `if` conditions for all currently running jobs. If the condition evaluates to `true`, the job will not get canceled. For example, the condition `if: always()` would evaluate to true and the job continues to run. When there is no condition, that is the equivalent of the condition `if: success()`, which only runs if the previous step finished successfully. -2. For jobs that need to be canceled, the server sends a cancellation message to all the runner machines with jobs that need to be canceled. -3. For jobs that continue to run, the server re-evaluates `if` conditions for the unfinished steps. If the condition evaluates to `true`, the step continues to run. -4. For steps that need to be canceled, the runner machine sends `SIGINT/Ctrl-C` to the step's entry process (`node` for javascript action, `docker` for container action, and `bash/cmd/pwd` when using `run` in a step). If the process doesn't exit within 7500 ms, the runner will send `SIGTERM/Ctrl-Break` to the process, then wait for 2500 ms for the process to exit. If the process is still running, the runner kills the process tree. -5. After the 5 minutes cancellation timeout period, the server will force terminate all jobs and steps that don't finish running or fail to complete the cancellation process. +1. For jobs that need to be canceled, the server sends a cancellation message to all the runner machines with jobs that need to be canceled. +1. For jobs that continue to run, the server re-evaluates `if` conditions for the unfinished steps. If the condition evaluates to `true`, the step continues to run. +1. For steps that need to be canceled, the runner machine sends `SIGINT/Ctrl-C` to the step's entry process (`node` for javascript action, `docker` for container action, and `bash/cmd/pwd` when using `run` in a step). If the process doesn't exit within 7500 ms, the runner will send `SIGTERM/Ctrl-Break` to the process, then wait for 2500 ms for the process to exit. If the process is still running, the runner kills the process tree. +1. After the 5 minutes cancellation timeout period, the server will force terminate all jobs and steps that don't finish running or fail to complete the cancellation process. diff --git a/content/actions/managing-workflow-runs/deleting-a-workflow-run.md b/content/actions/managing-workflow-runs/deleting-a-workflow-run.md index 012fa35852a2..5e0cf18ea6df 100644 --- a/content/actions/managing-workflow-runs/deleting-a-workflow-run.md +++ b/content/actions/managing-workflow-runs/deleting-a-workflow-run.md @@ -20,4 +20,4 @@ versions: ![Screenshot of a list of workflow runs. To the right of a run, an icon of three horizontal dots is highlighted with an orange outline.](/assets/images/help/settings/workflow-delete-run.png) -2. Review the confirmation prompt and click **Yes, permanently delete this workflow run**. +1. Review the confirmation prompt and click **Yes, permanently delete this workflow run**. diff --git a/content/actions/managing-workflow-runs/reviewing-deployments.md b/content/actions/managing-workflow-runs/reviewing-deployments.md index 43c32e481885..1b8ac4e6426b 100644 --- a/content/actions/managing-workflow-runs/reviewing-deployments.md +++ b/content/actions/managing-workflow-runs/reviewing-deployments.md @@ -20,9 +20,9 @@ For more information about environments and required approvals, see "[AUTOTITLE] ## Approving or rejecting a job 1. Navigate to the workflow run that requires review. For more information about navigating to a workflow run, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." -2. If the run requires review, you will see a notification for the review request. On the notification, click **Review deployments**. -3. Select the job environment(s) to approve or reject. Optionally, leave a comment. -4. Approve or reject: +1. If the run requires review, you will see a notification for the review request. On the notification, click **Review deployments**. +1. Select the job environment(s) to approve or reject. Optionally, leave a comment. +1. Approve or reject: - To approve the job, click **Approve and deploy**. Once a job is approved (and any other environment protection rules have passed), the job will proceed. At this point, the job can access any secrets stored in the environment. - To reject the job, click **Reject**. If a job is rejected, the workflow will fail. diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md index d0604a18df49..64271f409706 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md @@ -78,7 +78,7 @@ The `configure` CLI command is used to set required credentials and options for - Variable Groups: `Read` After creating the token, copy it and save it in a safe location for later use. -2. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: +1. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: ```shell gh actions-importer configure @@ -109,7 +109,7 @@ The `configure` CLI command is used to set required credentials and options for Environment variables successfully updated. ``` -3. In your terminal, run the {% data variables.product.prodname_actions_importer %} `update` CLI command to connect to the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} and ensure that the container image is updated to the latest version: +1. In your terminal, run the {% data variables.product.prodname_actions_importer %} `update` CLI command to connect to the {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} and ensure that the container image is updated to the latest version: ```shell gh actions-importer update diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md index ddf9a914d6ab..621d0cc86606 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md @@ -55,12 +55,12 @@ The `configure` CLI command is used to set required credentials and options for Your token must have the `workflow` scope. After creating the token, copy it and save it in a safe location for later use. -2. Create a GitLab {% data variables.product.pat_generic %}. For more information, see [{% data variables.product.pat_generic_caps_plural %}](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) in the GitLab documentation. +1. Create a GitLab {% data variables.product.pat_generic %}. For more information, see [{% data variables.product.pat_generic_caps_plural %}](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) in the GitLab documentation. Your token must have the `read_api` scope. After creating the token, copy it and save it in a safe location for later use. -3. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: +1. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: ```shell gh actions-importer configure diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md index 29b7564bb8c9..1452e445eae1 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md @@ -51,10 +51,10 @@ The `configure` CLI command is used to set required credentials and options for Your token must have the `workflow` scope. After creating the token, copy it and save it in a safe location for later use. -2. Create a Jenkins API token. For more information, see [Authenticating scripted clients](https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/) in the Jenkins documentation. +1. Create a Jenkins API token. For more information, see [Authenticating scripted clients](https://www.jenkins.io/doc/book/system-administration/authenticating-scripted-clients/) in the Jenkins documentation. After creating the token, copy it and save it in a safe location for later use. -3. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: +1. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: ```shell gh actions-importer configure diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md index 1df67db6b326..8884147dacf6 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md @@ -58,10 +58,10 @@ The `configure` CLI command is used to set required credentials and options for Your token must have the `workflow` scope. After creating the token, copy it and save it in a safe location for later use. -2. Create a Travis CI API access token. For more information, see [Get your Travis CI API token](https://docs.travis-ci.com/user/migrate/travis-migrate-to-apps-gem-guide/#4-get-your-travis-ci-api-token) in the Travis CI documentation. +1. Create a Travis CI API access token. For more information, see [Get your Travis CI API token](https://docs.travis-ci.com/user/migrate/travis-migrate-to-apps-gem-guide/#4-get-your-travis-ci-api-token) in the Travis CI documentation. After creating the token, copy it and save it in a safe location for later use. -3. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: +1. In your terminal, run the {% data variables.product.prodname_actions_importer %} `configure` CLI command: ```shell gh actions-importer configure diff --git a/content/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph.md b/content/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph.md index ff15d17bb6b0..e5f3d040a144 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph.md @@ -21,4 +21,4 @@ versions: 1. The graph displays each job in the workflow. An icon to the left of the job name indicates the status of the job. Lines between jobs indicate dependencies. ![Screenshot of the visualization graph of a workflow run.](/assets/images/help/actions/workflow-graph.png) -2. To view a job's log, click the job. +1. To view a job's log, click the job. diff --git a/content/actions/security-guides/encrypted-secrets.md b/content/actions/security-guides/encrypted-secrets.md index 850255b4147d..c0651f8c59ad 100644 --- a/content/actions/security-guides/encrypted-secrets.md +++ b/content/actions/security-guides/encrypted-secrets.md @@ -124,10 +124,10 @@ To list all secrets for the repository, use the `gh secret list` subcommand. {% data reusables.repositories.sidebar-settings %} {% data reusables.actions.sidebar-environment %} 1. Click on the environment that you want to add a secret to. -2. Under **Environment secrets**, click **Add secret**. -3. Type a name for your secret in the **Name** input box. -4. Enter the value for your secret. -5. Click **Add secret**. +1. Under **Environment secrets**, click **Add secret**. +1. Type a name for your secret in the **Name** input box. +1. Enter the value for your secret. +1. Click **Add secret**. {% endwebui %} diff --git a/content/actions/security-guides/security-hardening-for-github-actions.md b/content/actions/security-guides/security-hardening-for-github-actions.md index c8d2c8883017..e574faefc066 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -288,15 +288,15 @@ This list describes the recommended approaches for accessing repository data wit 1. **The `GITHUB_TOKEN`** - This token is intentionally scoped to the single repository that invoked the workflow, and can have the same level of access as a write-access user on the repository. The token is created before each job begins and expires when the job is finished. For more information, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication)." - The `GITHUB_TOKEN` should be used whenever possible. -2. **Repository deploy key** +1. **Repository deploy key** - Deploy keys are one of the only credential types that grant read or write access to a single repository, and can be used to interact with another repository within a workflow. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys)." - Note that deploy keys can only clone and push to the repository using Git, and cannot be used to interact with the REST or GraphQL API, so they may not be appropriate for your requirements. -3. **{% data variables.product.prodname_github_app %} tokens** +1. **{% data variables.product.prodname_github_app %} tokens** - {% data variables.product.prodname_github_apps %} can be installed on select repositories, and even have granular permissions on the resources within them. You could create a {% data variables.product.prodname_github_app %} internal to your organization, install it on the repositories you need access to within your workflow, and authenticate as the installation within your workflow to access those repositories. For more information, see "[AUTOTITLE](/apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)." -4. **{% data variables.product.pat_generic %}s** +1. **{% data variables.product.pat_generic %}s** - You should never use a {% data variables.product.pat_v1 %}. These tokens grant access to all repositories within the organizations that you have access to, as well as all personal repositories in your personal account. This indirectly grants broad access to all write-access users of the repository the workflow is in. - If you do use a {% data variables.product.pat_generic %}, you should never use a {% data variables.product.pat_generic %} from your own account. If you later leave an organization, workflows using this token will immediately break, and debugging this issue can be challenging. Instead, you should use a {% ifversion pat-v2%}{% data variables.product.pat_v2 %}s{% else %}{% data variables.product.pat_generic %}s{% endif %} for a new account that belongs to your organization and that is only granted access to the specific repositories that are needed for the workflow. Note that this approach is not scalable and should be avoided in favor of alternatives, such as deploy keys. -5. **SSH keys on a personal account** +1. **SSH keys on a personal account** - Workflows should never use the SSH keys on a personal account. Similar to {% data variables.product.pat_v1_plural %}, they grant read/write permissions to all of your personal repositories as well as all the repositories you have access to through organization membership. This indirectly grants broad access to all write-access users of the repository the workflow is in. If you're intending to use an SSH key because you only need to perform repository clones or pushes, and do not need to interact with public APIs, then you should use individual deploy keys instead. {% ifversion actions-sbom %} diff --git a/content/actions/using-github-hosted-runners/about-larger-runners.md b/content/actions/using-github-hosted-runners/about-larger-runners.md index 3c1d8e041057..bca80df2321e 100644 --- a/content/actions/using-github-hosted-runners/about-larger-runners.md +++ b/content/actions/using-github-hosted-runners/about-larger-runners.md @@ -65,10 +65,10 @@ In the following diagram, a class of hosted runner named `ubuntu-20.04-16core` h ![Diagram showing a larger runner being used by a workflow because of the runner's label.](/assets/images/help/actions/hosted-runner.png) 1. Instances of this runner are automatically created and added to a group called `grp-ubuntu-20.04-16core`. -2. The runners have been assigned the label `ubuntu-20.04-16core`. -3. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job. -4. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner. -5. The job runs on the next available instance of the `ubuntu-20.04-16core` runner. +1. The runners have been assigned the label `ubuntu-20.04-16core`. +1. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job. +1. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner. +1. The job runs on the next available instance of the `ubuntu-20.04-16core` runner. ## Autoscaling {% data variables.actions.hosted_runner %}s diff --git a/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md b/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md index 640088c126df..36bf786f53bf 100644 --- a/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md +++ b/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md @@ -42,8 +42,8 @@ Starter workflows created by users can only be used to create workflows in publi This procedure demonstrates how to create a starter workflow and metadata file. The metadata file describes how the starter workflows will be presented to users when they are creating a new workflow. 1. If it doesn't already exist, create a new public repository named `.github` in your organization. -2. Create a directory named `workflow-templates`. -3. Create your new workflow file inside the `workflow-templates` directory. +1. Create a directory named `workflow-templates`. +1. Create your new workflow file inside the `workflow-templates` directory. If you need to refer to a repository's default branch, you can use the `$default-branch` placeholder. When a workflow is created the placeholder will be automatically replaced with the name of the repository's default branch. @@ -69,7 +69,7 @@ This procedure demonstrates how to create a starter workflow and metadata file. run: echo Hello from Octo Organization ``` -4. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: +1. Create a metadata file inside the `workflow-templates` directory. The metadata file must have the same name as the workflow file, but instead of the `.yml` extension, it must be appended with `.properties.json`. For example, this file named `octo-organization-ci.properties.json` contains the metadata for a workflow file named `octo-organization-ci.yml`: ```json copy { diff --git a/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance.md b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance.md index 1df526d49838..a002ce7f2bed 100644 --- a/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance.md +++ b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance.md @@ -39,7 +39,7 @@ If someone checks a secret with a known pattern into a repository, {% data varia The SSSE3 set of instructions is required because {% data variables.product.prodname_secret_scanning %} leverages hardware accelerated pattern matching to find potential credentials committed to your {% data variables.product.prodname_dotcom %} repositories. SSSE3 is enabled for most modern CPUs. You can check whether SSSE3 is enabled for the vCPUs available to your {% data variables.product.prodname_ghe_server %} instance. 1. Connect to the administrative shell for your {% data variables.product.prodname_ghe_server %} instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." -2. Enter the following command: +1. Enter the following command: ```shell grep -iE '^flags.*ssse3' /proc/cpuinfo >/dev/null | echo $? diff --git a/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md index e32151dab68e..b4d668761760 100644 --- a/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md +++ b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md @@ -44,9 +44,9 @@ For guidance on a phased deployment of GitHub Advanced Security, see "[AUTOTITLE ## Prerequisites for enabling {% data variables.product.prodname_GH_advanced_security %} 1. Upgrade your license for {% data variables.product.product_name %} to include {% data variables.product.prodname_GH_advanced_security %}.{% ifversion ghes %} For information about licensing, see "[AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} -2. Download the new license file. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." -3. Upload the new license file to {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %} -4. Review the prerequisites for the features you plan to enable. +1. Download the new license file. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise)." +1. Upload the new license file to {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/uploading-a-new-license-to-github-enterprise-server)."{% ifversion ghes %} +1. Review the prerequisites for the features you plan to enable. - {% data variables.product.prodname_code_scanning_caps %}, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance#prerequisites-for-code-scanning)." - {% data variables.product.prodname_secret_scanning_caps %}, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance#prerequisites-for-secret-scanning)."{% endif %} @@ -100,7 +100,7 @@ For example, you can enable any {% data variables.product.prodname_GH_advanced_s ghe-config app.github.vulnerability-alerting-and-settings-enabled true ```{% endif %} -2. Optionally, disable features for {% data variables.product.prodname_GH_advanced_security %}. +1. Optionally, disable features for {% data variables.product.prodname_GH_advanced_security %}. - To disable {% data variables.product.prodname_code_scanning %}, enter the following commands. @@ -125,7 +125,7 @@ For example, you can enable any {% data variables.product.prodname_GH_advanced_s ghe-config app.github.vulnerability-alerting-and-settings-enabled false ```{% endif %} -3. Apply the configuration. +1. Apply the configuration. ```shell ghe-config-apply diff --git a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md index 53ed2de52031..55c0eff2dcc7 100644 --- a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md +++ b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md @@ -53,8 +53,8 @@ If {% data variables.location.product_location %} uses clustering, you cannot en **Note**: For more information about enabling access to the administrative shell via SSH, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." {% endnote %} -2. Apply the configuration. +1. Apply the configuration. ```shell $ ghe-config-apply ``` -3. Return to {% data variables.product.prodname_ghe_server %}. +1. Return to {% data variables.product.prodname_ghe_server %}. diff --git a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise.md b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise.md index 3216dbc64879..fe05655a6bbc 100644 --- a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise.md +++ b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise.md @@ -20,5 +20,5 @@ You can manually sync vulnerability data from {% data variables.product.prodname Before you can view vulnerability data, you must enable {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." {% data reusables.enterprise_site_admin_settings.access-settings %} -2. In the left sidebar, under {% octicon "rocket" aria-hidden="true" %} **Site admin**, click **Vulnerabilities**. -3. To sync vulnerability data, click **Sync Vulnerabilities Now**. +1. In the left sidebar, under {% octicon "rocket" aria-hidden="true" %} **Site admin**, click **Vulnerabilities**. +1. To sync vulnerability data, click **Sync Vulnerabilities Now**. diff --git a/content/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise.md b/content/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise.md index a9d75b25632a..b0108c32dfc1 100644 --- a/content/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise.md +++ b/content/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise.md @@ -137,7 +137,7 @@ After you enable {% data variables.product.prodname_dependabot_alerts %} for you 1. Under "Security", select **{% data variables.product.prodname_dependabot_security_updates %}**. {% data reusables.enterprise_management_console.save-settings %} 1. Click **Visit your instance**. -2. Configure dedicated self-hosted runners to create the pull requests that will update dependencies. This is required because the workflows use a specific runner label. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates)." +1. Configure dedicated self-hosted runners to create the pull requests that will update dependencies. This is required because the workflows use a specific runner label. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates)." {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.github-connect-tab %} 1. Under "{% data variables.product.prodname_dependabot %}", to the right of "Users can easily upgrade to non-vulnerable open source code dependencies", click **Enable**. diff --git a/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md b/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md index 3a0ddfd13089..e5c40e0ccb91 100644 --- a/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md +++ b/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md @@ -26,4 +26,4 @@ You can disable {% data variables.product.prodname_server_statistics %} from {% {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.github-connect-tab %} -4. Under "Share server statistics with GitHub.com", select the dropdown menu and click **Enabled** or **Disabled**. +1. Under "Share server statistics with GitHub.com", select the dropdown menu and click **Enabled** or **Disabled**. diff --git a/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md b/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md index a401edfcc819..287e55a7dc24 100644 --- a/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md +++ b/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md @@ -29,8 +29,8 @@ For more information on the supported hostname types, see [Section 2.1 of the HT {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.hostname-menu-item %} -4. Under "Hostname", type the hostname you'd like to set for {% data variables.location.product_location %}. -5. To test the DNS and SSL settings for the new hostname, click **Test domain settings**. +1. Under "Hostname", type the hostname you'd like to set for {% data variables.location.product_location %}. +1. To test the DNS and SSL settings for the new hostname, click **Test domain settings**. {% data reusables.enterprise_management_console.test-domain-settings-failure %} {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/configuration/configuring-network-settings/configuring-built-in-firewall-rules.md b/content/admin/configuration/configuring-network-settings/configuring-built-in-firewall-rules.md index 964dd310360c..f24b585d494b 100644 --- a/content/admin/configuration/configuring-network-settings/configuring-built-in-firewall-rules.md +++ b/content/admin/configuration/configuring-network-settings/configuring-built-in-firewall-rules.md @@ -29,7 +29,8 @@ We do not recommend customizing UFW as it can complicate some troubleshooting is ## Viewing the default firewall rules {% data reusables.enterprise_installation.ssh-into-instance %} -2. To view the default firewall rules, use the `sudo ufw status` command. You should see output similar to this: + +1. To view the default firewall rules, use the `sudo ufw status` command. You should see output similar to this: ```shell $ sudo ufw status @@ -67,13 +68,12 @@ We do not recommend customizing UFW as it can complicate some troubleshooting is {% endwarning %} 1. Configure a custom firewall rule. -2. Check the status of each new rule with the `status numbered` command. - +1. Check the status of each new rule with the `status numbered` command. ```shell sudo ufw status numbered ``` -3. To back up your custom firewall rules, use the `cp`command to move the rules to a new file. +1. To back up your custom firewall rules, use the `cp`command to move the rules to a new file. ```shell sudo cp -r /etc/ufw ~/ufw.backup @@ -92,19 +92,20 @@ If something goes wrong after you change the firewall rules, you can reset the r {% endwarning %} {% data reusables.enterprise_installation.ssh-into-instance %} -2. To restore the previous backup rules, copy them back to the firewall with the `cp` command. + +1. To restore the previous backup rules, copy them back to the firewall with the `cp` command. ```shell sudo cp -f ~/ufw.backup/*rules /etc/ufw ``` -3. Restart the firewall with the `systemctl` command. +1. Restart the firewall with the `systemctl` command. ```shell sudo systemctl restart ufw ``` -4. Confirm that the rules are back to their defaults with the `ufw status` command. +1. Confirm that the rules are back to their defaults with the `ufw status` command. ```shell $ sudo ufw status diff --git a/content/admin/configuration/configuring-network-settings/configuring-dns-nameservers.md b/content/admin/configuration/configuring-network-settings/configuring-dns-nameservers.md index 23a58c65f72a..0de5bbcb7ab6 100644 --- a/content/admin/configuration/configuring-network-settings/configuring-dns-nameservers.md +++ b/content/admin/configuration/configuring-network-settings/configuring-dns-nameservers.md @@ -23,20 +23,20 @@ The nameservers you specify must resolve {% data variables.location.product_loca ## Configuring nameservers using the virtual machine console {% data reusables.enterprise_installation.open-vm-console-start %} -2. Configure nameservers for your instance. +1. Configure nameservers for your instance. {% data reusables.enterprise_installation.vm-console-done %} ## Configuring nameservers using the administrative shell {% data reusables.enterprise_installation.ssh-into-instance %} -2. To edit your nameservers, use the `ghe-setup-network` command in visual mode. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-setup-network)." +1. To edit your nameservers, use the `ghe-setup-network` command in visual mode. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-setup-network)." ```shell ghe-setup-network -v ``` -5. To add your new nameserver entries to {% data variables.location.product_location %}, run the following: +1. To add your new nameserver entries to {% data variables.location.product_location %}, run the following: ```shell sudo service resolvconf restart diff --git a/content/admin/configuration/configuring-network-settings/configuring-the-ip-address-using-the-virtual-machine-console.md b/content/admin/configuration/configuring-network-settings/configuring-the-ip-address-using-the-virtual-machine-console.md index 013b705f289f..29f34c89cffd 100644 --- a/content/admin/configuration/configuring-network-settings/configuring-the-ip-address-using-the-virtual-machine-console.md +++ b/content/admin/configuration/configuring-network-settings/configuring-the-ip-address-using-the-virtual-machine-console.md @@ -22,6 +22,6 @@ shortTitle: Set the IP using the console {% endnote %} {% data reusables.enterprise_installation.open-vm-console-start %} -3. Choose to configure the `IPv4` or `IPv6` protocol. -4. Configure options for the protocol you chose. +1. Choose to configure the `IPv4` or `IPv6` protocol. +1. Configure options for the protocol you chose. {% data reusables.enterprise_installation.vm-console-done %} diff --git a/content/admin/configuration/configuring-network-settings/configuring-tls.md b/content/admin/configuration/configuring-network-settings/configuring-tls.md index fbe970c55052..657085d4bad8 100644 --- a/content/admin/configuration/configuring-network-settings/configuring-tls.md +++ b/content/admin/configuration/configuring-network-settings/configuring-tls.md @@ -45,9 +45,9 @@ Your key must be an RSA key and must not have a passphrase. For more information {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} {% data reusables.enterprise_management_console.select-tls-only %} -4. Under "TLS Protocol support", select the protocols you want to allow. -5. Under "Certificate", click **Choose File**, then choose a TLS certificate or certificate chain (in PEM format) to install. This file will usually have a _.pem_, _.crt_, or _.cer_ extension. -6. Under "Unencrypted key", click **Choose File**, then choose an RSA key (in PEM format) to install. This file will usually have a _.key_ extension. +1. Under "TLS Protocol support", select the protocols you want to allow. +1. Under "Certificate", click **Choose File**, then choose a TLS certificate or certificate chain (in PEM format) to install. This file will usually have a _.pem_, _.crt_, or _.cer_ extension. +1. Under "Unencrypted key", click **Choose File**, then choose an RSA key (in PEM format) to install. This file will usually have a _.key_ extension. {% data reusables.enterprise_management_console.save-settings %} @@ -71,11 +71,11 @@ You can also use the `ghe-ssl-acme` command line utility on {% data variables.lo {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} {% data reusables.enterprise_management_console.select-tls-only %} -5. Select **Enable automation of TLS certificate management using Let's Encrypt**. +1. Select **Enable automation of TLS certificate management using Let's Encrypt**. {% data reusables.enterprise_management_console.save-settings %} {% data reusables.enterprise_management_console.privacy %} -7. Click **Request TLS certificate**. -8. Wait for the "Status" to change from "STARTED" to "DONE". +1. Click **Request TLS certificate**. +1. Wait for the "Status" to change from "STARTED" to "DONE". ![Screenshot of the "Requesting TLS Certificate" dialog. At the top of the dialog, "STATUS: DONE" is highlighted with an orange outline.](/assets/images/enterprise/management-console/lets-encrypt-status.png) -9. Click **Save configuration**. +1. Click **Save configuration**. diff --git a/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md b/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md index 11ca6e52e196..06816ba31897 100644 --- a/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md +++ b/content/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer.md @@ -42,7 +42,7 @@ We strongly recommend enabling PROXY protocol support for both your instance and {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} -3. Under "External load balancers", select **Enable support for PROXY protocol**. +1. Under "External load balancers", select **Enable support for PROXY protocol**. {% data reusables.enterprise_management_console.save-settings %} {% data reusables.enterprise_clustering.proxy_protocol_ports %} @@ -60,7 +60,7 @@ We strongly recommend enabling PROXY protocol support for both your instance and {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} -3. Under **External load balancers**, select **Allow HTTP X-Forwarded-For header**. +1. Under **External load balancers**, select **Allow HTTP X-Forwarded-For header**. {% data reusables.enterprise_management_console.save-settings %} {% data reusables.enterprise_clustering.without_proxy_protocol_ports %} diff --git a/content/admin/configuration/configuring-network-settings/validating-your-domain-settings.md b/content/admin/configuration/configuring-network-settings/validating-your-domain-settings.md index 5931acc1b341..d63b1665b4ee 100644 --- a/content/admin/configuration/configuring-network-settings/validating-your-domain-settings.md +++ b/content/admin/configuration/configuring-network-settings/validating-your-domain-settings.md @@ -18,6 +18,6 @@ shortTitle: Validate domain settings {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.hostname-menu-item %} -4. To test your appliance's DNS and SSL settings, under "Hostname", click **Test domain settings**. +1. To test your appliance's DNS and SSL settings, under "Hostname", click **Test domain settings**. {% data reusables.enterprise_management_console.test-domain-settings-failure %} {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-applications.md b/content/admin/configuration/configuring-your-enterprise/configuring-applications.md index 53032708cfe5..fae11dfa3b15 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-applications.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-applications.md @@ -18,8 +18,8 @@ You can choose the amount of time that {% data variables.location.product_locati {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -3. In the "Settings" sidebar, click **Applications**. -4. Under "Avatar image cache time (seconds)", type the number of seconds that you would like {% data variables.location.product_location %} to cache avatar images. +1. In the "Settings" sidebar, click **Applications**. +1. Under "Avatar image cache time (seconds)", type the number of seconds that you would like {% data variables.location.product_location %} to cache avatar images. {% data reusables.enterprise_management_console.save-settings %} {% ifversion status-check-retention %} @@ -31,9 +31,9 @@ You can enable a retention policy for checks, actions, and associated data by se {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} 1. In the "Settings" sidebar, click **Checks**. -2. Select **Enable archiving of Checks-related data**. -3. Under "Archive threshold (days)", type the number of days for the archival threshold. Checks older than this number of days will be archived. -4. Under "Delete threshold (days)", type the number of days for the deletion threshold. Archived checks older than this number of days will be permanently deleted. +1. Select **Enable archiving of Checks-related data**. +1. Under "Archive threshold (days)", type the number of days for the archival threshold. Checks older than this number of days will be archived. +1. Under "Delete threshold (days)", type the number of days for the deletion threshold. Archived checks older than this number of days will be permanently deleted. {% data reusables.enterprise_management_console.save-settings %} {% endif %} diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md b/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md index 13ec9510a8ef..57612d1e75d8 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md @@ -25,34 +25,34 @@ shortTitle: Configure email notifications {% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.email-settings %} -4. Select **Enable email**. This will enable both outbound and inbound email. However, for inbound email to work you will also need to configure your DNS settings as described below in "[Configuring DNS and firewall +1. Select **Enable email**. This will enable both outbound and inbound email. However, for inbound email to work you will also need to configure your DNS settings as described below in "[Configuring DNS and firewall settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." -5. Type the settings for your SMTP server. +1. Type the settings for your SMTP server. - In the **Server address** field, type the address of your SMTP server. - In the **Port** field, type the port that your SMTP server uses to send email. - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. -6. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. -7. Under **Support**, select a type of link to offer additional support to your users. +1. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. +1. Under **Support**, select a type of link to offer additional support to your users. - **Email:** An internal email address. - **URL:** A link to an internal support site. You must include either `http://` or `https://`. -8. [Test email delivery](#testing-email-delivery). +1. [Test email delivery](#testing-email-delivery). {% elsif ghae %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} 1. Under {% octicon "gear" aria-hidden="true" %} **Settings**, click **Email**. -2. Select **Enable email**. -3. Type the settings for your email server. +1. Select **Enable email**. +1. Type the settings for your email server. - In the **Server address** field, type the address of your SMTP server. - In the **Port** field, type the port that your SMTP server uses to send email. - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. -4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. -5. Click **Test email settings**. -6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. -7. Click **Save**. +1. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. +1. Click **Test email settings**. +1. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. +1. Click **Save**. {% endif %} {% ifversion ghes %} @@ -60,8 +60,8 @@ settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-all ## Testing email delivery 1. At the top of the **Email** section, click **Test email settings**. -2. Under "Send test email to," type an address to send the test email to. -3. Click **Send test email**. +1. Under "Send test email to," type an address to send the test email to. +1. Click **Send test email**. {% tip %} @@ -69,8 +69,8 @@ settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-all {% endtip %} -4. If the test email fails, [troubleshoot your email settings](#troubleshooting-email-delivery). -5. When the test email succeeds, under the "Settings" sidebar, click **Save settings**. +1. If the test email fails, [troubleshoot your email settings](#troubleshooting-email-delivery). +1. When the test email succeeds, under the "Settings" sidebar, click **Save settings**. {% data reusables.enterprise_site_admin_settings.wait-for-configuration-run %} {% ifversion require-tls-for-smtp %} @@ -99,9 +99,9 @@ You can enforce TLS encryption for all incoming SMTP connections, which can help If you want to allow email replies to notifications, you must configure your DNS settings. 1. Ensure that port 25 on the instance is accessible to your SMTP server. -2. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. -3. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. -4. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications)." +1. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. +1. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. +1. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications)." ## Troubleshooting email delivery diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md b/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md index 618a2e4d8217..c62d6e8b9b6c 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md @@ -34,7 +34,7 @@ If private mode is enabled on your enterprise, the public cannot access {% data {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.pages-tab %} -4. Select **Public Pages**. +1. Select **Public Pages**. {% data reusables.enterprise_management_console.save-settings %} ## Disabling {% data variables.product.prodname_pages %} for your enterprise diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index b8b10670e732..061dede2b582 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -39,8 +39,8 @@ You can exempt a list of users from API rate limits using the `ghe-config` utili {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. Under "Rate Limiting", select **Enable HTTP API Rate Limiting**. -3. Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits. +1. Under "Rate Limiting", select **Enable HTTP API Rate Limiting**. +1. Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} ## Enabling secondary rate limits @@ -50,11 +50,11 @@ Setting secondary rate limits protects the overall level of service on {% data v {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {%- ifversion ghes %} -2. Under "Rate Limiting", select **Enable Secondary Rate Limiting**. +1. Under "Rate Limiting", select **Enable Secondary Rate Limiting**. {%- else %} -2. Under "Rate Limiting", select **Enable Abuse Rate Limiting**. +1. Under "Rate Limiting", select **Enable Abuse Rate Limiting**. {%- endif %} -3. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. +1. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} ## Enabling rate limits for Git diff --git a/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md b/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md index 3c0a73ab0d30..b89ac78f707c 100644 --- a/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md +++ b/content/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.md @@ -44,10 +44,10 @@ You can perform initial validation of your maintenance operation by configuring {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. In the top navigation bar, click **Maintenance**. +1. In the top navigation bar, click **Maintenance**. ![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Maintenance", is highlighted with an orange outline.](/assets/images/enterprise/management-console/maintenance-tab.png) -3. Under "Enable and schedule", select **Enable maintenance mode**, then decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time. +1. Under "Enable and schedule", select **Enable maintenance mode**, then decide whether to enable maintenance mode immediately or to schedule a maintenance window for a future time. - To enable maintenance mode immediately, select the dropdown menu and click **now**. - To schedule a maintenance window for a future time, select the dropdown menu and click a start time. {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/configuration/configuring-your-enterprise/enabling-private-mode.md b/content/admin/configuration/configuring-your-enterprise/enabling-private-mode.md index cdcd7be106ae..8c90cfebee95 100644 --- a/content/admin/configuration/configuring-your-enterprise/enabling-private-mode.md +++ b/content/admin/configuration/configuring-your-enterprise/enabling-private-mode.md @@ -30,5 +30,5 @@ With private mode enabled, you can allow unauthenticated Git operations (and any {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} -4. Select **Private mode**. +1. Select **Private mode**. {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md b/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md index bfec544eecb4..d8d25645e4c7 100644 --- a/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md +++ b/content/admin/configuration/configuring-your-enterprise/initializing-github-ae.md @@ -43,8 +43,8 @@ To initialize {% data variables.location.product_location %}, you must have a SA ## Signing in and naming your enterprise 1. Follow the instructions in your welcome email to reach your enterprise. -2. Type your credentials under "Change password", then click **Change password**. -3. Under "What would you like your enterprise account to be named?", type the enterprise's name, then click **Save and continue**. +1. Type your credentials under "Change password", then click **Change password**. +1. Under "What would you like your enterprise account to be named?", type the enterprise's name, then click **Save and continue**. ## Connecting your IdP to your enterprise @@ -63,39 +63,39 @@ To configure authentication for {% data variables.product.product_name %}, you m Configuring policies will set limitations for repository and organization management for your enterprise. These can be reconfigured after the initialization process. 1. To the right of "Set your enterprise policies", click **Configure**. -2. Under "Default Repository Permissions", select the drop-down menu and click a default permissions level for repositories in your enterprise. If a person has multiple avenues of access to an organization, either individually, through a team, or as an organization member, the highest permission level overrides any lower permission levels. Optionally, to allow organizations within your enterprise to set their default repository permissions, click **No policy** -3. Under "Repository creation", choose whether you want to allow members to create repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy**. -4. Under "Repository forking", choose whether to allow forking of private and internal repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy** -5. Under "Repository invitations", choose whether members or organization owners can invite collaborators to repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy** -6. Under "Default repository visibility", select the drop-down menu and click the default visibility setting for new repositories. -7. Under "Users can create organizations", select the drop-down menu to enable or disable organization creation access for members of the enterprise. -8. Under "Force pushes", select the drop-down menu and choose whether to allow or block force pushes. -9. Under "Git SSH access", select the drop-down menu and choose whether to enable Git SSH access for all repositories in the enterprise. -10. Optionally, to reset all selections, click "Reset to default policies". -11. Click **Save**. +1. Under "Default Repository Permissions", select the drop-down menu and click a default permissions level for repositories in your enterprise. If a person has multiple avenues of access to an organization, either individually, through a team, or as an organization member, the highest permission level overrides any lower permission levels. Optionally, to allow organizations within your enterprise to set their default repository permissions, click **No policy** +1. Under "Repository creation", choose whether you want to allow members to create repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy**. +1. Under "Repository forking", choose whether to allow forking of private and internal repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy** +1. Under "Repository invitations", choose whether members or organization owners can invite collaborators to repositories. Optionally, to allow organizations within your enterprise to set permissions, click **No policy** +1. Under "Default repository visibility", select the drop-down menu and click the default visibility setting for new repositories. +1. Under "Users can create organizations", select the drop-down menu to enable or disable organization creation access for members of the enterprise. +1. Under "Force pushes", select the drop-down menu and choose whether to allow or block force pushes. +1. Under "Git SSH access", select the drop-down menu and choose whether to enable Git SSH access for all repositories in the enterprise. +1. Optionally, to reset all selections, click "Reset to default policies". +1. Click **Save**. ## Setting your internal support contact You can configure the method your users will use to contact your internal support team. This can be reconfigured after the initialization process. 1. To the right of "Internal support contact", click **Configure**. -2. Under "Internal support contact", select the method for users of your enterprise to contact support, through a URL or an e-mail address. Then, type the support contact information. -3. Click **Save**. +1. Under "Internal support contact", select the method for users of your enterprise to contact support, through a URL or an e-mail address. Then, type the support contact information. +1. Click **Save**. ## Setting your email settings Once this is initialized, you can reconfigure any settings after the initialization process. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)." 1. To the right of "Configure email settings", click **Configure**. -2. Select **Enable email**. This will enable both outbound and inbound email, however, for inbound email to work you will also need to configure your DNS settings. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." -3. Complete your email server settings: +1. Select **Enable email**. This will enable both outbound and inbound email, however, for inbound email to work you will also need to configure your DNS settings. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." +1. Complete your email server settings: - In the **Server address** field, type the address of your SMTP server. - In the **Port** field, type the port that your SMTP server uses to send email. - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. -4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. -5. Click **Test email settings**. -6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. -7. Click **Save**. +1. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. +1. Click **Test email settings**. +1. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. +1. Click **Save**. diff --git a/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md b/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md index 68e3c00cf396..53da530e20b2 100644 --- a/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md +++ b/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list.md @@ -95,7 +95,7 @@ To ensure seamless use of the OIDC CAP while still applying the policy to OAuth {% data reusables.identity-and-permissions.ip-allow-lists-edit-entry %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} {% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} -8. Click **Update**. +1. Click **Update**. {% data reusables.identity-and-permissions.check-ip-address %} ### Checking if an IP address is permitted diff --git a/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md b/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md index 3f0f40617327..16638fb559cf 100644 --- a/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md +++ b/content/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors.md @@ -30,7 +30,7 @@ If you have a Linux machine with OpenSSL installed, you can remove your passphra mv yourdomain.key yourdomain.key.orig ``` -2. Generate a new key without a passphrase. +1. Generate a new key without a passphrase. ```shell openssl rsa -in yourdomain.key.orig -out yourdomain.key @@ -71,19 +71,19 @@ You should be able to download a certificate bundle (for example, `bundle-certif If your {% data variables.product.prodname_ghe_server %} appliance interacts with other machines on your network that use a self-signed or untrusted certificate, you will need to import the signing CA's root certificate into the system-wide certificate store in order to access those systems over HTTPS. 1. Obtain the CA's root certificate from your local certificate authority and ensure it is in PEM format. -2. Copy the file to your {% data variables.product.prodname_ghe_server %} appliance over SSH as the "admin" user on port 122. +1. Copy the file to your {% data variables.product.prodname_ghe_server %} appliance over SSH as the "admin" user on port 122. ```shell scp -P 122 rootCA.crt admin@HOSTNAME:/home/admin ``` -3. Connect to the {% data variables.product.prodname_ghe_server %} administrative shell over SSH as the "admin" user on port 122. +1. Connect to the {% data variables.product.prodname_ghe_server %} administrative shell over SSH as the "admin" user on port 122. ```shell ssh -p 122 admin@HOSTNAME ``` -4. Import the certificate into the system-wide certificate store. +1. Import the certificate into the system-wide certificate store. ```shell ghe-ssl-ca-certificate-install -c rootCA.crt diff --git a/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md b/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md index f6dcd9ac3379..c229250d0626 100644 --- a/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/initializing-the-cluster.md @@ -25,14 +25,14 @@ To deploy a {% data variables.product.product_name %} cluster in your environmen To start setting up the cluster, install the {% data variables.product.prodname_ghe_server %} appliance on each node's virtual machine (VM), then configure an IP address. 1. On each cluster node, provision and install {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance)." -2. Using the administrative shell or DHCP, **only** configure the IP address of each node. Don't configure any other settings. +1. Using the administrative shell or DHCP, **only** configure the IP address of each node. Don't configure any other settings. ## Configuring the first node On the node that will function as your primary MySQL node, install your {% data variables.product.product_name %} license. 1. Connect to the node that will be designated as MySQL primary in `cluster.conf`. For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-clustering/initializing-the-cluster#about-the-cluster-configuration-file)." -2. In your web browser, visit `https://:8443/setup/`. +1. In your web browser, visit `https://:8443/setup/`. {% data reusables.enterprise_installation.upload-a-license-file %} {% data reusables.enterprise_installation.save-settings-in-web-based-mgmt-console %} {% data reusables.enterprise_installation.instance-will-restart-automatically %} @@ -42,7 +42,7 @@ On the node that will function as your primary MySQL node, install your {% data To initialize the cluster, you need a cluster configuration file (`cluster.conf`). For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-clustering/initializing-the-cluster#about-the-cluster-configuration-file)". 1. From the first node that was configured, run `ghe-cluster-config-init`. This will initialize the cluster if there are nodes in the cluster configuration file that are not configured. -2. Run `ghe-cluster-config-apply`. This will validate the `cluster.conf` file, apply the configuration to each node file and bring up the configured services on each node. +1. Run `ghe-cluster-config-apply`. This will validate the `cluster.conf` file, apply the configuration to each node file and bring up the configured services on each node. To check the status of a running cluster use the `ghe-cluster-status` command. diff --git a/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md b/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md index 60c72095f1b3..3804b446c422 100644 --- a/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md @@ -83,16 +83,16 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables ``` {% endnote %} -2. Copy the private key (`id_ed25519`) to the `nagios` home folder and set the appropriate ownership. +1. Copy the private key (`id_ed25519`) to the `nagios` home folder and set the appropriate ownership. ```shell nagiosuser@nagios:~$ sudo cp .ssh/id_ed25519 /var/lib/nagios/.ssh/ nagiosuser@nagios:~$ sudo chown nagios:nagios /var/lib/nagios/.ssh/id_ed25519 ``` -3. To authorize the public key to run _only_ the `ghe-cluster-status -n` command, use a `command=` prefix in the `/data/user/common/authorized_keys` file. From the administrative shell on any node, modify this file to add the public key generated in step 1. For example: `command="/usr/local/bin/ghe-cluster-status -n" ssh-ed25519 AAAA....` +1. To authorize the public key to run _only_ the `ghe-cluster-status -n` command, use a `command=` prefix in the `/data/user/common/authorized_keys` file. From the administrative shell on any node, modify this file to add the public key generated in step 1. For example: `command="/usr/local/bin/ghe-cluster-status -n" ssh-ed25519 AAAA....` -4. Validate and copy the configuration to each node in the cluster by running `ghe-cluster-config-apply` on the node where you modified the `/data/user/common/authorized_keys` file. +1. Validate and copy the configuration to each node in the cluster by running `ghe-cluster-config-apply` on the node where you modified the `/data/user/common/authorized_keys` file. ```shell admin@ghe-data-node-0:~$ ghe-cluster-config-apply @@ -101,14 +101,14 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables > Finished cluster configuration ``` -5. To test that the Nagios plugin can successfully execute the command, run it interactively from Nagios host. +1. To test that the Nagios plugin can successfully execute the command, run it interactively from Nagios host. ```shell nagiosuser@nagios:~$ /usr/lib/nagios/plugins/check_by_ssh -l admin -p 122 -H HOSTNAME -C "ghe-cluster-status -n" -t 30 > OK - No errors detected ``` -6. Create a command definition in your Nagios configuration. +1. Create a command definition in your Nagios configuration. **Example definition** @@ -119,7 +119,7 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables } ``` -7. Add this command to a service definition for a node in the {% data variables.product.prodname_ghe_server %} cluster. +1. Add this command to a service definition for a node in the {% data variables.product.prodname_ghe_server %} cluster. **Example definition** diff --git a/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md b/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md index eb872d2eb00c..2dc30bbfb76f 100644 --- a/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md @@ -24,7 +24,7 @@ topics: {% data reusables.enterprise_installation.hotpatching-explanation %} The hotpatch installation script installs the hotpatch on every node in the cluster and restarts the services in their proper sequence to avoid downtime. 1. Back up your data with [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme). -2. From the administrative shell of any node, use the `ghe-cluster-hotpatch` command to install the latest hotpatch. You can provide a URL for a hotpatch, or manually download the hotpatch and specify a local filename. +1. From the administrative shell of any node, use the `ghe-cluster-hotpatch` command to install the latest hotpatch. You can provide a URL for a hotpatch, or manually download the hotpatch and specify a local filename. ```shell ghe-cluster-hotpatch https://HOTPATCH-URL/FILENAME.hpkg @@ -37,10 +37,10 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve ### Preparing to upgrade 1. Review [Cluster network configuration](/admin/enterprise-management/configuring-clustering/cluster-network-configuration) for the version you are upgrading to, and update your configuration as needed. -2. Back up your data with [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme). -3. Schedule a maintenance window for end users of your {% data variables.product.prodname_ghe_server %} cluster, as it will be unavailable for normal use during the upgrade. Maintenance mode blocks user access and prevents data changes while the cluster upgrade is in progress. -4. On the [{% data variables.product.prodname_ghe_server %} Download Page](https://enterprise.github.com/download), copy the URL for the upgrade _.pkg_ file to the clipboard. -5. From the administrative shell of any node, use the `ghe-cluster-each` command combined with `curl` to download the release package to each node in a single step. Use the URL you copied in the previous step as an argument. +1. Back up your data with [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme). +1. Schedule a maintenance window for end users of your {% data variables.product.prodname_ghe_server %} cluster, as it will be unavailable for normal use during the upgrade. Maintenance mode blocks user access and prevents data changes while the cluster upgrade is in progress. +1. On the [{% data variables.product.prodname_ghe_server %} Download Page](https://enterprise.github.com/download), copy the URL for the upgrade _.pkg_ file to the clipboard. +1. From the administrative shell of any node, use the `ghe-cluster-each` command combined with `curl` to download the release package to each node in a single step. Use the URL you copied in the previous step as an argument. ```shell $ ghe-cluster-each -- "cd /home/admin && curl -L -O https://PACKAGE-URL.pkg" @@ -61,12 +61,12 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve > 100 496M 100 496M 0 0 19.7M 0 0:00:25 0:00:25 --:--:-- 25.5M ``` -6. Identify the primary MySQL node, which is defined as `mysql-master = ` in `cluster.conf`. This node will be upgraded last. +1. Identify the primary MySQL node, which is defined as `mysql-master = ` in `cluster.conf`. This node will be upgraded last. ### Upgrading the cluster nodes 1. Enable maintenance mode according to your scheduled window by connecting to the administrative shell of any cluster node and running `ghe-cluster-maintenance -s`. -2. **With the exception of the primary MySQL node**, connect to the administrative shell of each of the {% data variables.product.prodname_ghe_server %} nodes. +1. **With the exception of the primary MySQL node**, connect to the administrative shell of each of the {% data variables.product.prodname_ghe_server %} nodes. Run the `ghe-upgrade` command, providing the package file name you downloaded in Step 4 of [Preparing to upgrade](#preparing-to-upgrade): ```shell @@ -80,8 +80,8 @@ Run the `ghe-upgrade` command, providing the package file name you downloaded in > gpg: Good signature from "GitHub Enterprise (Upgrade Package Key) > " ``` -3. The upgrade process will reboot the node once it completes. Verify that you can `ping` each node after it reboots. -4. Connect to the administrative shell of the primary MySQL node. Run the `ghe-upgrade` command, providing the package file name you downloaded in Step 4 of [Preparing to upgrade](#preparing-to-upgrade): +1. The upgrade process will reboot the node once it completes. Verify that you can `ping` each node after it reboots. +1. Connect to the administrative shell of the primary MySQL node. Run the `ghe-upgrade` command, providing the package file name you downloaded in Step 4 of [Preparing to upgrade](#preparing-to-upgrade): ```shell $ ghe-upgrade PACKAGE-FILENAME.pkg @@ -94,7 +94,7 @@ Run the `ghe-upgrade` command, providing the package file name you downloaded in > gpg: Good signature from "GitHub Enterprise (Upgrade Package Key) > " ``` -5. The upgrade process will reboot the primary MySQL node once it completes. Verify that you can `ping` each node after it reboots.{% ifversion ghes %} -6. Connect to the administrative shell of the primary MySQL node and run the `ghe-cluster-config-apply` command. -7. When `ghe-cluster-config-apply` is complete, check that the services are in a healthy state by running `ghe-cluster-status`.{% endif %} -8. Exit maintenance mode from the administrative shell of any node by running `ghe-cluster-maintenance -u`. +1. The upgrade process will reboot the primary MySQL node once it completes. Verify that you can `ping` each node after it reboots.{% ifversion ghes %} +1. Connect to the administrative shell of the primary MySQL node and run the `ghe-cluster-config-apply` command. +1. When `ghe-cluster-config-apply` is complete, check that the services are in a healthy state by running `ghe-cluster-status`.{% endif %} +1. Exit maintenance mode from the administrative shell of any node by running `ghe-cluster-maintenance -u`. diff --git a/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index 653e6e20f5cf..3128cd598c6b 100644 --- a/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -52,14 +52,14 @@ This example configuration uses a primary and two replicas, which are located in (replica1)$ ghe-repl-start ``` -2. Create a second replica and use the `ghe-repl-setup --add` command. The `--add` flag prevents it from overwriting the existing replication configuration and adds the new replica to the configuration. +1. Create a second replica and use the `ghe-repl-setup --add` command. The `--add` flag prevents it from overwriting the existing replication configuration and adds the new replica to the configuration. ```shell (replica2)$ ghe-repl-setup --add PRIMARY_IP (replica2)$ ghe-repl-start ``` -3. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter. +1. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter. On the primary: @@ -84,7 +84,7 @@ This example configuration uses a primary and two replicas, which are located in **Tip:** You can set the `--datacenter` and `--active` options at the same time. {% endtip %} -4. An active replica node will store copies of the appliance data and service end user requests. An inactive node will store copies of the appliance data but will be unable to service end user requests. Enable active mode using the `--active` flag or inactive mode using the `--inactive` flag. +1. An active replica node will store copies of the appliance data and service end user requests. An inactive node will store copies of the appliance data but will be unable to service end user requests. Enable active mode using the `--active` flag or inactive mode using the `--inactive` flag. On the first replica: @@ -98,8 +98,7 @@ This example configuration uses a primary and two replicas, which are located in (replica2)$ ghe-repl-node --active ``` -5. To apply the configuration, use the `ghe-config-apply` command on the primary. - +1. To apply the configuration, use the `ghe-config-apply` command on the primary. ```shell (primary)$ ghe-config-apply ``` diff --git a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md index 59b9ee293a4c..2c2ed6e8bad5 100644 --- a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md +++ b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md @@ -44,7 +44,7 @@ The time required to failover depends on how long it takes to manually promote t ghe-repl-status -vv ``` -4. On the replica appliance, to stop replication and promote the replica appliance to primary status, use the `ghe-repl-promote` command. This will also automatically put the primary node in maintenance mode if it’s reachable. +1. On the replica appliance, to stop replication and promote the replica appliance to primary status, use the `ghe-repl-promote` command. This will also automatically put the primary node in maintenance mode if it’s reachable. ```shell ghe-repl-promote @@ -56,10 +56,10 @@ The time required to failover depends on how long it takes to manually promote t {% endnote %} -5. Update the DNS record to point to the IP address of the replica. Traffic is directed to the replica after the TTL period elapses. If you are using a load balancer, ensure it is configured to send traffic to the replica. -6. Notify users that they can resume normal operations. -7. If desired, set up replication from the new primary to existing appliances and the previous primary. For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration#utilities-for-replication-management)." -8. Appliances you do not intend to setup replication to that were part of the high availability configuration prior the failover, need to be removed from the high availability configuration by UUID. +1. Update the DNS record to point to the IP address of the replica. Traffic is directed to the replica after the TTL period elapses. If you are using a load balancer, ensure it is configured to send traffic to the replica. +1. Notify users that they can resume normal operations. +1. If desired, set up replication from the new primary to existing appliances and the previous primary. For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration#utilities-for-replication-management)." +1. Appliances you do not intend to setup replication to that were part of the high availability configuration prior the failover, need to be removed from the high availability configuration by UUID. - On the former appliances, get their UUID via `cat /data/user/common/uuid`. ```shell diff --git a/content/admin/enterprise-management/configuring-high-availability/removing-a-high-availability-replica.md b/content/admin/enterprise-management/configuring-high-availability/removing-a-high-availability-replica.md index 58f246bd4de7..5b80a98a44ac 100644 --- a/content/admin/enterprise-management/configuring-high-availability/removing-a-high-availability-replica.md +++ b/content/admin/enterprise-management/configuring-high-availability/removing-a-high-availability-replica.md @@ -18,13 +18,13 @@ shortTitle: Remove a HA replica ## Stopping replication temporarily 1. If necessary, stop a geo-replication replica from serving user traffic by removing the Geo DNS entries for the replica. -2. On the replica where you wish to temporarily stop replication, run ghe-repl-stop. +1. On the replica where you wish to temporarily stop replication, run ghe-repl-stop. ```shell ghe-repl-stop ``` -3. To start replication again, run `ghe-repl-start`. +1. To start replication again, run `ghe-repl-start`. ```shell ghe-repl-start @@ -33,13 +33,13 @@ shortTitle: Remove a HA replica ## Removing replication permanently 1. If necessary, stop a geo-replication replica from serving user traffic by removing the Geo DNS entries for the replica. -2. On the replica you wish to remove replication from, run `ghe-repl-stop`. +1. On the replica you wish to remove replication from, run `ghe-repl-stop`. ```shell ghe-repl-stop ``` -3. On the replica, to tear down the replication state, run `ghe-repl-teardown`. +1. On the replica, to tear down the replication state, run `ghe-repl-teardown`. ```shell ghe-repl-teardown diff --git a/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md b/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md index 2bb35882ce8e..4eff9c4e62c5 100644 --- a/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md +++ b/content/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard.md @@ -20,7 +20,7 @@ shortTitle: Access the monitor dashboard {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -2. In the top navigation bar, click **Monitor**. +1. In the top navigation bar, click **Monitor**. ![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Monitor", is highlighted with an orange outline.](/assets/images/enterprise/management-console/monitor-dash-link.png) diff --git a/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md b/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md index 8c215b8008a1..b149a0bf29f0 100644 --- a/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md +++ b/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md @@ -21,7 +21,7 @@ topics: If you haven't already set up an external `collectd` server, you will need to do so before enabling `collectd` forwarding on {% data variables.location.product_location %}. Your `collectd` server must be running `collectd` version 5.x or higher. 1. Log into your `collectd` server. -2. Create or edit the `collectd` configuration file to load the network plugin and populate the server and port directives with the proper values. On most distributions, this is located at `/etc/collectd/collectd.conf` +1. Create or edit the `collectd` configuration file to load the network plugin and populate the server and port directives with the proper values. On most distributions, this is located at `/etc/collectd/collectd.conf` An example _collectd.conf_ to run a `collectd` server: diff --git a/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md b/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md index a2fb0544a952..0a1dd932cc1d 100644 --- a/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md +++ b/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md @@ -25,9 +25,9 @@ SNMP is a common standard for monitoring devices over a network. We strongly rec {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.access-monitoring %} {% data reusables.enterprise_management_console.enable-snmp %} -4. In the **Community string** field, enter a new community string. If left blank, this defaults to `public`. +1. In the **Community string** field, enter a new community string. If left blank, this defaults to `public`. {% data reusables.enterprise_management_console.save-settings %} -5. Test your SNMP configuration by running the following command on a separate workstation with SNMP support in your network: +1. Test your SNMP configuration by running the following command on a separate workstation with SNMP support in your network: ```shell # community-string is your community string @@ -50,18 +50,18 @@ If you enable SNMP v3, you can take advantage of increased user based security t {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.access-monitoring %} {% data reusables.enterprise_management_console.enable-snmp %} -4. Select **SNMP v3**. -5. Under "Username", type the unique username of your SNMP v3 user. -6. Select the **Security Level** dropdown menu, then click the security level for your SNMP v3 user. -7. For SNMP v3 users with the `authnopriv` security level, configure authentication. +1. Select **SNMP v3**. +1. Under "Username", type the unique username of your SNMP v3 user. +1. Select the **Security Level** dropdown menu, then click the security level for your SNMP v3 user. +1. For SNMP v3 users with the `authnopriv` security level, configure authentication. - {% data reusables.enterprise_management_console.authentication-password %} - {% data reusables.enterprise_management_console.authentication-protocol %} -8. For SNMP v3 users with the `authpriv` security level, configure authentication. +1. For SNMP v3 users with the `authpriv` security level, configure authentication. - {% data reusables.enterprise_management_console.authentication-password %} - {% data reusables.enterprise_management_console.authentication-protocol %} - Optionally, under "Privacy password", type the privacy password. - Next to "Privacy password", select the **Protocol** dropdown menu, then click the privacy protocol method you want to use. -9. Click **Add user**. +1. Click **Add user**. {% data reusables.enterprise_management_console.save-settings %} ### Querying SNMP data diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks.md index 43fdf06708e6..62344b05d554 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks.md @@ -31,7 +31,7 @@ If a hotpatch is available for an upgrade, the `.hpkg` will download automatical {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.updates-tab %} -4. Click **Yes, automatically check for updates**. +1. Click **Yes, automatically check for updates**. {% data reusables.enterprise_management_console.save-settings %} ## Viewing whether an update is available diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md index 6fe49f4cec18..575a8b1e0a2b 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md @@ -56,8 +56,8 @@ You need to determine the instance type you would like to upgrade to based on CP It's not possible to add CPU or memory resources to an existing AWS/EC2 instance. Instead, you must: 1. Stop the instance. -2. Change the instance type. -3. Start the instance. +1. Change the instance type. +1. Start the instance. {% data reusables.enterprise_installation.configuration-recognized %} ## Adding CPU or memory resources on Microsoft Azure diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md index 7288154f6032..cdf4737d9f59 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity.md @@ -35,32 +35,32 @@ As more users join {% data variables.location.product_location %}, you may need 1. Resize the existing user volume disk using your virtualization platform's tools. {% data reusables.enterprise_installation.ssh-into-instance %} -3. Put the appliance in maintenance mode. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." -4. Reboot the appliance to detect the new storage allocation: +1. Put the appliance in maintenance mode. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." +1. Reboot the appliance to detect the new storage allocation: ```shell sudo reboot ``` -5. Run the `ghe-storage-extend` command to expand the `/data/user` filesystem: +1. Run the `ghe-storage-extend` command to expand the `/data/user` filesystem: ```shell ghe-storage-extend ``` -6. Ensure system services are functioning correctly, then release maintenance mode. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." +1. Ensure system services are functioning correctly, then release maintenance mode. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." ## Increasing the root partition size using a new appliance 1. Set up a new {% data variables.product.prodname_ghe_server %} instance with a larger root disk using the same version as your current appliance. For more information, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance)." -2. Shut down the current appliance: +1. Shut down the current appliance: ```shell sudo poweroff ``` -3. Detach the data disk from the current appliance using your virtualization platform's tools. -4. Attach the data disk to the new appliance with the larger root disk. +1. Detach the data disk from the current appliance using your virtualization platform's tools. +1. Attach the data disk to the new appliance with the larger root disk. ## Increasing the root partition size using an existing appliance diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md index cb29e73eb212..a7ea138c00b5 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance.md @@ -23,7 +23,7 @@ shortTitle: Known issues with upgrades If you upgrade from {% data variables.product.prodname_ghe_server %} 3.7 or 3.8 to 3.9 or later, an upgrade to the database software on your instance will increase I/O utilization. In some cases, this may affect your instance's performance. -{% data variables.product.prodname_ghe_server %} includes a MySQL database server supported by the InnoDB storage engine. {% data variables.product.prodname_ghe_server %} 3.8 and earlier use MySQL 5.7. In October 2023, Oracle will end extended support for MySQL 5.7. For more information, see [Oracle Lifetime Support Policy](https://www.oracle.com/us/support/library/lifetime-support-technology-069183.pdf) on the Oracle Support website. +{% data variables.product.prodname_ghe_server %} includes a MySQL database server supported by the InnoDB storage engine. {% data variables.product.prodname_ghe_server %} 3.8 and earlier use MySQL 5.7. In October 2023, Oracle will end extended support for MySQL 5.1. For more information, see [Oracle Lifetime Support Policy](https://www.oracle.com/us/support/library/lifetime-support-technology-069183.pdf) on the Oracle Support website. To future-proof {% data variables.product.prodname_ghe_server %} and provide the latest security updates, bug fixes, and performance improvements, {% data variables.product.prodname_ghe_server %} 3.9 and later use MySQL 8.0. MySQL 8.0 achieves a higher number of queries per second (QPS) due to a redesigned REDO log. For more information, see [MySQL Performance: 8.0 re-designed REDO log & ReadWrite Workloads Scalability](http://dimitrik.free.fr/blog/archives/2017/10/mysql-performance-80-redesigned-redo-log-readwrite-workloads-scalability.html) on DimitriK's (dim) Weblog. diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md index 9d662115887b..f22bcc692673 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md @@ -27,11 +27,11 @@ To upgrade to the latest version of {% data variables.product.prodname_enterpris ## Prepare for the migration 1. Review the Provisioning and Installation guide and check that all prerequisites needed to provision and configure {% data variables.product.prodname_enterprise %} 2.1.23 in your environment are met. For more information, see "[Provisioning and Installation](/enterprise/2.1/admin/guides/installation/provisioning-and-installation/)." -2. Verify that the current instance is running a supported upgrade version. -3. Set up the latest version of the {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils). +1. Verify that the current instance is running a supported upgrade version. +1. Set up the latest version of the {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils). - If you have already configured scheduled backups using {% data variables.product.prodname_enterprise_backup_utilities %}, make sure you have updated to the latest version. - If you are not currently running scheduled backups, set up {% data variables.product.prodname_enterprise_backup_utilities %}. -4. Take an initial full backup snapshot of the current instance using the `ghe-backup` command. If you have already configured scheduled backups for your current instance, you don't need to take a snapshot of your instance. +1. Take an initial full backup snapshot of the current instance using the `ghe-backup` command. If you have already configured scheduled backups for your current instance, you don't need to take a snapshot of your instance. {% tip %} @@ -39,30 +39,30 @@ To upgrade to the latest version of {% data variables.product.prodname_enterpris {% endtip %} -5. Determine the method for switching user network traffic to the new instance. After you've migrated, all HTTP and Git network traffic directs to the new instance. +1. Determine the method for switching user network traffic to the new instance. After you've migrated, all HTTP and Git network traffic directs to the new instance. - **DNS** - We recommend this method for all environments, as it's simple and works well even when migrating from one datacenter to another. Before starting migration, reduce the existing DNS record's TTL to five minutes or less and allow the change to propagate. Once the migration is complete, update the DNS record(s) to point to the IP address of the new instance. - **IP address assignment** - This method is only available on VMware to VMware migration and is not recommended unless the DNS method is unavailable. Before starting the migration, you'll need to shut down the old instance and assign its IP address to the new instance. -6. Schedule a maintenance window. The maintenance window should include enough time to transfer data from the backup host to the new instance and will vary based on the size of the backup snapshot and available network bandwidth. During this time your current instance will be unavailable and in maintenance mode while you migrate to the new instance. +1. Schedule a maintenance window. The maintenance window should include enough time to transfer data from the backup host to the new instance and will vary based on the size of the backup snapshot and available network bandwidth. During this time your current instance will be unavailable and in maintenance mode while you migrate to the new instance. ## Perform the migration 1. Provision a new {% data variables.product.prodname_enterprise %} 2.1 instance. For more information, see the "[Provisioning and Installation](/enterprise/2.1/admin/guides/installation/provisioning-and-installation/)" guide for your target platform. -2. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. -3. Set an admin password. -5. Click **Migrate**. -6. In the "Add new SSH key" text field, paste your backup host access SSH key. -7. Click **Add key** and then click **Continue**. -8. Copy the `ghe-restore` command that you'll run on the backup host to migrate data to the new instance. -9. Enable maintenance mode on the old instance and wait for all active processes to complete. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." +1. In a browser, navigate to the new replica appliance's IP address and upload your {% data variables.product.prodname_enterprise %} license. +1. Set an admin password. +1. Click **Migrate**. +1. In the "Add new SSH key" text field, paste your backup host access SSH key. +1. Click **Add key** and then click **Continue**. +1. Copy the `ghe-restore` command that you'll run on the backup host to migrate data to the new instance. +1. Enable maintenance mode on the old instance and wait for all active processes to complete. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." - {% note %} + {% note %} - **Note:** The instance will be unavailable for normal use from this point forward. + **Note:** The instance will be unavailable for normal use from this point forward. - {% endnote %} + {% endnote %} -10. On the backup host, run the `ghe-backup` command to take a final backup snapshot. This ensures that all data from the old instance is captured. -11. On the backup host, run the `ghe-restore` command you copied on the new instance's restore status screen to restore the latest snapshot. +1. On the backup host, run the `ghe-backup` command to take a final backup snapshot. This ensures that all data from the old instance is captured. +1. On the backup host, run the `ghe-restore` command you copied on the new instance's restore status screen to restore the latest snapshot. ```shell $ ghe-restore 169.254.1.1 @@ -84,15 +84,15 @@ To upgrade to the latest version of {% data variables.product.prodname_enterpris Visit https://169.254.1.1/setup/settings to review appliance configuration. ``` -12. Return to the new instance's restore status screen to see that the restore completed. -13. Click **Continue to settings** to review and adjust the configuration information and settings that were imported from the previous instance. -14. Click **Save settings**. +1. Return to the new instance's restore status screen to see that the restore completed. +1. Click **Continue to settings** to review and adjust the configuration information and settings that were imported from the previous instance. +1. Click **Save settings**. - {% note %} + {% note %} - **Note:** You can use the new instance after you've applied configuration settings and restarted the server. + **Note:** You can use the new instance after you've applied configuration settings and restarted the server. - {% endnote %} + {% endnote %} -15. Switch user network traffic from the old instance to the new instance using either DNS or IP address assignment. -16. Upgrade to the latest patch release of {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)." +1. Switch user network traffic from the old instance to the new instance using either DNS or IP address assignment. +1. Upgrade to the latest patch release of {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)." diff --git a/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md b/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md index a7b26a63a516..b2c6238ebcac 100644 --- a/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md +++ b/content/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise.md @@ -170,8 +170,8 @@ By default, {% data variables.product.prodname_actions %} workflow runs that are There are three ways to resolve this problem: 1. You can update your workflows so that they are no longer triggered by {% data variables.product.prodname_dependabot %} using an expression like: `if: github.actor != 'dependabot[bot]'`. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." -2. You can modify your workflows to use a two-step process that includes `pull_request_target` which does not have these limitations. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#responding-to-events)." -3. You can provide workflows triggered by {% data variables.product.prodname_dependabot %} access to secrets and allow the `permissions` term to increase the default scope of the `GITHUB_TOKEN`. For more information, see "[Providing workflows triggered by{% data variables.product.prodname_dependabot %} access to secrets and increased permissions](#providing-workflows-triggered-by-dependabot-access-to-secrets-and-increased-permissions)" below. +1. You can modify your workflows to use a two-step process that includes `pull_request_target` which does not have these limitations. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#responding-to-events)." +1. You can provide workflows triggered by {% data variables.product.prodname_dependabot %} access to secrets and allow the `permissions` term to increase the default scope of the `GITHUB_TOKEN`. For more information, see "[Providing workflows triggered by{% data variables.product.prodname_dependabot %} access to secrets and increased permissions](#providing-workflows-triggered-by-dependabot-access-to-secrets-and-increased-permissions)" below. ### Providing workflows triggered by {% data variables.product.prodname_dependabot %} access to secrets and increased permissions diff --git a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md index 6441893dd36d..692453603d76 100644 --- a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md +++ b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md @@ -70,7 +70,7 @@ If you specify more than 14 concurrent runners on a VM, you must also update the 1. Provision self-hosted runners, at the repository, organization, or enterprise account level. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)." -2. Set up the self-hosted runners with the requirements described above. For example, on a VM running Ubuntu 20.04 you would:{% ifversion ghes < 3.5 %} +1. Set up the self-hosted runners with the requirements described above. For example, on a VM running Ubuntu 20.04 you would:{% ifversion ghes < 3.5 %} - Verify that Git is installed: `command -v git`{% endif %} - Install Docker and ensure that the runner users have access to Docker. For more information, see the Docker documentation. @@ -79,6 +79,6 @@ If you specify more than 14 concurrent runners on a VM, you must also update the - Alternative approach: [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) - Verify that the runners have access to the public internet and can only access the internal networks that {% data variables.product.prodname_dependabot %} needs. -3. Assign a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)." +1. Assign a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)." -4. Optionally, enable workflows triggered by {% data variables.product.prodname_dependabot %} to use more than read-only permissions and to have access to any secrets that are normally available. For more information, see "[AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#enabling-workflows-triggered-by-dependabot-access-to-dependabot-secrets-and-increased-permissions)." +1. Optionally, enable workflows triggered by {% data variables.product.prodname_dependabot %} to use more than read-only permissions and to have access to any secrets that are normally available. For more information, see "[AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#enabling-workflows-triggered-by-dependabot-access-to-dependabot-secrets-and-increased-permissions)." diff --git a/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider.md b/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider.md index e897b1f3734f..d261908f13ac 100644 --- a/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider.md +++ b/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider.md @@ -37,9 +37,9 @@ If you configure built-in authentication and a person successfully authenticates {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -4. Under "Authentication", select your authentication method. -5. Select **Allow creation of accounts with built-in authentication**. -6. Read the warning, then click **Ok**. +1. Under "Authentication", select your authentication method. +1. Select **Allow creation of accounts with built-in authentication**. +1. Read the warning, then click **Ok**. {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.2fa_is_available %} diff --git a/content/admin/identity-and-access-management/using-built-in-authentication/configuring-built-in-authentication.md b/content/admin/identity-and-access-management/using-built-in-authentication/configuring-built-in-authentication.md index 7520771be7e5..860b4cd8d06c 100644 --- a/content/admin/identity-and-access-management/using-built-in-authentication/configuring-built-in-authentication.md +++ b/content/admin/identity-and-access-management/using-built-in-authentication/configuring-built-in-authentication.md @@ -32,7 +32,7 @@ You can prevent unauthenticated people from creating new user accounts on your i {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -4. Under "Authentication", select **Built in authentication**. +1. Under "Authentication", select **Built in authentication**. {% data reusables.enterprise_user_management.two_factor_auth_header %} {% data reusables.enterprise_user_management.2fa_is_available %} diff --git a/content/admin/identity-and-access-management/using-built-in-authentication/disabling-unauthenticated-sign-ups.md b/content/admin/identity-and-access-management/using-built-in-authentication/disabling-unauthenticated-sign-ups.md index 066b066d5114..ecf4d143b060 100644 --- a/content/admin/identity-and-access-management/using-built-in-authentication/disabling-unauthenticated-sign-ups.md +++ b/content/admin/identity-and-access-management/using-built-in-authentication/disabling-unauthenticated-sign-ups.md @@ -31,5 +31,5 @@ shortTitle: Block unauthenticated sign-up {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.privacy %} -3. Deselect **Enable sign-up**. +1. Deselect **Enable sign-up**. {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md b/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md index 4f1be36afb74..1a3128cbcbcc 100644 --- a/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md +++ b/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md @@ -45,6 +45,6 @@ No other attributes are available. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.authentication %} -3. Under "Authentication", select **CAS**. -4. {% data reusables.enterprise_user_management.built-in-authentication-option %} -5. In the **Server URL** field, type the full URL of your CAS server. If your CAS server uses a certificate that can't be validated by {% data variables.product.prodname_ghe_server %}, you can use the `ghe-ssl-ca-certificate-install` command to install it as a trusted certificate. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-ssl-ca-certificate-install)." +1. Under "Authentication", select **CAS**. +1. {% data reusables.enterprise_user_management.built-in-authentication-option %} +1. In the **Server URL** field, type the full URL of your CAS server. If your CAS server uses a certificate that can't be validated by {% data variables.product.prodname_ghe_server %}, you can use the `ghe-ssl-ca-certificate-install` command to install it as a trusted certificate. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-ssl-ca-certificate-install)." diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md index 286ee6e025aa..e90fdb04d3c9 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md @@ -124,7 +124,7 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w 1. After you log in as the setup user, we recommend enabling two-factor authentication. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)." -2. To get started, configure {% ifversion oidc-for-emu %}how your members will authenticate. If you are using Azure Active Directory as your identity provider, you can choose between OpenID Connect (OIDC) and Security Assertion Markup Language (SAML). We recommend OIDC, which includes support for Conditional Access Policies (CAP). If you require multiple enterprises with {% data variables.enterprise.prodname_managed_users %} provisioned from one tenant, you must use SAML for each enterprise after the first. If you are using another identity provider, like Okta or PingFederate (public beta), you can use SAML to authenticate your members.{% else %}SAML SSO for your enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users)."{% endif %} +1. To get started, configure {% ifversion oidc-for-emu %}how your members will authenticate. If you are using Azure Active Directory as your identity provider, you can choose between OpenID Connect (OIDC) and Security Assertion Markup Language (SAML). We recommend OIDC, which includes support for Conditional Access Policies (CAP). If you require multiple enterprises with {% data variables.enterprise.prodname_managed_users %} provisioned from one tenant, you must use SAML for each enterprise after the first. If you are using another identity provider, like Okta or PingFederate (public beta), you can use SAML to authenticate your members.{% else %}SAML SSO for your enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users)."{% endif %} {%- ifversion oidc-for-emu %} @@ -134,9 +134,9 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w - "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)." {%- endif %} -4. Once you have configured SSO, you can configure SCIM provisioning. SCIM is how your identity provider will create {% data variables.enterprise.prodname_managed_users %} on {% data variables.product.prodname_dotcom_the_website %}. For more information on configuring SCIM provisioning, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users)." +1. Once you have configured SSO, you can configure SCIM provisioning. SCIM is how your identity provider will create {% data variables.enterprise.prodname_managed_users %} on {% data variables.product.prodname_dotcom_the_website %}. For more information on configuring SCIM provisioning, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users)." -5. Once authentication and provisioning are configured, you can start managing organization membership for your {% data variables.enterprise.prodname_managed_users %} by synchronizing IdP groups with teams. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." +1. Once authentication and provisioning are configured, you can start managing organization membership for your {% data variables.enterprise.prodname_managed_users %} by synchronizing IdP groups with teams. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." If members of your enterprise must use one workstation to contribute to repositories on {% data variables.location.product_location %} from both a {% data variables.enterprise.prodname_managed_user %} and a personal account, you can provide support. For more information, see "[Supporting developers with multiple user accounts on {% data variables.product.prodname_dotcom_the_website %}](#supporting-developers-with-multiple-user-accounts-on-githubcom)." diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users.md index fb77a61a91a4..5d8e13e95e73 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-oidc-for-enterprise-managed-users.md @@ -47,7 +47,7 @@ OIDC does not support IdP-initiated authentication. {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} 1. Under "OpenID Connect single sign-on", select **Require OIDC single sign-on**. -2. To continue setup and be redirected to Azure AD, click **Save**. +1. To continue setup and be redirected to Azure AD, click **Save**. {% data reusables.enterprise-accounts.emu-azure-admin-consent %} {% data reusables.enterprise-accounts.download-recovery-codes %} 1. Click **Enable OIDC Authentication**. diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md index 5e4ec91b1931..dd59580cfd04 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-saml-single-sign-on-for-enterprise-managed-users.md @@ -48,8 +48,8 @@ To install and configure the {% data variables.product.prodname_emu_idp_applicat {% endnote %} 1. [Configuring your identity provider](#configuring-your-identity-provider) -2. [Configuring your enterprise](#configuring-your-enterprise) -3. [Enabling provisioning](#enabling-provisioning) +1. [Configuring your enterprise](#configuring-your-enterprise) +1. [Enabling provisioning](#enabling-provisioning) ### Configuring your identity provider @@ -65,15 +65,15 @@ To configure your IdP, follow the instructions they provide for configuring the {% indented_data_reference reusables.enterprise-accounts.public-beta-pingfed-for-emu spaces=3 %} -2. To configure the {% data variables.product.prodname_emu_idp_application %} application and your IdP, click the link below and follow the instructions provided by your IdP: +1. To configure the {% data variables.product.prodname_emu_idp_application %} application and your IdP, click the link below and follow the instructions provided by your IdP: - [Azure Active Directory tutorial for {% data variables.product.prodname_emus %}](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-enterprise-managed-user-tutorial) - [Okta documentation for {% data variables.product.prodname_emus %}](https://saml-doc.okta.com/SAML_Docs/How-to-Configure-SAML-2.0-for-GitHub-Enterprise-Managed-User.html) - [PingFederate documentation for {% data variables.product.prodname_emus %}](https://docs.pingidentity.com/r/en-us/pingfederate-github-emu-connector/pingfederate_github_emu_connector) (public beta) -3. So you can test and configure your enterprise, assign yourself or the user that will be configuring SAML SSO on {% data variables.product.prodname_dotcom %} to the {% data variables.product.prodname_emu_idp_application %} application on your IdP. +1. So you can test and configure your enterprise, assign yourself or the user that will be configuring SAML SSO on {% data variables.product.prodname_dotcom %} to the {% data variables.product.prodname_emu_idp_application %} application on your IdP. -4. To enable you to continue configuring your enterprise on {% data variables.product.prodname_dotcom %}, locate and note the following information from the application you installed on your IdP. +1. To enable you to continue configuring your enterprise on {% data variables.product.prodname_dotcom %}, locate and note the following information from the application you installed on your IdP. | Value | Other names | Description | | :- | :- | :- | diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users-with-okta.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users-with-okta.md index 659613477726..b39a541d8b86 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users-with-okta.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users-with-okta.md @@ -59,7 +59,7 @@ After your {% data variables.enterprise.prodname_emu_enterprise %} has been crea 1. Click the **Sign On** tab. 1. To make changes, click **Edit**. 1. Under "Advanced Sign-on Settings", in the "Enterprise Name" text box, type your enterprise name. For example, if you access your enterprise at `https://github.com/enterprises/octoinc`, your enterprise name would be "octoinc". -2. To save your enterprise name, click **Save**. +1. To save your enterprise name, click **Save**. ## Configuring provisioning @@ -73,12 +73,12 @@ To configure provisioning, the setup user with the **@SHORT-CODE_admin* 1. To make changes, click **Edit**. 1. Select **Enable API integration**. 1. In the "API Token" field, enter the {% data variables.product.pat_v1 %} with the **admin:enterprise** scope belonging to the setup user. -2. Click **Test API Credentials**. If the test is successful, a verification message will appear at the top of the screen. -3. To save the token, click **Save**. -4. In the settings menu, click **To App**. -5. To the right of "Provisioning to App", to allow changes to be made, click **Edit**. -6. Select **Enable** to the right of **Create Users**, **Update User Attributes**, and **Deactivate Users**. -7. To finish configuring provisioning, click **Save**. +1. Click **Test API Credentials**. If the test is successful, a verification message will appear at the top of the screen. +1. To save the token, click **Save**. +1. In the settings menu, click **To App**. +1. To the right of "Provisioning to App", to allow changes to be made, click **Edit**. +1. Select **Enable** to the right of **Create Users**, **Update User Attributes**, and **Deactivate Users**. +1. To finish configuring provisioning, click **Save**. ## Assigning users and groups diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md index ef973871177e..34e35228f9e8 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users.md @@ -48,14 +48,14 @@ To configure provisioning for your {% data variables.enterprise.prodname_emu_ent {% data reusables.user-settings.personal_access_tokens %} {% data reusables.user-settings.generate_new_token %} 1. Under **Note**, give your token a descriptive name. -2. Select the **Expiration** dropdown menu, then click **No expiration**. -3. Select the **admin:enterprise** scope. +1. Select the **Expiration** dropdown menu, then click **No expiration**. +1. Select the **admin:enterprise** scope. ![Screenshot of a list of scopes with checkboxes. The "admin:enterprise" scope, accompanied by the text "Full control of enterprises," is selected and highlighted with an orange outline.](/assets/images/help/enterprises/enterprise-pat-scope.png) -4. Click **Generate token**. -5. To copy the token to your clipboard, click {% octicon "copy" aria-label="Copy token" %}. +1. Click **Generate token**. +1. To copy the token to your clipboard, click {% octicon "copy" aria-label="Copy token" %}. ![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens.png) -6. To save the token for use later, store the new token securely in a password manager. +1. To save the token for use later, store the new token securely in a password manager. ## Configuring provisioning for {% data variables.product.prodname_emus %} diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups.md index 972b43b8cb8e..34c9fbbbd104 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups.md @@ -87,6 +87,6 @@ You can review a list of IdP groups, see any teams connected to an IdP group, an {% data reusables.enterprise-accounts.access-enterprise %} 1. To review a list of IdP groups, in the left sidebar, click {% octicon "key" aria-hidden="true" %} **Identity provider**. -2. To see the members and teams connected to an IdP group, click the group's name. +1. To see the members and teams connected to an IdP group, click the group's name. -3. To view the teams connected to the IdP group, click **Teams**. +1. To view the teams connected to the IdP group, click **Teams**. diff --git a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md index 8f2bb8f07b00..536936086a05 100644 --- a/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md +++ b/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md @@ -46,23 +46,23 @@ To migrate your enterprise from SAML to OIDC, you will disable your existing {% {% data reusables.emus.use-enterprise-recovery-code %} {% data reusables.enterprise-accounts.security-tab %} 1. At the bottom of the page, next to "Migrate to OpenID Connect single sign-on", click **Configure with Azure**. -2. Read the warning, then click "I understand, begin migrating to OpenID Connect". +1. Read the warning, then click "I understand, begin migrating to OpenID Connect". {% data reusables.enterprise-accounts.emu-azure-admin-consent %} 1. After you grant consent, a new browser window will open to {% data variables.location.product_location %} and display a new set of recovery codes for your {% data variables.enterprise.prodname_emu_enterprise %}. Download the codes, then click "Enable OIDC authentication". -2. Wait for the migration to complete, which can take up to an hour. To check the status of the migration, navigate to your enterprise's authentication security settings page. If "Require SAML authentication" is selected, the migration is still in progress. +1. Wait for the migration to complete, which can take up to an hour. To check the status of the migration, navigate to your enterprise's authentication security settings page. If "Require SAML authentication" is selected, the migration is still in progress. {% warning %} **Warning:** Do not provision new users from the application on Azure AD during the migration. {% endwarning %} -3. In a new tab or window, while signed in as the setup user on {% data variables.product.prodname_dotcom_the_website %}, create a {% data variables.product.pat_v1 %} with the **admin:enterprise** scope and **no expiration** and copy it to your clipboard. For more information about creating a new token, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users#creating-a-personal-access-token)." -4. In the provisioning settings for the {% data variables.product.prodname_emu_idp_oidc_application %} application in Azure Portal, under "Tenant URL", type `https://api.github.com/scim/v2/enterprises/YOUR_ENTERPRISE`, replacing YOUR_ENTERPRISE with the name of your enterprise account. +1. In a new tab or window, while signed in as the setup user on {% data variables.product.prodname_dotcom_the_website %}, create a {% data variables.product.pat_v1 %} with the **admin:enterprise** scope and **no expiration** and copy it to your clipboard. For more information about creating a new token, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users#creating-a-personal-access-token)." +1. In the provisioning settings for the {% data variables.product.prodname_emu_idp_oidc_application %} application in Azure Portal, under "Tenant URL", type `https://api.github.com/scim/v2/enterprises/YOUR_ENTERPRISE`, replacing YOUR_ENTERPRISE with the name of your enterprise account. For example, if your enterprise account's URL is `https://github.com/enterprises/octo-corp`, the name of the enterprise account is `octo-corp`. -5. Under "Secret token", paste the {% data variables.product.pat_v1 %} with the **admin:enterprise** scope that you created earlier. -6. To test the configuration, click **Test Connection**. -7. To save your changes, at the top of the form, click **Save**. -8. In Azure Portal, copy the users and groups from the old {% data variables.product.prodname_emu_idp_application %} application to the new {% data variables.product.prodname_emu_idp_oidc_application %} application. -9. Test your configuration by provisioning a single new user. -10. If your test is successful, start provisioning for all users by clicking **Start provisioning**. +1. Under "Secret token", paste the {% data variables.product.pat_v1 %} with the **admin:enterprise** scope that you created earlier. +1. To test the configuration, click **Test Connection**. +1. To save your changes, at the top of the form, click **Save**. +1. In Azure Portal, copy the users and groups from the old {% data variables.product.prodname_emu_idp_application %} application to the new {% data variables.product.prodname_emu_idp_oidc_application %} application. +1. Test your configuration by provisioning a single new user. +1. If your test is successful, start provisioning for all users by clicking **Start provisioning**. diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md index 9bd951394fdb..f088b56b6441 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise.md @@ -159,7 +159,7 @@ After you enable SCIM on a {% data variables.product.product_name %} instance, a {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} 1. Under "SCIM User Provisioning", select **Require SCIM user provisioning**. -2. Click **Save**. +1. Click **Save**. {%- endif %} 1. Configure user provisioning in the application for {% data variables.product.product_name %} on your IdP.{% ifversion scim-for-ghes %} To request documentation for a supported IdP, contact your account manager on {% data variables.contact.contact_enterprise_sales %}. If your IdP is unsupported, you must create the application and configure SCIM manually.{% elsif ghae %} diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise.md index d51d640b9f7a..cbd22cb47680 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise.md @@ -55,8 +55,8 @@ You can also configure and manage team synchronization for an individual organiz {% data reusables.identity-and-permissions.team-sync-confirm-saml %} {% data reusables.identity-and-permissions.enable-team-sync-azure %} {% data reusables.identity-and-permissions.team-sync-confirm %} -7. Review the details for the IdP tenant you want to connect to your enterprise account, then click **Approve**. -8. To disable team synchronization, under "Team synchronization", click **Disable team synchronization**. +1. Review the details for the IdP tenant you want to connect to your enterprise account, then click **Approve**. +1. To disable team synchronization, under "Team synchronization", click **Disable team synchronization**. {% ifversion team-sync-manage-org-invites %} diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md index 8000216609b3..d8a2b2bdf752 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md @@ -57,9 +57,9 @@ You can map a team in your enterprise to an Okta group you previously pushed to {% 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. +1. Under "Identity Provider Group", select the drop-down menu and click an identity provider group. ![Drop-down menu to choose identity provider group.](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png) -7. Click **Save changes**. +1. Click **Save changes**. ## Checking the status of your mapped teams diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md index 04bb726a43dd..83f852ecf4ab 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md @@ -61,9 +61,9 @@ AMIs for {% data variables.product.prodname_ghe_server %} are available in the A ### Using the {% data variables.product.prodname_ghe_server %} portal to select an AMI {% data reusables.enterprise_installation.download-appliance %} -3. Under "{% data variables.product.prodname_dotcom %} in the Cloud", select the "Select your platform" dropdown menu, and click **Amazon Web Services**. -4. Select the "Select your AWS region" drop-down menu, and click your desired region. -5. Take note of the AMI ID that is displayed. +1. Under "{% data variables.product.prodname_dotcom %} in the Cloud", select the "Select your platform" dropdown menu, and click **Amazon Web Services**. +1. Select the "Select your AWS region" drop-down menu, and click your desired region. +1. Take note of the AMI ID that is displayed. ### Using the AWS CLI to select an AMI @@ -76,7 +76,7 @@ AMIs for {% data variables.product.prodname_ghe_server %} are available in the A --output=text ``` -2. Take note of the AMI ID for the latest {% data variables.product.prodname_ghe_server %} image. +1. Take note of the AMI ID for the latest {% data variables.product.prodname_ghe_server %} image. ## Creating a security group @@ -88,9 +88,9 @@ If you're setting up your AMI for the first time, you will need to create a secu aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION" ``` -2. Take note of the security group ID (`sg-xxxxxxxx`) of your newly created security group. +1. Take note of the security group ID (`sg-xxxxxxxx`) of your newly created security group. -3. Create a security group rule for each of the ports in the table below. For more information, see "[authorize-security-group-ingress](https://docs.aws.amazon.com/cli/latest/reference/ec2/authorize-security-group-ingress.html)" in the AWS documentation. +1. Create a security group rule for each of the ports in the table below. For more information, see "[authorize-security-group-ingress](https://docs.aws.amazon.com/cli/latest/reference/ec2/authorize-security-group-ingress.html)" in the AWS documentation. ```shell aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md index 4de686cc0d78..ec920ea3b6f0 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md @@ -45,7 +45,7 @@ Before launching {% data variables.location.product_location %} on Azure, you'll az vm image list --all -f GitHub-Enterprise | grep '"urn":' | sort -V ``` -2. Create a new VM using the appliance image you found. For more information, see "[`az vm create`](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_create)" in the Microsoft documentation. +1. Create a new VM using the appliance image you found. For more information, see "[`az vm create`](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_create)" in the Microsoft documentation. Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "[Resource groups](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-overview#resource-groups)" in the Microsoft documentation. @@ -53,7 +53,7 @@ Before launching {% data variables.location.product_location %} on Azure, you'll az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS ``` -3. Configure the security settings on your VM to open up required ports. For more information, see "[`az vm open-port`](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open. +1. Configure the security settings on your VM to open up required ports. For more information, see "[`az vm open-port`](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open. ```shell az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER @@ -63,7 +63,7 @@ Before launching {% data variables.location.product_location %} on Azure, you'll {% data reusables.enterprise_installation.necessary_ports %} -4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[`az vm disk attach`](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation. +1. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[`az vm disk attach`](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation. Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `200`), and a name for the resulting VHD. diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md index c08b885d6a39..3d2c8ca615f9 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md @@ -41,7 +41,7 @@ Before launching {% data variables.location.product_location %} on Google Cloud gcloud compute images list --project github-enterprise-public --no-standard-images ``` -2. Take note of the image name for the latest GCE image of {% data variables.product.prodname_ghe_server %}. +1. Take note of the image name for the latest GCE image of {% data variables.product.prodname_ghe_server %}. ## Configuring the firewall @@ -53,7 +53,7 @@ GCE virtual machines are created as a member of a network, which has a firewall. gcloud compute networks create NETWORK-NAME --subnet-mode auto ``` -2. Create a firewall rule for each of the ports in the table below. For more information, see "[gcloud compute firewall-rules](https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/)" in the Google documentation. +1. Create a firewall rule for each of the ports in the table below. For more information, see "[gcloud compute firewall-rules](https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/)" in the Google documentation. ```shell $ gcloud compute firewall-rules create RULE-NAME \ @@ -81,7 +81,7 @@ To create the {% data variables.product.prodname_ghe_server %} instance, you'll gcloud compute disks create DATA-DISK-NAME --size DATA-DISK-SIZE --type DATA-DISK-TYPE --zone ZONE ``` -2. Then create an instance using the name of the {% data variables.product.prodname_ghe_server %} image you selected, and attach the data disk. For more information, see "[gcloud compute instances create](https://cloud.google.com/sdk/gcloud/reference/compute/instances/create)" in the Google documentation. +1. Then create an instance using the name of the {% data variables.product.prodname_ghe_server %} image you selected, and attach the data disk. For more information, see "[gcloud compute instances create](https://cloud.google.com/sdk/gcloud/reference/compute/instances/create)" in the Google documentation. ```shell $ gcloud compute instances create INSTANCE-NAME \ diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md index 29bf2e08352e..7ab7c04b5d8b 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md @@ -29,8 +29,8 @@ shortTitle: Install on Hyper-V {% data reusables.enterprise_installation.download-license %} {% data reusables.enterprise_installation.download-appliance %} -4. Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click **Hyper-V (VHD)**. -5. Click **Download for Hyper-V (VHD)**. +1. Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click **Hyper-V (VHD)**. +1. Click **Download for Hyper-V (VHD)**. ## Creating the {% data variables.product.prodname_ghe_server %} instance @@ -48,25 +48,25 @@ shortTitle: Install on Hyper-V PS C:\> New-VHD -Path PATH_TO_DATA_DISK -SizeBytes DISK_SIZE ``` -3. Attach the data disk to your instance. For more information, see "[Add-VMHardDiskDrive](https://docs.microsoft.com/powershell/module/hyper-v/add-vmharddiskdrive?view=win10-ps)" in the Microsoft documentation. +1. Attach the data disk to your instance. For more information, see "[Add-VMHardDiskDrive](https://docs.microsoft.com/powershell/module/hyper-v/add-vmharddiskdrive?view=win10-ps)" in the Microsoft documentation. ```shell PS C:\> Add-VMHardDiskDrive -VMName VM_NAME -Path PATH_TO_DATA_DISK ``` -4. Start the VM. For more information, see "[Start-VM](https://docs.microsoft.com/powershell/module/hyper-v/start-vm?view=win10-ps)" in the Microsoft documentation. +1. Start the VM. For more information, see "[Start-VM](https://docs.microsoft.com/powershell/module/hyper-v/start-vm?view=win10-ps)" in the Microsoft documentation. ```shell PS C:\> Start-VM -Name VM_NAME ``` -5. Get the IP address of your VM. For more information, see "[Get-VMNetworkAdapter](https://docs.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapter?view=win10-ps)" in the Microsoft documentation. +1. Get the IP address of your VM. For more information, see "[Get-VMNetworkAdapter](https://docs.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapter?view=win10-ps)" in the Microsoft documentation. ```shell PS C:\> (Get-VMNetworkAdapter -VMName VM_NAME).IpAddresses ``` -6. Copy the VM's IP address and paste it into a web browser. +1. Copy the VM's IP address and paste it into a web browser. ## Configuring the {% data variables.product.prodname_ghe_server %} instance diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-openstack-kvm.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-openstack-kvm.md index 5f65f144bfcd..8e097366a391 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-openstack-kvm.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-openstack-kvm.md @@ -28,8 +28,8 @@ shortTitle: Install on OpenStack {% data reusables.enterprise_installation.download-license %} {% data reusables.enterprise_installation.download-appliance %} -4. Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click **OpenStack KVM (QCOW2)**. -5. Click **Download for OpenStack KVM (QCOW2)**. +1. Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click **OpenStack KVM (QCOW2)**. +1. Click **Download for OpenStack KVM (QCOW2)**. ## Creating the {% data variables.product.prodname_ghe_server %} instance @@ -37,11 +37,11 @@ shortTitle: Install on OpenStack 1. In OpenStack Horizon, upload the {% data variables.product.prodname_ghe_server %} image you downloaded. For instructions, see the "Upload an image" section of the OpenStack guide "[Upload and manage images](https://docs.openstack.org/horizon/latest/user/manage-images.html)." {% data reusables.enterprise_installation.create-attached-storage-volume %} For instructions, see the OpenStack guide "[Create and manage volumes](https://docs.openstack.org/horizon/latest/user/manage-volumes.html)." -3. Create a security group, and add a new security group rule for each port in the table below. For instructions, see the OpenStack guide "[Configure access and security for instances](https://docs.openstack.org/horizon/latest/user/configure-access-and-security-for-instances.html)." +1. Create a security group, and add a new security group rule for each port in the table below. For instructions, see the OpenStack guide "[Configure access and security for instances](https://docs.openstack.org/horizon/latest/user/configure-access-and-security-for-instances.html)." {% data reusables.enterprise_installation.necessary_ports %} -4. Optionally, associate a floating IP to the instance. Depending on your OpenStack setup, you may need to allocate a floating IP to the project and associate it to the instance. Contact your system administrator to determine if this is the case for you. For more information, see "[Allocate a floating IP address to an instance](https://docs.openstack.org/horizon/latest/user/configure-access-and-security-for-instances.html#allocate-a-floating-ip-address-to-an-instance)" in the OpenStack documentation. -5. Launch {% data variables.location.product_location %} using the image, data volume, and security group created in the previous steps. For instructions, see the OpenStack guide "[Launch and manage instances](https://docs.openstack.org/horizon/latest/user/launch-instances.html)." +1. Optionally, associate a floating IP to the instance. Depending on your OpenStack setup, you may need to allocate a floating IP to the project and associate it to the instance. Contact your system administrator to determine if this is the case for you. For more information, see "[Allocate a floating IP address to an instance](https://docs.openstack.org/horizon/latest/user/configure-access-and-security-for-instances.html#allocate-a-floating-ip-address-to-an-instance)" in the OpenStack documentation. +1. Launch {% data variables.location.product_location %} using the image, data volume, and security group created in the previous steps. For instructions, see the OpenStack guide "[Launch and manage instances](https://docs.openstack.org/horizon/latest/user/launch-instances.html)." ## Configuring the {% data variables.product.prodname_ghe_server %} instance diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-vmware.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-vmware.md index 9ec4e41bbd21..d856abb327de 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-vmware.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-vmware.md @@ -32,8 +32,8 @@ shortTitle: Install on VMware {% data reusables.enterprise_installation.download-license %} {% data reusables.enterprise_installation.download-appliance %} -4. Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click **VMware ESXi/vSphere (OVA)**. -5. Click **Download for VMware ESXi/vSphere (OVA)**. +1. Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click **VMware ESXi/vSphere (OVA)**. +1. Click **Download for VMware ESXi/vSphere (OVA)**. ## Creating the {% data variables.product.prodname_ghe_server %} instance diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance.md index 8a535875b865..76d822b8d58a 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance.md @@ -43,12 +43,12 @@ You can set up a staging instance from scratch and configure the instance howeve Alternatively, you can create a staging instance that reflects your production configuration by restoring a backup of your production instance to the staging instance. 1. [Back up your production instance](#1-back-up-your-production-instance). -2. [Set up a staging instance](#2-set-up-a-staging-instance). -3. [Configure {% data variables.product.prodname_actions %}](#3-configure-github-actions). -4. [Configure {% data variables.product.prodname_registry %}](#4-configure-github-packages). -5. [Restore your production backup](#5-restore-your-production-backup). -6. [Review the instance's configuration](#6-review-the-instances-configuration). -7. [Apply the instance's configuration](#7-apply-the-instances-configuration). +1. [Set up a staging instance](#2-set-up-a-staging-instance). +1. [Configure {% data variables.product.prodname_actions %}](#3-configure-github-actions). +1. [Configure {% data variables.product.prodname_registry %}](#4-configure-github-packages). +1. [Restore your production backup](#5-restore-your-production-backup). +1. [Review the instance's configuration](#6-review-the-instances-configuration). +1. [Apply the instance's configuration](#7-apply-the-instances-configuration). ### 1. Back up your production instance @@ -68,7 +68,7 @@ If you plan to restore a backup of your production instance, continue to the nex ### 3. Configure {% data variables.product.prodname_actions %} -Optionally, if you use {% data variables.product.prodname_actions %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_actions %}, skip to "[4. Configure {% data variables.product.prodname_registry %}](#4-configure-github-packages)." +Optionally, if you use {% data variables.product.prodname_actions %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_actions %}, skip to "[1. Configure {% data variables.product.prodname_registry %}](#4-configure-github-packages)." {% warning %} @@ -88,7 +88,7 @@ Optionally, if you use {% data variables.product.prodname_actions %} on your pro ### 4. Configure {% data variables.product.prodname_registry %} -Optionally, if you use {% data variables.product.prodname_registry %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_registry %}, skip to "[5. Restore your production backup](#5-restore-your-production-backup)." +Optionally, if you use {% data variables.product.prodname_registry %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_registry %}, skip to "[1. Restore your production backup](#5-restore-your-production-backup)." {% warning %} diff --git a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/activity-dashboard.md b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/activity-dashboard.md index 1be241fb0166..9edfe819a719 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/activity-dashboard.md +++ b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/activity-dashboard.md @@ -28,4 +28,4 @@ The Activity dashboard provides weekly, monthly, and yearly graphs of the number 1. At the top of any page, click **Explore**. ![Screenshot of the navigation bar at the top of the web UI for GitHub Enterprise Server. The word "Explore" is highlighted with an orange outline.](/assets/images/enterprise/settings/ent-new-explore.png) -2. In the upper-right corner of the page, click {% octicon "pulse" aria-hidden="true" %} **Activity**. +1. In the upper-right corner of the page, click {% octicon "pulse" aria-hidden="true" %} **Activity**. diff --git a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md index e19af27ce84b..74d35b67993e 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md +++ b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding.md @@ -33,17 +33,17 @@ When you enable log forwarding, you must upload a CA certificate to encrypt comm 1. In the **Server address** field, type the address of the server to which you want to forward logs. You can specify multiple addresses in a comma-separated list. 1. In the Protocol drop-down menu, select the protocol to use to communicate with the log server. The protocol will apply to all specified log destinations. 1. Optionally, select **Enable TLS**. We recommend enabling TLS according to your local security policies, especially if there are untrusted networks between the appliance and any remote log servers. -2. To encrypt communication between syslog endpoints, click **Choose File** and choose a CA certificate for the remote syslog server. You should upload a CA bundle containing a concatenation of the certificates of the CAs involved in signing the certificate of the remote log server. The entire certificate chain will be validated, and must terminate in a root certificate. +1. To encrypt communication between syslog endpoints, click **Choose File** and choose a CA certificate for the remote syslog server. You should upload a CA bundle containing a concatenation of the certificates of the CAs involved in signing the certificate of the remote log server. The entire certificate chain will be validated, and must terminate in a root certificate. {% elsif ghae %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} 1. Under {% octicon "gear" aria-label="The Settings gear" %} **Settings**, click **Log forwarding**. -2. Under "Log forwarding", select **Enable log forwarding**. -3. Under "Server address", enter the address of the server you want to forward logs to. -4. Select the "Protocol" dropdown menu and click a protocol. -5. Optionally, to encrypt communication between syslog endpoints using TLS, select **Enable TLS**. -6. Under "Public certificate", paste your x509 certificate. -7. Click **Save**. +1. Under "Log forwarding", select **Enable log forwarding**. +1. Under "Server address", enter the address of the server you want to forward logs to. +1. Select the "Protocol" dropdown menu and click a protocol. +1. Optionally, to encrypt communication between syslog endpoints using TLS, select **Enable TLS**. +1. Under "Public certificate", paste your x509 certificate. +1. Click **Save**. {% endif %} {% ifversion ghes %} diff --git a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/managing-global-webhooks.md b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/managing-global-webhooks.md index 5a74829debc9..5fa55528e01a 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/managing-global-webhooks.md +++ b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/managing-global-webhooks.md @@ -60,11 +60,11 @@ For example, you can configure {% data variables.location.product_location %} to {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.hooks-tab %} -5. Next to the webhook you'd like to edit, click **Edit**. +1. Next to the webhook you'd like to edit, click **Edit**. ![Screenshot of the "Webhooks" page. To the right of a webhook, the "Edit" button is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/edit-global-webhook-button.png) -6. Update the webhook's settings. -7. Click **Update webhook**. +1. Update the webhook's settings. +1. Click **Update webhook**. ## Deleting a global webhook @@ -80,9 +80,9 @@ For example, you can configure {% data variables.location.product_location %} to {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.hooks-tab %} -5. In the list of webhooks, click the URL of the webhook for which you'd like to see deliveries. +1. In the list of webhooks, click the URL of the webhook for which you'd like to see deliveries. ![Screenshot of a list of global webhooks. The URL link to view a webhook is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/click-global-webhook.png) -6. Under "Recent deliveries", click a delivery GUID to view details. +1. Under "Recent deliveries", click a delivery GUID to view details. ![Screenshot of the "Recent deliveries" list for a global webhook. A delivery GUID in the list of deliveries is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/global-webhooks-recent-deliveries.png) diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md index 505542c88dd5..d4ff57c40a37 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/configuring-the-audit-log-for-your-enterprise.md @@ -29,7 +29,7 @@ You can configure a retention period for audit log data for {% data variables.lo {% data reusables.enterprise-accounts.audit-log-tab %} {% data reusables.audit_log.audit-data-retention-tab %} 1. Under "Configure audit log retention settings", select the dropdown menu and click a retention period. -2. Click **Save**. +1. Click **Save**. {% ifversion enable-git-events %} @@ -58,6 +58,6 @@ Before you can enable Git events in the audit log, you must configure a retentio {% endnote %} ![Screenshot of the audit log. The checkbox to enable Git events in the audit log is highlighted with an orange outline.](/assets/images/help/enterprises/enable-git-events-checkbox.png) -2. Click **Save**. +1. Click **Save**. {% endif %} diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 3c471016db46..3e54286e607d 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -77,7 +77,7 @@ For information on creating or accessing your access key ID and secret key, see {% data reusables.enterprise.navigate-to-log-streaming-tab %} {% data reusables.audit_log.streaming-choose-s3 %}{% ifversion streaming-oidc-s3 %} 1. Under "Authentication", click **Access keys**.{% endif %} -2. Configure the stream settings. +1. Configure the stream settings. - Under "Bucket", type the name of the bucket you want to stream to. For example, `auditlog-streaming-test`. - Under "Access Key ID", type your access key ID. For example, `ABCAIOSFODNN7EXAMPLE1`. @@ -152,8 +152,8 @@ To configure the stream in {% data variables.product.prodname_dotcom %} you need **On {% data variables.product.prodname_dotcom %}**: {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Select the **Configure stream** dropdown menu and click **Azure Blob Storage**. -2. On the configuration page, enter the blob SAS URL that you copied in Azure. The **Container** field is auto-filled based on the URL. -3. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Blob Storage endpoint. +1. On the configuration page, enter the blob SAS URL that you copied in Azure. The **Container** field is auto-filled based on the URL. +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Blob Storage endpoint. {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} @@ -166,20 +166,20 @@ You need two pieces of information about your event hub: its instance name and t **On Microsoft Azure portal**: 1. At the top of the page, next to "Microsoft Azure", use the search box to search for "Event Hubs". 1. Select **Event Hubs**. The names of your event hubs are listed. -2. Make a note of the name of the event hub to which you want to stream. Click the event hub. -3. In the left menu, click **Shared Access Policies**. -4. Select a shared access policy from the list of policies, or create a new policy. -5. Copy the connection string from the **Connection string-primary key** field. +1. Make a note of the name of the event hub to which you want to stream. Click the event hub. +1. In the left menu, click **Shared Access Policies**. +1. Select a shared access policy from the list of policies, or create a new policy. +1. Copy the connection string from the **Connection string-primary key** field. **On {% data variables.product.prodname_dotcom %}**: {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Select the **Configure stream** dropdown menu and click **Azure Event Hubs**. -2. On the configuration page, enter: +1. On the configuration page, enter: - The name of the Azure Event Hubs instance. - The connection string. -3. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Events Hub endpoint. +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Events Hub endpoint. {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} @@ -196,11 +196,11 @@ After you set up streaming to Datadog, you can see your audit log data by filter {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Select the **Configure stream** dropdown menu and click **Datadog**. -2. In the **Token** field, paste the token you copied earlier. +1. In the **Token** field, paste the token you copied earlier. -3. Select the **Site** dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. +1. Select the **Site** dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. -4. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} 1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. @@ -217,11 +217,11 @@ To set up streaming to Google Cloud Storage, you must create a service account i {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Select the **Configure stream** dropdown menu and click **Google Cloud Storage**. -2. Under "Bucket", type the name of your Google Cloud Storage bucket. +1. Under "Bucket", type the name of your Google Cloud Storage bucket. -3. Under "JSON Credentials", paste the entire contents of the file for your service account's JSON key. +1. Under "JSON Credentials", paste the entire contents of the file for your service account's JSON key. -4. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Google Cloud Storage bucket, click **Check endpoint**. +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Google Cloud Storage bucket, click **Check endpoint**. {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} @@ -232,7 +232,7 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Select the **Configure stream** dropdown menu and click **Splunk**. -2. On the configuration page, enter: +1. On the configuration page, enter: - The domain on which the application you want to stream to is hosted. If you're using Splunk Cloud, `Domain` should be `http-inputs-`, where `host` is the domain you use in Splunk Cloud. For example, `http-inputs-mycompany.splunkcloud.com`. @@ -247,10 +247,10 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma - A token that {% data variables.product.prodname_dotcom %} can use to authenticate to the third-party application. -3. Leave the **Enable SSL verification** check box selected. +1. Leave the **Enable SSL verification** check box selected. Audit logs are always streamed as encrypted data, however, with this option selected, {% data variables.product.prodname_dotcom %} verifies the SSL certificate of your Splunk instance when delivering events. SSL verification helps ensure that events are delivered to your URL endpoint securely. You can clear the selection of this option, but we recommend you leave SSL verification enabled. -4. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Splunk endpoint. +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Splunk endpoint. {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} {% ifversion pause-audit-log-stream %} @@ -266,7 +266,7 @@ Datadog only accepts logs from up to 18 hours in the past. If you pause a stream {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. To the right of your configured stream, click **Pause stream**. -2. A confirmation message is displayed. Click **Pause stream** to confirm. +1. A confirmation message is displayed. Click **Pause stream** to confirm. When the application is ready to receive audit logs again, click **Resume stream** to restart streaming audit logs. {% endif %} @@ -292,5 +292,5 @@ When the application is ready to receive audit logs again, click **Resume stream {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.audit-log-tab %} 1. Under "Audit log", click **Settings**. -2. Under "API Requests", select **Enable API Request Events**. -3. {% endif %} +1. Under "API Requests", select **Enable API Request Events**. +1. {% endif %} diff --git a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index b7116349a20f..d79f38d9eba3 100644 --- a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -39,7 +39,7 @@ For more information about your options, see the official [MinIO docs](https://d mkdir -p $MINIO_DIR ``` -2. Install MinIO. +1. Install MinIO. ```shell docker pull minio/minio @@ -47,7 +47,7 @@ For more information about your options, see the official [MinIO docs](https://d For more information, see the official "[MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide)." -3. Sign in to MinIO using your MinIO access key and secret. +1. Sign in to MinIO using your MinIO access key and secret. {% linux %} @@ -76,7 +76,7 @@ For more information about your options, see the official [MinIO docs](https://d echo $MINIO_SECRET_KEY ``` -4. Run MinIO in your chosen mode. +1. Run MinIO in your chosen mode. - Run MinIO using Docker on a single host: @@ -100,7 +100,7 @@ For more information about your options, see the official [MinIO docs](https://d docker pull minio/mc ``` -2. Create a bucket with a host URL that {% data variables.product.prodname_ghe_server %} can access. +1. Create a bucket with a host URL that {% data variables.product.prodname_ghe_server %} can access. - Local deployments example: diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise.md index fd409e223ab1..dcac36c4b068 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise.md @@ -29,6 +29,6 @@ Across all organizations owned by your enterprise, you can control whether organ {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} -3. Under "{% octicon "law" aria-hidden="true" %} Policies", click **Organizations**. -4. Under "Dependency insights", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "Dependency insights", select the the dropdown menu and click a policy. +1. Under "{% octicon "law" aria-hidden="true" %} Policies", click **Organizations**. +1. Under "Dependency insights", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Dependency insights", select the the dropdown menu and click a policy. diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md index 936a5f5909fb..f1c7aadbf5b8 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md @@ -36,8 +36,8 @@ Across all organizations owned by your enterprise, you can enable or disable org {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.projects-tab %} -4. Under "Organization projects", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "Organization projects", select the dropdown menu and click a policy. +1. Under "Organization projects", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Organization projects", select the dropdown menu and click a policy. {% ifversion project-visibility-policy %} @@ -65,6 +65,6 @@ Across all organizations owned by your enterprise, you can enable or disable rep {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.projects-tab %} -4. Under "Repository projects", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "Repository projects", select the dropdown menu and click a policy. +1. Under "Repository projects", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Repository projects", select the dropdown menu and click a policy. {% endif %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index 74c9f59ae6ab..fa575a61e265 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -63,10 +63,10 @@ Before you require use of two-factor authentication, we recommend notifying orga {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} -4. Under "Two-factor authentication", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "Two-factor authentication", select **Require two-factor authentication for all organizations in your business**, then click **Save**. -6. If prompted, read the information about members and outside collaborators who will be removed from the organizations owned by your enterprise. To confirm the change, type your enterprise's name, then click **Remove members & require two-factor authentication**. -7. Optionally, if any members or outside collaborators are removed from the organizations owned by your enterprise, we recommend sending them an invitation to reinstate their former privileges and access to your organization. Each person must enable two-factor authentication before they can accept your invitation. +1. Under "Two-factor authentication", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Two-factor authentication", select **Require two-factor authentication for all organizations in your business**, then click **Save**. +1. If prompted, read the information about members and outside collaborators who will be removed from the organizations owned by your enterprise. To confirm the change, type your enterprise's name, then click **Remove members & require two-factor authentication**. +1. Optionally, if any members or outside collaborators are removed from the organizations owned by your enterprise, we recommend sending them an invitation to reinstate their former privileges and access to your organization. Each person must enable two-factor authentication before they can accept your invitation. {% endif %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 2e885096b930..a7327c9a2038 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -76,8 +76,8 @@ Across all organizations owned by your enterprise, you can set a base repository {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -4. Under "Base permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "Base permissions", select the dropdown menu and click a policy. +1. Under "Base permissions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Base permissions", select the dropdown menu and click a policy. ## Enforcing a policy for repository creation @@ -96,7 +96,7 @@ If you allow members to create repositories in your organizations, you can choos {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. Under "Repository creation", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Repository creation", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} {% data reusables.enterprise-accounts.repo-creation-policy %} {% data reusables.enterprise-accounts.repo-creation-types %} {%- ifversion enterprise-namespace-repo-setting %} @@ -123,9 +123,9 @@ People with admin permissions can set a more granular forking policy. For more i {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 1. Under "Repository forking", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -2. Under "Repository forking", select the dropdown menu and click a policy. +1. Under "Repository forking", select the dropdown menu and click a policy. {%- ifversion innersource-fork-policies %} -5. If forking is enabled, select a policy for where users are allowed to fork repositories. +1. If forking is enabled, select a policy for where users are allowed to fork repositories. {%- endif %} ## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories @@ -135,8 +135,8 @@ Across all organizations owned by your enterprise, you can allow members to invi {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -3. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -4. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", select the dropdown menu and click a policy. +1. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", select the dropdown menu and click a policy. ## Enforcing a policy for the default branch name @@ -168,7 +168,7 @@ Across all organizations owned by your enterprise, you can allow members with ad {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -5. Under "Repository deletion and transfer", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Repository deletion and transfer", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} {% data reusables.enterprise-accounts.repository-deletion-policy %} @@ -178,8 +178,8 @@ Across all organizations owned by your enterprise, you can allow members with ad {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} -3. On the **Repository policies** tab, under "Repository issue deletion", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -4. Under "Repository issue deletion", select the dropdown menu and click a policy. +1. On the **Repository policies** tab, under "Repository issue deletion", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Repository issue deletion", select the dropdown menu and click a policy. {% ifversion ghes or ghae %} @@ -271,7 +271,7 @@ You can override the default inherited settings by configuring the settings for 1. Under "Repository default settings" in the "Force pushes" section, select a policy. - To block force pushes to all branches, select **Block**. - To only block force pushes to the default branch, select **Block to the default branch**. -6. Optionally, to override repository-specific settings, select **Enforce on all repositories**. Note that this will **not** override an enterprise-wide policy. +1. Optionally, to override repository-specific settings, select **Enforce on all repositories**. Note that this will **not** override an enterprise-wide policy. ![Screenshot of the "Repository default settings" policy section. The "Enforce on all repositories" checkbox is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/user/user-block-all-force-pushes.png) diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-team-policies-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-team-policies-in-your-enterprise.md index 2f320eae2ddd..c2fd380d58f8 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-team-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-team-policies-in-your-enterprise.md @@ -33,7 +33,7 @@ Across all organizations owned by your enterprise, you can enable or disable tea {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} -3. Under "{% octicon "law" aria-hidden="true" %} Policies", click **Teams**. -4. Under "Team discussions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -5. Under "Team discussions", select the dropdown menu and click a policy. +1. Under "{% octicon "law" aria-hidden="true" %} Policies", click **Teams**. +1. Under "Team discussions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Team discussions", select the dropdown menu and click a policy. {% endif %} diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md index 2b24f9186114..d1ccfe497e28 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md @@ -25,14 +25,14 @@ If you have a specific requirement that isn't met by this environment, such as s You can use a Linux container management tool to build a pre-receive hook environment. This example uses [Alpine Linux](https://www.alpinelinux.org/) and [Docker](https://www.docker.com/). {% data reusables.linux.ensure-docker %} -2. Create the file `Dockerfile.alpine-3.3` that contains this information: +1. Create the file `Dockerfile.alpine-3.3` that contains this information: ``` FROM gliderlabs/alpine:3.3 RUN apk add --no-cache git bash ``` -3. From the working directory that contains `Dockerfile.alpine-3.3`, build an image: +1. From the working directory that contains `Dockerfile.alpine-3.3`, build an image: ```shell $ docker build -f Dockerfile.alpine-3.3 -t pre-receive.alpine-3.3 . @@ -45,13 +45,13 @@ You can use a Linux container management tool to build a pre-receive hook enviro > Successfully built 0250ab3be9c5 ``` -4. Create a container: +1. Create a container: ```shell docker create --name pre-receive.alpine-3.3 pre-receive.alpine-3.3 /bin/true ``` -5. Export the Docker container to a `gzip` compressed `tar` file: +1. Export the Docker container to a `gzip` compressed `tar` file: ```shell docker export pre-receive.alpine-3.3 | gzip > alpine-3.3.tar.gz @@ -62,7 +62,7 @@ You can use a Linux container management tool to build a pre-receive hook enviro ## Creating a pre-receive hook environment using chroot 1. Create a Linux `chroot` environment. -2. Create a `gzip` compressed `tar` file of the `chroot` directory. +1. Create a `gzip` compressed `tar` file of the `chroot` directory. ```shell cd /path/to/chroot @@ -95,7 +95,7 @@ For more information about creating a chroot environment see "[Chroot](https://w 1. Upload a readable `*.tar.gz` file that contains your environment to a web host and copy the URL or transfer the file to the {% data variables.product.prodname_ghe_server %} appliance via `scp`. When using `scp`, you may need to adjust the `*.tar.gz` file permissions so that the file is world readable. 1. Connect to the administrative shell. -2. Use the `ghe-hook-env-create` command and type the name you want for the environment as the first argument and the full local path or URL of a `*.tar.gz` file that contains your environment as the second argument. +1. Use the `ghe-hook-env-create` command and type the name you want for the environment as the first argument and the full local path or URL of a `*.tar.gz` file that contains your environment as the second argument. ```shell admin@ghe-host:~$ ghe-hook-env-create AlpineTestEnv /home/admin/alpine-3.3.tar.gz diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md index c0d22134e7c6..527c41422dad 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md @@ -141,14 +141,14 @@ We recommend consolidating hooks to a single repository. If the consolidated hoo git update-index --chmod=+x SCRIPT_FILE.sh ``` -2. Commit and push to the designated repository for pre-receive hooks on {% data variables.location.product_location %}. +1. Commit and push to the designated repository for pre-receive hooks on {% data variables.location.product_location %}. ```shell git commit -m "YOUR COMMIT MESSAGE" git push ``` -3. [Create the pre-receive hook](/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance#creating-pre-receive-hooks) on the {% data variables.product.prodname_ghe_server %} instance. +1. [Create the pre-receive hook](/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance#creating-pre-receive-hooks) on the {% data variables.product.prodname_ghe_server %} instance. ## Testing pre-receive scripts locally @@ -156,7 +156,7 @@ You can test a pre-receive hook script locally before you create or update it on {% data reusables.linux.ensure-docker %} -2. Create a file called `Dockerfile.dev` containing: +1. Create a file called `Dockerfile.dev` containing: ```dockerfile FROM gliderlabs/alpine:3.3 @@ -178,7 +178,7 @@ You can test a pre-receive hook script locally before you create or update it on CMD ["/usr/sbin/sshd", "-D"] ``` -3. Create a test pre-receive script called `always_reject.sh`. This example script will reject all pushes, which is useful for locking a repository: +1. Create a test pre-receive script called `always_reject.sh`. This example script will reject all pushes, which is useful for locking a repository: ``` #!/usr/bin/env bash @@ -187,13 +187,13 @@ You can test a pre-receive hook script locally before you create or update it on exit 1 ``` -4. Ensure the `always_reject.sh` scripts has execute permissions: +1. Ensure the `always_reject.sh` scripts has execute permissions: ```shell chmod +x always_reject.sh ``` -5. From the directory containing `Dockerfile.dev`, build an image: +1. From the directory containing `Dockerfile.dev`, build an image: ```shell $ docker build -f Dockerfile.dev -t pre-receive.dev . @@ -216,32 +216,32 @@ You can test a pre-receive hook script locally before you create or update it on > Successfully built dd8610c24f82 ``` -6. Run a data container that contains a generated SSH key: +1. Run a data container that contains a generated SSH key: ```shell docker run --name data pre-receive.dev /bin/true ``` -7. Copy the test pre-receive hook `always_reject.sh` into the data container: +1. Copy the test pre-receive hook `always_reject.sh` into the data container: ```shell docker cp always_reject.sh data:/home/git/test.git/hooks/pre-receive ``` -8. Run an application container that runs `sshd` and executes the hook. Take note of the container id that is returned: +1. Run an application container that runs `sshd` and executes the hook. Take note of the container id that is returned: ```shell $ docker run -d -p 52311:22 --volumes-from data pre-receive.dev > 7f888bc700b8d23405dbcaf039e6c71d486793cad7d8ae4dd184f4a47000bc58 ``` -9. Copy the generated SSH key from the data container to the local machine: +1. Copy the generated SSH key from the data container to the local machine: ```shell docker cp data:/home/git/.ssh/id_ed25519 . ``` -10. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repository you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine. +1. Modify the remote of a test repository and push to the `test.git` repo within the Docker container. This example uses `git@github.com:octocat/Hello-World.git` but you can use any repository you want. This example assumes your local machine (127.0.0.1) is binding port 52311, but you can use a different IP address if docker is running on a remote machine. ```shell $ git clone git@github.com:octocat/Hello-World.git diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md index 670970f94879..af4fe17e2e75 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md @@ -41,7 +41,7 @@ shortTitle: Manage pre-receive hooks {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.hooks-tab %} -2. Next to the pre-receive hook that you want to delete, click **Delete**. +1. Next to the pre-receive hook that you want to delete, click **Delete**. ## Configure pre-receive hooks for an organization @@ -49,8 +49,8 @@ An organization owner can only configure hook permissions for an organization if {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -4. In the left sidebar, click **Hooks**. -5. Next to the pre-receive hook that you want to configure, select the **Hook permissions** dropdown menu, then click an option. +1. In the left sidebar, click **Hooks**. +1. Next to the pre-receive hook that you want to configure, select the **Hook permissions** dropdown menu, then click an option. ## Configure pre-receive hooks for a repository diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md b/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md index e7a98d02735c..af5404fe2f10 100644 --- a/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md +++ b/content/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md @@ -48,11 +48,11 @@ New organizations you create within your enterprise account settings are include Enterprise owners who create an organization owned by the enterprise account automatically become organization owners. For more information about organization owners, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." {% data reusables.enterprise-accounts.access-enterprise %} -2. On the **Organizations** tab, above the list of organizations, click **New organization**. -3. Under "Organization name", type a name for your organization. -4. Click **Create organization**. -5. Optionally, under "Invite owners", type the username of a person you'd like to invite to become an organization owner, then click **Invite**. -6. Click **Finish**. +1. On the **Organizations** tab, above the list of organizations, click **New organization**. +1. Under "Organization name", type a name for your organization. +1. Click **Create organization**. +1. Optionally, under "Invite owners", type the username of a person you'd like to invite to become an organization owner, then click **Invite**. +1. Click **Finish**. ## Inviting an organization to join your enterprise account @@ -87,5 +87,5 @@ Enterprise owners can transfer existing organizations between enterprise account {% data reusables.enterprise-accounts.organization-settings-dropdown %} 1. Select the **Select enterprise** dropdown menu, start typing the name of the destination enterprise, and click the enterprise you want to transfer the organization to. -2. Click **Review transfer**. -3. To confirm the transfer, click **Transfer organization**. +1. Click **Review transfer**. +1. To confirm the transfer, click **Transfer organization**. diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise/managing-projects-using-jira.md b/content/admin/user-management/managing-organizations-in-your-enterprise/managing-projects-using-jira.md index bc294a0d519b..5502b4010d5e 100644 --- a/content/admin/user-management/managing-organizations-in-your-enterprise/managing-projects-using-jira.md +++ b/content/admin/user-management/managing-organizations-in-your-enterprise/managing-projects-using-jira.md @@ -40,10 +40,10 @@ shortTitle: Project management with Jira ## Jira instance configuration 1. On your Jira instance, log into an account with administrative access. -2. At the top of the page, click the settings (gear) icon and choose **Applications**. -3. In the left sidebar, under **Integrations**, click **DVCS accounts**. -4. Click **Link Bitbucket Cloud or {% data variables.product.prodname_dotcom %} account**. -5. In the **Add New Account** modal, fill in your {% data variables.product.prodname_enterprise %} settings: +1. At the top of the page, click the settings (gear) icon and choose **Applications**. +1. In the left sidebar, under **Integrations**, click **DVCS accounts**. +1. Click **Link Bitbucket Cloud or {% data variables.product.prodname_dotcom %} account**. +1. In the **Add New Account** modal, fill in your {% data variables.product.prodname_enterprise %} settings: - From the **Host** dropdown menu, choose **{% data variables.product.prodname_enterprise %}**. - In the **Team or User Account** field, type the name of your {% data variables.product.prodname_enterprise %} organization or user account. - In the **OAuth Key** field, type the Client ID of your {% data variables.product.prodname_enterprise %} developer application. @@ -51,5 +51,5 @@ shortTitle: Project management with Jira - If you don't want to link new repositories owned by your {% data variables.product.prodname_enterprise %} organization or user account, deselect **Auto Link New Repositories**. - If you don't want to enable smart commits, deselect **Enable Smart Commits**. - Click **Add**. -6. Review the permissions you are granting to your {% data variables.product.prodname_enterprise %} account and click **Authorize application**. -7. If necessary, type your password to continue. +1. Review the permissions you are granting to your {% data variables.product.prodname_enterprise %} account and click **Authorize application**. +1. If necessary, type your password to continue. diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise/removing-organizations-from-your-enterprise.md b/content/admin/user-management/managing-organizations-in-your-enterprise/removing-organizations-from-your-enterprise.md index d2cb72a2d866..17804409e57b 100644 --- a/content/admin/user-management/managing-organizations-in-your-enterprise/removing-organizations-from-your-enterprise.md +++ b/content/admin/user-management/managing-organizations-in-your-enterprise/removing-organizations-from-your-enterprise.md @@ -27,8 +27,8 @@ You can remove an organization that is owned by your enterprise account, so the ## Removing an organization from your enterprise {% data reusables.enterprise-accounts.access-enterprise %} -2. Under "Organizations", in the search bar, begin typing the organization's name until the organization appears in the search results. -3. To the right of the organization's name, select the {% octicon "gear" aria-label="Organization settings" %} dropdown menu and click **Remove organization**. +1. Under "Organizations", in the search bar, begin typing the organization's name until the organization appears in the search results. +1. To the right of the organization's name, select the {% octicon "gear" aria-label="Organization settings" %} dropdown menu and click **Remove organization**. ![Screenshot of a list of organizations in search results. To the right of the organization name, the dropdown menu labeled with a gear icon is expanded, and the "Remove organization" option is highlighted with an orange outline.](/assets/images/help/enterprises/remove-organization.png) 1. Review the warnings, then click **Remove organization**. diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md b/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md index 07fd63480a7f..2070646618ec 100644 --- a/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md +++ b/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md @@ -75,7 +75,7 @@ For more information, see "[AUTOTITLE](/repositories/working-with-files/managing 1. Disable {% data variables.large_files.product_name_short %} on {% data variables.location.product_location %}. For more information, see "[Configuring {% data variables.large_files.product_name_long %} for your enterprise](#configuring-git-large-file-storage-for-your-enterprise)." -2. Create a {% data variables.large_files.product_name_short %} configuration file that points to the third party server. +1. Create a {% data variables.large_files.product_name_short %} configuration file that points to the third party server. ```shell # Show default configuration @@ -99,14 +99,14 @@ For more information, see "[AUTOTITLE](/repositories/working-with-files/managing lfsurl = https://THIRD-PARTY-LFS-SERVER/path/to/repo ``` -3. To keep the same {% data variables.large_files.product_name_short %} configuration for each user, commit a custom `.lfsconfig` file to the repository. +1. To keep the same {% data variables.large_files.product_name_short %} configuration for each user, commit a custom `.lfsconfig` file to the repository. ```shell git add .lfsconfig git commit -m "Adding LFS config file" ``` -3. Migrate any existing {% data variables.large_files.product_name_short %} assets. For more information, see "[Migrating to a different {% data variables.large_files.product_name_long %} server](#migrating-to-a-different-git-large-file-storage-server)." +1. Migrate any existing {% data variables.large_files.product_name_short %} assets. For more information, see "[Migrating to a different {% data variables.large_files.product_name_long %} server](#migrating-to-a-different-git-large-file-storage-server)." ## Migrating to a different Git Large File Storage server @@ -125,7 +125,7 @@ Before migrating to a different {% data variables.large_files.product_name_long > Endpoint (NEW-REMOTE)=https://NEW-REMOTE-HOSTNAME/path/to/repo/info/lfs (auth=none) ``` -2. Fetch all objects from the old remote. +1. Fetch all objects from the old remote. ```shell $ git lfs fetch origin --all @@ -135,7 +135,7 @@ Before migrating to a different {% data variables.large_files.product_name_long > Git LFS: (16 of 16 files) 48.71 MB / 48.85 MB ``` -3. Push all objects to the new remote. +1. Push all objects to the new remote. ```shell $ git lfs push NEW-REMOTE --all diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md b/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md index dec423f19a51..e5ec836d6b00 100644 --- a/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md +++ b/content/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md @@ -40,20 +40,20 @@ If you don't have private mode enabled, the migration script will have no effect 1. Connect to the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." {% ifversion ghes or ghae %} -2. Run the migration command. +1. Run the migration command. ```shell github-env bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log ``` {% else %} -2. Navigate to the `/data/github/current` directory. +1. Navigate to the `/data/github/current` directory. ```shell cd /data/github/current ``` -3. Run the migration command. +1. Run the migration command. ```shell sudo bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log diff --git a/content/admin/user-management/managing-users-in-your-enterprise/managing-invitations-to-organizations-within-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise/managing-invitations-to-organizations-within-your-enterprise.md index 29f00d75d8eb..c35a65dbd101 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/managing-invitations-to-organizations-within-your-enterprise.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/managing-invitations-to-organizations-within-your-enterprise.md @@ -25,7 +25,7 @@ Invitations expire after 7 days. You can retry or cancel expired invitations, ei ![Screenshot of a user in the list of failed invitations. A dropdown menu, labeled with a kebab icon, is highlighted with an orange outline.](/assets/images/help/business-accounts/enterprise-invitation-retry-or-cancel.png) - To confirm, click **Yes, retry** or **Yes, cancel**. -3. Optionally, retry or cancel multiple invitations at the same time. +1. Optionally, retry or cancel multiple invitations at the same time. - Select the checkboxes next to the invitations you want to retry or cancel. - At the top of the list, select the **X invitations selected** dropdown menu and click **Retry invitations** or **Cancel invitations**. diff --git a/content/admin/user-management/managing-users-in-your-enterprise/managing-organization-members-in-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise/managing-organization-members-in-your-enterprise.md index 56aea48f0901..7d06eadbbcc6 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/managing-organization-members-in-your-enterprise.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/managing-organization-members-in-your-enterprise.md @@ -30,7 +30,7 @@ Members can also be added or removed from an organization at the organization le ![Screenshot of the list of enterprise members. A dropdown menu, labeled "1 user selected...", is expanded and highlighted with an orange outline.](/assets/images/help/business-accounts/enterprise-add-or-remove-from-org.png) -2. In the popup, select the organizations you want to add or remove the user from. +1. In the popup, select the organizations you want to add or remove the user from. {% note %} @@ -38,5 +38,5 @@ Members can also be added or removed from an organization at the organization le {% endnote %} -3. To confirm, click **Add user** or **Remove user**. -4. Optionally, to add or remove multiple users at the same time, select multiple checkboxes. Use the dropdown to select **Add to organizations** or **Remove from organizations**. +1. To confirm, click **Add user** or **Remove user**. +1. Optionally, to add or remove multiple users at the same time, select multiple checkboxes. Use the dropdown to select **Add to organizations** or **Remove from organizations**. diff --git a/content/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md index c0c6cc80eebc..6cea9d04b85f 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md @@ -29,9 +29,9 @@ To add a support entitlement to a user, the user must already be a member of an {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} -3. Under "Settings", click **Support**. -4. In the search bar, start typing the name or username of the person you want to give a support entitlement. Click their name in the list of matches. -5. Click **Add support entitlement**. +1. Under "Settings", click **Support**. +1. In the search bar, start typing the name or username of the person you want to give a support entitlement. Click their name in the list of matches. +1. Click **Add support entitlement**. ## Removing a support entitlement from an enterprise member @@ -41,8 +41,8 @@ If a user remains an enterprise member, you can manually remove their support en {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} -3. In the sidebar under "Settings", click **Support**. -4. Under "Support members", to the right of the person you want to remove a support entitlement from, click {% octicon "trash" aria-label="remove support entitlement" %}. +1. In the sidebar under "Settings", click **Support**. +1. Under "Support members", to the right of the person you want to remove a support entitlement from, click {% octicon "trash" aria-label="remove support entitlement" %}. ## Further reading diff --git a/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md b/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md index a871eeca4a92..73cd9dcc690f 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md @@ -29,8 +29,8 @@ For information about promoting a user to an organization owner, see the `ghe-or {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -5. In the upper-right corner of the page, click **Add owner**. -6. In the search field, type the name of the user, then click **Add**. +1. In the upper-right corner of the page, click **Add owner**. +1. In the search field, type the name of the user, then click **Add**. ## Demoting a site administrator from the enterprise settings @@ -49,7 +49,7 @@ For information about promoting a user to an organization owner, see the `ghe-or ## Promoting a user from the command line 1. [SSH](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh) into your appliance. -2. Run [ghe-user-promote](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-promote) with the username to promote. +1. Run [ghe-user-promote](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-promote) with the username to promote. ```shell ghe-user-promote USERNAME @@ -58,7 +58,7 @@ For information about promoting a user to an organization owner, see the `ghe-or ## Demoting a site administrator from the command line 1. [SSH](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh) into your appliance. -2. Run [ghe-user-demote](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-demote) with the username to demote. +1. Run [ghe-user-demote](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-demote) with the username to demote. ```shell ghe-user-demote USERNAME diff --git a/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md b/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md index d96cfa337756..bedb18ee454b 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md @@ -63,7 +63,7 @@ As when suspending a user, unsuspending a user takes effect immediately. The use ## Suspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. Run [ghe-user-suspend](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-suspend) with the username to suspend. +1. Run [ghe-user-suspend](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-suspend) with the username to suspend. ```shell ghe-user-suspend USERNAME @@ -86,7 +86,7 @@ You can create a custom message that suspended users will see when attempting to ## Unsuspending a user from the command line {% data reusables.enterprise_installation.ssh-into-instance %} -2. Run [ghe-user-unsuspend](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-unsuspend) with the username to unsuspend. +1. Run [ghe-user-unsuspend](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-user-unsuspend) with the username to unsuspend. ```shell ghe-user-unsuspend USERNAME diff --git a/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md index 78b5dd561fe3..a67bb5aad12e 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md @@ -158,11 +158,11 @@ You can view a list of all dormant users {% ifversion ghes or ghae %} who have n {% data reusables.enterprise-accounts.access-enterprise %} 1. Under "Organizations", in the search bar, begin typing the organization's name until it appears in the search results. -2. Click the name of the organization. -3. Above the organization name, click {% octicon "person" aria-hidden="true" %} **People**. +1. Click the name of the organization. +1. Above the organization name, click {% octicon "person" aria-hidden="true" %} **People**. ![Screenshot of the tabs above an organization name. The "People" tab is highlighted with an orange outline.](/assets/images/help/enterprises/emu-organization-people-tab.png) -4. Above the list of members, click **Type**, then select the type of members you want to view. +1. Above the list of members, click **Type**, then select the type of members you want to view. ![Screenshot of the list of members. A dropdown menu labeled "Type" is outlined in orange, and an expanded dropdown shows options for "All members," "Managed by IdP groups," and "Managed directly."](/assets/images/help/enterprises/filter-by-member-type.png) {% endif %} diff --git a/content/apps/creating-github-apps/writing-code-for-a-github-app/setting-up-your-development-environment-to-create-a-github-app.md b/content/apps/creating-github-apps/writing-code-for-a-github-app/setting-up-your-development-environment-to-create-a-github-app.md index 078e4399f2b6..30289a1db0c9 100644 --- a/content/apps/creating-github-apps/writing-code-for-a-github-app/setting-up-your-development-environment-to-create-a-github-app.md +++ b/content/apps/creating-github-apps/writing-code-for-a-github-app/setting-up-your-development-environment-to-create-a-github-app.md @@ -73,7 +73,7 @@ Next, go back to the Terminal and follow these steps to run the Smee command-lin npm install --global smee-client ``` -2. Run the client (replacing `https://smee.io/qrfeVRbFbffd6vD` with your own domain): +1. Run the client (replacing `https://smee.io/qrfeVRbFbffd6vD` with your own domain): ```shell smee --url https://smee.io/qrfeVRbFbffd6vD --path /event_handler --port 3000 diff --git a/content/apps/maintaining-github-apps/activating-optional-features-for-github-apps.md b/content/apps/maintaining-github-apps/activating-optional-features-for-github-apps.md index 093027a221a5..598e03cc3d94 100644 --- a/content/apps/maintaining-github-apps/activating-optional-features-for-github-apps.md +++ b/content/apps/maintaining-github-apps/activating-optional-features-for-github-apps.md @@ -25,7 +25,7 @@ shortTitle: Activate optional features {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} -3. Click **Edit** next to the {% data variables.product.prodname_github_app %} you want to enable an optional feature for. +1. Click **Edit** next to the {% data variables.product.prodname_github_app %} you want to enable an optional feature for. {% data reusables.apps.optional_feature_activation %} ## Further reading diff --git a/content/apps/maintaining-github-apps/deleting-a-github-app.md b/content/apps/maintaining-github-apps/deleting-a-github-app.md index 03a57f107a4b..226afe3f66f5 100644 --- a/content/apps/maintaining-github-apps/deleting-a-github-app.md +++ b/content/apps/maintaining-github-apps/deleting-a-github-app.md @@ -43,10 +43,10 @@ When you delete a {% data variables.product.prodname_github_app %} registration, {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. Select the GitHub App you want to delete. +1. Select the GitHub App you want to delete. {% data reusables.user-settings.github_apps_advanced %} -6. Click **Delete GitHub App**. -7. In the confirmation box, type the name of the GitHub App to confirm you want to delete it. -8. Click **I understand the consequences, delete this GitHub App**. +1. Click **Delete GitHub App**. +1. In the confirmation box, type the name of the GitHub App to confirm you want to delete it. +1. Click **I understand the consequences, delete this GitHub App**. These steps only delete your {% data variables.product.prodname_github_app %} registration, and all of the organization and account installations it may have. They do not delete any code that you wrote for your app. However, any code that relies on your {% data variables.product.prodname_github_app %}'s credentials will no longer function. diff --git a/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md b/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md index f8a2f5124a01..bf6668ee7d26 100644 --- a/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md +++ b/content/apps/maintaining-github-apps/transferring-ownership-of-a-github-app.md @@ -27,9 +27,9 @@ You can only transfer ownership to a user or organization. You cannot transfer o {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} -4. Select the GitHub App whose ownership you want to transfer. +1. Select the GitHub App whose ownership you want to transfer. {% data reusables.user-settings.github_apps_advanced %} -6. Click **Transfer ownership**. -7. Under "Type the name of the GitHub App to confirm", type the name of the GitHub App you want to transfer. -8. Under "New owner's GitHub username or organization name", type the name of the user or organization you want to transfer the GitHub App to. -9. Click **Transfer this GitHub App**. +1. Click **Transfer ownership**. +1. Under "Type the name of the GitHub App to confirm", type the name of the GitHub App you want to transfer. +1. Under "New owner's GitHub username or organization name", type the name of the user or organization you want to transfer the GitHub App to. +1. Click **Transfer this GitHub App**. diff --git a/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md index fce70d666766..f57126e58576 100644 --- a/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md @@ -49,8 +49,8 @@ To authorize your {% data variables.product.prodname_oauth_app %}, consider whic The web application flow to authorize users for your app is: 1. Users are redirected to request their GitHub identity -2. Users are redirected back to your site by GitHub -3. Your app accesses the API with the user's access token +1. Users are redirected back to your site by GitHub +1. Your app accesses the API with the user's access token ### 1. Request a user's GitHub identity @@ -144,8 +144,8 @@ Before you can use the device flow to authorize and identify users, you must fir ### Overview of the device flow 1. Your app requests device and user verification codes and gets the authorization URL where the user will enter the user verification code. -2. The app prompts the user to enter a user verification code at {% data variables.product.device_authorization_url %}. -3. The app polls for the user authentication status. Once the user has authorized the device, the app will be able to make API calls with a new access token. +1. The app prompts the user to enter a user verification code at {% data variables.product.device_authorization_url %}. +1. The app polls for the user authentication status. Once the user has authorized the device, the app will be able to make API calls with a new access token. ### Step 1: App requests the device and user verification codes from GitHub diff --git a/content/apps/oauth-apps/maintaining-oauth-apps/activating-optional-features-for-oauth-apps.md b/content/apps/oauth-apps/maintaining-oauth-apps/activating-optional-features-for-oauth-apps.md index ae424cbfd473..3a53aebfddca 100644 --- a/content/apps/oauth-apps/maintaining-oauth-apps/activating-optional-features-for-oauth-apps.md +++ b/content/apps/oauth-apps/maintaining-oauth-apps/activating-optional-features-for-oauth-apps.md @@ -21,5 +21,5 @@ shortTitle: Activate optional features {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -3. Select the {% data variables.product.prodname_oauth_app %} you want to enable an optional feature for. +1. Select the {% data variables.product.prodname_oauth_app %} you want to enable an optional feature for. {% data reusables.apps.optional_feature_activation %} diff --git a/content/apps/oauth-apps/maintaining-oauth-apps/deleting-an-oauth-app.md b/content/apps/oauth-apps/maintaining-oauth-apps/deleting-an-oauth-app.md index 1337cf86589b..bac26e22a1d1 100644 --- a/content/apps/oauth-apps/maintaining-oauth-apps/deleting-an-oauth-app.md +++ b/content/apps/oauth-apps/maintaining-oauth-apps/deleting-an-oauth-app.md @@ -17,7 +17,7 @@ topics: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. Select the {% data variables.product.prodname_oauth_app %} you want to modify. -5. In the left sidebar, click **Advanced**. -6. Click **Delete application**. -7. Click **Delete this OAuth Application**. +1. Select the {% data variables.product.prodname_oauth_app %} you want to modify. +1. In the left sidebar, click **Advanced**. +1. Click **Delete application**. +1. Click **Delete this OAuth Application**. diff --git a/content/apps/oauth-apps/maintaining-oauth-apps/transferring-ownership-of-an-oauth-app.md b/content/apps/oauth-apps/maintaining-oauth-apps/transferring-ownership-of-an-oauth-app.md index f9d778572084..56b1d4cf533a 100644 --- a/content/apps/oauth-apps/maintaining-oauth-apps/transferring-ownership-of-an-oauth-app.md +++ b/content/apps/oauth-apps/maintaining-oauth-apps/transferring-ownership-of-an-oauth-app.md @@ -18,8 +18,8 @@ shortTitle: Transfer ownership {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} -4. Select the {% data variables.product.prodname_oauth_app %} you want to modify. -5. Click **Transfer ownership**. -6. To confirm the transfer, in the text field, type the name of the {% data variables.product.prodname_oauth_app %} you want to transfer. -7. Under "New owner's {% data variables.product.prodname_dotcom %} username or organization name," type the name of the user or organization you want to transfer the {% data variables.product.prodname_oauth_app %} to. -8. Click **Transfer this application**. +1. Select the {% data variables.product.prodname_oauth_app %} you want to modify. +1. Click **Transfer ownership**. +1. To confirm the transfer, in the text field, type the name of the {% data variables.product.prodname_oauth_app %} you want to transfer. +1. Under "New owner's {% data variables.product.prodname_dotcom %} username or organization name," type the name of the user or organization you want to transfer the {% data variables.product.prodname_oauth_app %} to. +1. Click **Transfer this application**. diff --git a/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization.md b/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization.md index 4878adcd4184..bda80217bf4e 100644 --- a/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization.md +++ b/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization.md @@ -30,7 +30,7 @@ For more information about installing a {% data variables.product.prodname_githu {% data reusables.marketplace.confirm-install-account-org %} {% data reusables.marketplace.add-payment-method-org %} {% data reusables.marketplace.complete-order-begin-installation %} -8. Review the information about the app's access to your personal account, organizations, and data, then click **Authorize application**. +1. Review the information about the app's access to your personal account, organizations, and data, then click **Authorize application**. ## Further reading diff --git a/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account.md b/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account.md index 5fb660e8b933..9e1060a0d060 100644 --- a/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account.md +++ b/content/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account.md @@ -28,7 +28,7 @@ For more information about installing a {% data variables.product.prodname_githu {% data reusables.marketplace.confirm-install-account-personal %} {% data reusables.marketplace.add-payment-method-personal %} {% data reusables.marketplace.complete-order-begin-installation %} -8. Review the information about the app's access to your personal account and data, then click **Authorize application**. +1. Review the information about the app's access to your personal account and data, then click **Authorize application**. ## Further reading diff --git a/content/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/viewing-transactions-for-your-listing.md b/content/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/viewing-transactions-for-your-listing.md index 45dc9f521429..a06f459516ef 100644 --- a/content/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/viewing-transactions-for-your-listing.md +++ b/content/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/viewing-transactions-for-your-listing.md @@ -46,7 +46,7 @@ To access {% data variables.product.prodname_marketplace %} transactions: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.marketplace_apps %} -4. Select the {% data variables.product.prodname_github_app %} that you'd like to view transactions for. +1. Select the {% data variables.product.prodname_github_app %} that you'd like to view transactions for. {% data reusables.user-settings.edit_marketplace_listing %} -6. Click the **Transactions** tab. -7. Optionally, select a different time period by clicking the Period dropdown in the upper-right corner of the Transactions page. +1. Click the **Transactions** tab. +1. Optionally, select a different time period by clicking the Period dropdown in the upper-right corner of the Transactions page. diff --git a/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md b/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md index 44da3740edc1..ae6215991b2a 100644 --- a/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md +++ b/content/apps/publishing-apps-to-github-marketplace/listing-an-app-on-github-marketplace/drafting-a-listing-for-your-app.md @@ -36,7 +36,7 @@ To create a {% data variables.product.prodname_marketplace %} listing: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} -3. In the left sidebar, click either **OAuth Apps** or **GitHub Apps** depending on the app you're adding to {% data variables.product.prodname_marketplace %}. +1. In the left sidebar, click either **OAuth Apps** or **GitHub Apps** depending on the app you're adding to {% data variables.product.prodname_marketplace %}. {% note %} @@ -46,9 +46,9 @@ To create a {% data variables.product.prodname_marketplace %} listing: ![Screenshot of the sidebar on the "Developer Settings" page of {% data variables.product.prodname_dotcom %}. Options labeled "{% data variables.product.prodname_github_apps %}" and "{% data variables.product.prodname_oauth_apps %}" are outlined in dark orange.](/assets/images/settings/apps-choose-app.png) -4. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}. +1. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}. {% data reusables.user-settings.edit_marketplace_listing %} -5. Once you've created a new draft listing, you'll see an overview of the sections that you'll need to visit before your {% data variables.product.prodname_marketplace %} listing will be complete. +1. Once you've created a new draft listing, you'll see an overview of the sections that you'll need to visit before your {% data variables.product.prodname_marketplace %} listing will be complete. ![Screenshot of a draft {% data variables.product.prodname_marketplace %} listing. In a section labeled "Publish your app to Marketplace," unfinished action items such as "Add your contact info" are marked with orange circles.](/assets/images/marketplace/marketplace-listing-overview.png) diff --git a/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md b/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md index 243b402a470a..3510a2d42344 100644 --- a/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md +++ b/content/apps/using-github-apps/reviewing-and-revoking-authorization-of-github-apps.md @@ -30,8 +30,8 @@ The authorization can only be revoked by the person who authorized the {% data v {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.access_applications %} -3. Click the **Authorized {% data variables.product.prodname_github_apps %}** tab. -3. Review the {% data variables.product.prodname_github_apps %} that have access to your account. For those that you don't recognize or that have not been used recently, click **Revoke**. To revoke your authorization for all {% data variables.product.prodname_github_apps %}, click **Revoke all**. +1. Click the **Authorized {% data variables.product.prodname_github_apps %}** tab. +1. Review the {% data variables.product.prodname_github_apps %} that have access to your account. For those that you don't recognize or that have not been used recently, click **Revoke**. To revoke your authorization for all {% data variables.product.prodname_github_apps %}, click **Revoke all**. ![Screenshot of the "Authorized {% data variables.product.prodname_github_apps %}" tab. Next to an app, a button, labeled "Revoke," is highlighted in orange.](/assets/images/help/settings/revoke-github-app.png) diff --git a/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md b/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md index 4df2b4ce161e..8299898ef60d 100644 --- a/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md +++ b/content/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md @@ -21,11 +21,11 @@ You must authorize your {% data variables.product.pat_v1 %} after creation befor {% 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**. {% data reusables.saml.authenticate-with-saml-at-least-once %} +1. Next to the token you'd like to authorize, click **Configure SSO**. {% data reusables.saml.authenticate-with-saml-at-least-once %} ![Screenshot of a list entry for a {% data variables.product.pat_v1 %}. A dropdown menu, labeled "Configure SSO", is outlined in orange.](/assets/images/help/settings/sso-allowlist-button.png) -4. In the dropdown menu, to the right of the organization you'd like to authorize the token for, click **Authorize**. +1. In the dropdown menu, to the right of the organization you'd like to authorize the token for, click **Authorize**. ## Further reading diff --git a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index 91920711cdca..35ac9847ea2c 100644 --- a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -41,13 +41,13 @@ After adding a new SSH authentication key to your account on {% ifversion ghae % {% data reusables.gpg.copy-ssh-public-key %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -4. Click **New SSH key** or **Add SSH key**. -5. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal laptop, you might call this key "Personal laptop". +1. Click **New SSH key** or **Add SSH key**. +1. In the "Title" field, add a descriptive label for the new key. For example, if you're using a personal laptop, you might call this key "Personal laptop". {% ifversion ssh-commit-verification %} -6. Select the type of key, either authentication or signing. For more information about commit signing, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)." +1. Select the type of key, either authentication or signing. For more information about commit signing, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)." {% endif %} -7. In the "Key" field, paste your public key. -8. Click **Add SSH key**. +1. In the "Key" field, paste your public key. +1. Click **Add SSH key**. {% data reusables.user-settings.sudo-mode-popup %} {% endwebui %} diff --git a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md index 0728b87c13d5..9212c14fba75 100644 --- a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md @@ -28,14 +28,14 @@ Before you generate a new SSH key, you should check your local machine for exist {% data reusables.ssh.key-type-support %} {% data reusables.command_line.open_the_multi_os_terminal %} -2. Enter `ls -al ~/.ssh` to see if existing SSH keys are present. +1. Enter `ls -al ~/.ssh` to see if existing SSH keys are present. ```shell $ ls -al ~/.ssh # Lists the files in your .ssh directory, if they exist ``` -3. Check the directory listing to see if you already have a public SSH key. By default, the {% ifversion ghae %}filename of a supported public key for {% data variables.product.product_name %} is _id_rsa.pub_.{% else %}filenames of supported public keys for {% data variables.product.product_name %} are one of the following. +1. Check the directory listing to see if you already have a public SSH key. By default, the {% ifversion ghae %}filename of a supported public key for {% data variables.product.product_name %} is _id_rsa.pub_.{% else %}filenames of supported public keys for {% data variables.product.product_name %} are one of the following. - _id_rsa.pub_ - _id_ecdsa.pub_ - _id_ed25519.pub_{% endif %} @@ -46,7 +46,7 @@ Before you generate a new SSH key, you should check your local machine for exist {% endtip %} -4. Either generate a new SSH key or upload an existing key. +1. Either generate a new SSH key or upload an existing key. - If you don't have a supported public and private key pair, or don't wish to use any that are available, generate a new SSH key. - If you see an existing public and private key pair listed (for example, _id_rsa.pub_ and _id_rsa_) that you would like to use to connect to {% data variables.product.product_name %}, you can add the key to the ssh-agent. diff --git a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md index 9223478afab0..e2698c10e906 100644 --- a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md @@ -38,7 +38,7 @@ In many cases, especially in the beginning of a project, SSH agent forwarding is ### Set up SSH agent forwarding 1. Turn on agent forwarding locally. See [our guide on SSH agent forwarding][ssh-agent-forwarding] for more information. -2. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: +1. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: `ssh -A serverA 'bash -s' < deploy.sh` ## HTTPS cloning with OAuth tokens @@ -86,12 +86,12 @@ See [our guide on creating a {% data variables.product.pat_generic %}](/authenti 1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server, and remember where you save the generated public and private rsa key pair. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. In the sidebar, click **Deploy Keys**. +1. In the sidebar, click **Deploy Keys**. 1. Click **Add deploy key**. -4. In the "Title" field, provide a title. +1. In the "Title" field, provide a title. 1. In the "Key" field, paste your public key. -5. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. -6. Click **Add key**. +1. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. +1. Click **Add key**. ### Using multiple repositories on one server @@ -183,7 +183,7 @@ This means that you cannot automate the creation of accounts. But if you want to ### Set up machine users 1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server and attach the public key to the machine user account. -2. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. +1. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. [ssh-agent-forwarding]: /authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding [generating-ssh-keys]: /authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key diff --git a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md index 986c2299b538..e8ab59b31fec 100644 --- a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md +++ b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md @@ -22,7 +22,7 @@ Before testing your SSH connection, you should have: When you test your connection, you'll need to authenticate this action using your password, which is the SSH key passphrase you created earlier. For more information on working with SSH key passphrases, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases)." {% data reusables.command_line.open_the_multi_os_terminal %} -2. Enter the following: +1. Enter the following: ```shell $ ssh -T git@{% data variables.command_line.codeblock %} @@ -37,7 +37,7 @@ When you test your connection, you'll need to authenticate this action using you > Are you sure you want to continue connecting (yes/no)? ``` -3. Verify that the fingerprint in the message you see matches {% ifversion fpt or ghec %}[{% data variables.product.prodname_dotcom %}'s public key fingerprint](/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints){% else %} your enterprise's public key fingerprint{% endif %}. If it does, then type `yes`: +1. Verify that the fingerprint in the message you see matches {% ifversion fpt or ghec %}[{% data variables.product.prodname_dotcom %}'s public key fingerprint](/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints){% else %} your enterprise's public key fingerprint{% endif %}. If it does, then type `yes`: ```shell > Hi USERNAME! You've successfully authenticated, but GitHub does not @@ -65,4 +65,4 @@ When you test your connection, you'll need to authenticate this action using you {% endnote %} -4. Verify that the resulting message contains your username. If you receive a "permission denied" message, see "[AUTOTITLE](/authentication/troubleshooting-ssh/error-permission-denied-publickey)." +1. Verify that the resulting message contains your username. If you receive a "permission denied" message, see "[AUTOTITLE](/authentication/troubleshooting-ssh/error-permission-denied-publickey)." diff --git a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md index c95d7371a356..416fbc1618d9 100644 --- a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md +++ b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md @@ -41,7 +41,7 @@ We're off to a great start. Let's set up SSH to allow agent forwarding to your s 1. Using your favorite text editor, open up the file at `~/.ssh/config`. If this file doesn't exist, you can create it by entering `touch ~/.ssh/config` in the terminal. -2. Enter the following text into the file, replacing `example.com` with your server's domain name or IP: +1. Enter the following text into the file, replacing `example.com` with your server's domain name or IP: Host example.com ForwardAgent yes diff --git a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md index 602ad3ed5e03..c53e53b44e52 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md @@ -51,8 +51,8 @@ If an image is showing up in your browser but not on {% data variables.product.p > Content-Length: 6507 ``` -3. Check the value of `Content-Type`. In this case, it's `image/x-png`. -4. Check that content type against [the list of types supported by Camo](https://github.com/atmos/camo/blob/master/mime-types.json). +1. Check the value of `Content-Type`. In this case, it's `image/x-png`. +1. Check that content type against [the list of types supported by Camo](https://github.com/atmos/camo/blob/master/mime-types.json). If your content type is not supported by Camo, you can try several actions: - If you own the server that's hosting the image, modify it so that it returns a correct content type for images. diff --git a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md index 19f7c5d561b3..e915b93f6e93 100644 --- a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md +++ b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md @@ -136,10 +136,10 @@ If you selected an organization as the resource owner and the organization requi {% data reusables.user-settings.developer_settings %} {% ifversion pat-v2 %}1. In the left sidebar, under **{% octicon "key" aria-hidden="true" %} {% data variables.product.pat_generic_caps %}s**, click **Tokens (classic)**.{% else %}{% data reusables.user-settings.personal_access_tokens %}{% endif %} {% ifversion pat-v2%}1. Select **Generate new token**, then click **Generate new token (classic)**.{% else %}{% data reusables.user-settings.generate_new_token %}{% endif %} -5. In the "Note" field, give your token a descriptive name. -6. To give your token an expiration, select **Expiration**, then choose a default option or click **Custom** to enter a date. -7. Select the scopes you'd like to grant this token. To use your token to access repositories from the command line, select **repo**. A token with no assigned scopes can only access public information. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)". -8. Click **Generate token**. +1. In the "Note" field, give your token a descriptive name. +1. To give your token an expiration, select **Expiration**, then choose a default option or click **Custom** to enter a date. +1. Select the scopes you'd like to grant this token. To use your token to access repositories from the command line, select **repo**. A token with no assigned scopes can only access public information. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)". +1. Click **Generate token**. 1. Optionally, to copy the new token to your clipboard, click {% octicon "copy" aria-label="Copy token" %}. ![Screenshot of the "{% data variables.product.pat_generic_caps_plural %}" page. Next to a blurred-out token, an icon of two overlapping squares is outlined in orange.](/assets/images/help/settings/personal-access-tokens.png){% ifversion fpt or ghec %} diff --git a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index a869c73029f7..7a07372ac775 100644 --- a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -86,7 +86,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil For more information, see [_INSTALL.md_](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md) in the `newren/git-filter-repo` repository. -2. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/repositories/creating-and-managing-repositories/cloning-a-repository) to your local computer. +1. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/repositories/creating-and-managing-repositories/cloning-a-repository) to your local computer. ```shell $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY @@ -98,13 +98,13 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil > Resolving deltas: 100% (724/724), done. ``` -3. Navigate into the repository's working directory. +1. Navigate into the repository's working directory. ```shell cd YOUR-REPOSITORY ``` -4. Run the following command, replacing `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` with the **path to the file you want to remove, not just its filename**. These arguments will: +1. Run the following command, replacing `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` with the **path to the file you want to remove, not just its filename**. These arguments will: - Force Git to process, but not check out, the entire history of every branch and tag - Remove the specified file, as well as any empty commits generated as a result - Remove some configurations, such as the remote URL, stored in the _.git/config_ file. You may want to back up this file in advance for restoration later. @@ -131,7 +131,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil {% endnote %} -5. Add your file with sensitive data to `.gitignore` to ensure that you don't accidentally commit it again. +1. Add your file with sensitive data to `.gitignore` to ensure that you don't accidentally commit it again. ```shell $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore @@ -141,8 +141,8 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil > 1 files changed, 1 insertions(+), 0 deletions(-) ``` -6. Double-check that you've removed everything you wanted to from your repository's history, and that all of your branches are checked out. -7. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, as well as all the branches you've pushed up. A force push is required to remove sensitive data from your commit history. +1. Double-check that you've removed everything you wanted to from your repository's history, and that all of your branches are checked out. +1. Once you're happy with the state of your repository, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, as well as all the branches you've pushed up. A force push is required to remove sensitive data from your commit history. ```shell $ git push origin --force --all @@ -155,7 +155,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil > + 48dc599...051452f main -> main (forced update) ``` -8. In order to remove the sensitive file from [your tagged releases](/repositories/releasing-projects-on-github/about-releases), you'll also need to force-push against your Git tags: +1. In order to remove the sensitive file from [your tagged releases](/repositories/releasing-projects-on-github/about-releases), you'll also need to force-push against your Git tags: ```shell $ git push origin --force --tags @@ -174,9 +174,9 @@ After using either the BFG tool or `git filter-repo` to remove the sensitive dat 1. Contact {% data variables.contact.contact_support %}, asking them to remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %}. Please provide the name of the repository and/or a link to the commit you need removed.{% ifversion ghes %} For more information about how site administrators can remove unreachable Git objects, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-repo-gc)."{% endif %} -2. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), _not_ merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. +1. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), _not_ merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. -3. After some time has passed and you're confident that the BFG tool / `git filter-repo` had no unintended side effects, you can force all objects in your local repository to be dereferenced and garbage collected with the following commands (using Git 1.8.5 or newer): +1. After some time has passed and you're confident that the BFG tool / `git filter-repo` had no unintended side effects, you can force all objects in your local repository to be dereferenced and garbage collected with the following commands (using Git 1.8.5 or newer): ```shell $ git for-each-ref --format="delete %(refname)" refs/original | git update-ref --stdin diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md index b3dae31e296c..8bb950eb4815 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md @@ -18,11 +18,11 @@ shortTitle: Deploy keys {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} -3. In the "Security" section of the sidebar, click **{% octicon "key" aria-hidden="true" %} Deploy keys**. +1. In the "Security" section of the sidebar, click **{% octicon "key" aria-hidden="true" %} Deploy keys**. {% else %} -3. In the left sidebar, click **Deploy keys**. +1. In the left sidebar, click **Deploy keys**. {% endif %} -4. On the "Deploy keys" page, take note of the deploy keys associated with your account. For those that you don't recognize, or that are out of date, click **Delete**. If there are valid deploy keys you'd like to keep, click **Approve**. +1. On the "Deploy keys" page, take note of the deploy keys associated with your account. For those that you don't recognize, or that are out of date, click **Delete**. If there are valid deploy keys you'd like to keep, click **Approve**. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys)." diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md index d008ba13ff25..b85bac5d227a 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md @@ -22,7 +22,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -3. Under "SSH keys", 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**. +1. Under "SSH keys", 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**. {% tip %} @@ -30,18 +30,18 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% endtip %} -4. Open Terminal. +1. Open Terminal. {% data reusables.command_line.start_ssh_agent %} -6. Find and take a note of your public key fingerprint. +1. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` -7. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. +1. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. {% endmac %} @@ -49,7 +49,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -3. Under "SSH keys", 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**. +1. Under "SSH keys", 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**. {% tip %} @@ -57,20 +57,20 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% endtip %} -4. Open Git Bash. +1. Open Git Bash. -5. {% data reusables.desktop.windows_git_bash_turn_on_ssh_agent %} +1. {% data reusables.desktop.windows_git_bash_turn_on_ssh_agent %} {% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %} -6. Find and take a note of your public key fingerprint. +1. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` -7. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. +1. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. {% endwindows %} @@ -78,7 +78,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -3. Under "SSH keys", 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**. +1. Under "SSH keys", 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**. {% tip %} @@ -86,18 +86,18 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an {% endtip %} -4. Open Terminal. +1. Open Terminal. {% data reusables.command_line.start_ssh_agent %} -6. Find and take a note of your public key fingerprint. +1. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` -7. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. +1. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. {% endlinux %} diff --git a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index 4f09c1ec4707..d43fa9d27910 100644 --- a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -82,11 +82,11 @@ You can use GPG to sign commits with a GPG key that you generate yourself. To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps: 1. [Check for existing GPG keys](/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys) -2. [Generate a new GPG key](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) -3. [Add a GPG key to your GitHub account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account) -4. [Tell Git about your signing key](/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) -5. [Sign commits](/authentication/managing-commit-signature-verification/signing-commits) -6. [Sign tags](/authentication/managing-commit-signature-verification/signing-tags) +1. [Generate a new GPG key](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) +1. [Add a GPG key to your GitHub account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account) +1. [Tell Git about your signing key](/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) +1. [Sign commits](/authentication/managing-commit-signature-verification/signing-commits) +1. [Sign tags](/authentication/managing-commit-signature-verification/signing-tags) {% ifversion ssh-commit-verification %} @@ -102,11 +102,11 @@ you can also upload that same key again for use as a signing key. There's no lim To sign commits using SSH and have those commits verified on {% data variables.product.product_name %}, follow these steps: 1. [Check for existing SSH keys](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys) -2. [Generate a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) -3. [Add a SSH signing key to your GitHub account](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) -4. [Tell Git about your signing key](/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) -5. [Sign commits](/authentication/managing-commit-signature-verification/signing-commits) -6. [Sign tags](/authentication/managing-commit-signature-verification/signing-tags) +1. [Generate a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) +1. [Add a SSH signing key to your GitHub account](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) +1. [Tell Git about your signing key](/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) +1. [Sign commits](/authentication/managing-commit-signature-verification/signing-commits) +1. [Sign tags](/authentication/managing-commit-signature-verification/signing-tags) {% endif %} @@ -121,8 +121,8 @@ You can use S/MIME to sign commits with an X.509 key issued by your organization To sign commits using S/MIME and have those commits verified on {% data variables.product.product_name %}, follow these steps: 1. [Tell Git about your signing key](/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key) -2. [Sign commits](/authentication/managing-commit-signature-verification/signing-commits) -3. [Sign tags](/authentication/managing-commit-signature-verification/signing-tags) +1. [Sign commits](/authentication/managing-commit-signature-verification/signing-commits) +1. [Sign tags](/authentication/managing-commit-signature-verification/signing-tags) You don't need to upload your public key to {% data variables.product.product_name %}. diff --git a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md index abb516beaf45..e16db51f31a2 100644 --- a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md @@ -24,19 +24,19 @@ If you're using a GPG key that matches your committer identity and your verified {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} -4. Enter `gpg --edit-key GPG key ID`, substituting in the GPG key ID you'd like to use. In the following example, the GPG key ID is `3AA5C34371567BD2`: +1. Enter `gpg --edit-key GPG key ID`, substituting in the GPG key ID you'd like to use. In the following example, the GPG key ID is `3AA5C34371567BD2`: ```shell gpg --edit-key 3AA5C34371567BD2 ``` -5. Enter `gpg> adduid` to add the user ID details. +1. Enter `gpg> adduid` to add the user ID details. ```shell gpg> adduid ``` -6. Follow the prompts to supply your real name, email address, and any comments. You can modify your entries by choosing `N`, `C`, or `E`. {% data reusables.gpg.private-email %} {% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)."{% endif %} +1. Follow the prompts to supply your real name, email address, and any comments. You can modify your entries by choosing `N`, `C`, or `E`. {% data reusables.gpg.private-email %} {% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)."{% endif %} ```shell Real Name: OCTOCAT @@ -45,22 +45,22 @@ If you're using a GPG key that matches your committer identity and your verified Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? ``` -7. Enter `O` to confirm your selections. -8. Enter your key's passphrase. -9. Enter `gpg> save` to save the changes +1. Enter `O` to confirm your selections. +1. Enter your key's passphrase. +1. Enter `gpg> save` to save the changes ```shell gpg> save ``` -10. Enter `gpg --armor --export GPG key ID`, substituting in the GPG key ID you'd like to use. In the following example, the GPG key ID is `3AA5C34371567BD2`: +1. Enter `gpg --armor --export GPG key ID`, substituting in the GPG key ID you'd like to use. In the following example, the GPG key ID is `3AA5C34371567BD2`: ```shell $ gpg --armor --export 3AA5C34371567BD2 # Prints the GPG key, in ASCII armor format ``` -11. Upload the GPG key by [adding it to your GitHub account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). +1. Upload the GPG key by [adding it to your GitHub account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). ## Further reading diff --git a/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md b/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md index 9fbf07d70b0f..d129c197872b 100644 --- a/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md +++ b/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md @@ -25,13 +25,15 @@ shortTitle: Existing GPG keys {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.gpg.list-keys-with-note %} -3. Check the command output to see if you have a GPG key pair. +1. Check the command output to see if you have a GPG key pair. *If there are no GPG key pairs or you don't want to use any that are available for signing commits and tags, then [generate a new GPG key](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key). * If there's an existing GPG key pair and you want to use it to sign commits and tags, you can display the public key using the following command, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: + ```shell $ gpg --armor --export 3AA5C34371567BD2 # Prints the GPG key ID, in ASCII armor format ``` + You can then [add your GPG key to your GitHub account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). ## Further reading diff --git a/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md b/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md index 287bb7306e2f..73628e71d90f 100644 --- a/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md +++ b/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md @@ -34,4 +34,4 @@ You should only enable vigilant mode if you sign all of your commits and tags an {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.ssh %} -3. Under "Vigilant mode," select **Flag unsigned commits as unverified**. +1. Under "Vigilant mode," select **Flag unsigned commits as unverified**. diff --git a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index b2a02a8799f8..699deb398aee 100644 --- a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -26,7 +26,7 @@ topics: 1. Download and install [the GPG command line tools](https://www.gnupg.org/download/) for your operating system. We generally recommend installing the latest version for your operating system. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Generate a GPG key pair. Since there are multiple versions of GPG, you may need to consult the relevant [_man page_](https://en.wikipedia.org/wiki/Man_page) to find the appropriate key generation command. +1. Generate a GPG key pair. Since there are multiple versions of GPG, you may need to consult the relevant [_man page_](https://en.wikipedia.org/wiki/Man_page) to find the appropriate key generation command. - If you are on version 2.1.17 or greater, paste the text below to generate a GPG key pair. ```shell copy @@ -39,11 +39,11 @@ topics: gpg --default-new-key-algo rsa4096 --gen-key ``` -4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default. -5. At the prompt, specify the key size you want, or press `Enter` to accept the default. -6. Enter the length of time the key should be valid. Press `Enter` to specify the default selection, indicating that the key doesn't expire. Unless you require an expiration date, we recommend accepting this default. -7. Verify that your selections are correct. -8. Enter your user ID information. +1. At the prompt, specify the kind of key you want, or press `Enter` to accept the default. +1. At the prompt, specify the key size you want, or press `Enter` to accept the default. +1. Enter the length of time the key should be valid. Press `Enter` to specify the default selection, indicating that the key doesn't expire. Unless you require an expiration date, we recommend accepting this default. +1. Verify that your selections are correct. +1. Enter your user ID information. {% note %} @@ -51,18 +51,18 @@ topics: {% endnote %} -9. Type a secure passphrase. +1. Type a secure passphrase. {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} -10. Paste the text below, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: +1. Paste the text below, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: - ```shell - gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell + gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` -11. Copy your GPG key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`. -12. [Add the GPG key to your GitHub account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). +1. Copy your GPG key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`. +1. [Add the GPG key to your GitHub account](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). ## Further reading diff --git a/content/authentication/managing-commit-signature-verification/signing-commits.md b/content/authentication/managing-commit-signature-verification/signing-commits.md index f95937df712b..aba9600c5f20 100644 --- a/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -41,17 +41,17 @@ If you have multiple keys or are attempting to sign commits or tags with a key t # Creates a signed commit ``` -2. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key). -3. When you've finished creating commits locally, push them to your remote repository on {% data variables.product.product_name %}: +1. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key). +1. When you've finished creating commits locally, push them to your remote repository on {% data variables.product.product_name %}: ```shell $ git push # Pushes your local commits to the remote repository ``` -4. On {% data variables.product.product_name %}, navigate to your pull request. +1. On {% data variables.product.product_name %}, navigate to your pull request. {% data reusables.repositories.review-pr-commits %} -5. To view more detailed information about the verified signature, click **Verified.** +1. To view more detailed information about the verified signature, click **Verified.** ![Screenshot of a commit in the commit list for a repository. "Verified" is highlighted with an orange outline.](/assets/images/help/commits/verified-commit.png) diff --git a/content/authentication/managing-commit-signature-verification/signing-tags.md b/content/authentication/managing-commit-signature-verification/signing-tags.md index b55d90bdba81..dfb08dc25b7f 100644 --- a/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -24,7 +24,7 @@ topics: # Creates a signed tag ``` -2. Verify your signed tag by running `git tag -v [tag-name]`. +1. Verify your signed tag by running `git tag -v [tag-name]`. ```shell $ git tag -v MYTAG diff --git a/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md b/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md index b6175e0eee3f..dc61b1ea5579 100644 --- a/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md +++ b/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md @@ -21,10 +21,10 @@ shortTitle: Check verification status 1. On {% data variables.product.product_name %}, navigate to your pull request. {% data reusables.repositories.review-pr-commits %} -3. Next to your commit's abbreviated commit hash, there is a box that shows whether your commit signature is verified{% ifversion fpt or ghec %}, partially verified,{% endif %} or unverified. +1. Next to your commit's abbreviated commit hash, there is a box that shows whether your commit signature is verified{% ifversion fpt or ghec %}, partially verified,{% endif %} or unverified. ![Screenshot of a commit in the commit list for a repository. "Verified" is highlighted with an orange outline.](/assets/images/help/commits/verified-commit.png) -4. To view more detailed information about the commit signature, click **Verified**{% ifversion fpt or ghec %}, **Partially verified**,{% endif %} or **Unverified**. +1. To view more detailed information about the commit signature, click **Verified**{% ifversion fpt or ghec %}, **Partially verified**,{% endif %} or **Unverified**. GPG signed commits will show the ID of the key that was used.{% ifversion ssh-commit-verification %} SSH signed commits will show the signature of the public key that was used.{% endif %} @@ -32,11 +32,11 @@ shortTitle: Check verification status {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} -2. At the top of the Releases page, click **Tags**. -3. Next to your tag description, there is a box that shows whether your tag signature is verified{% ifversion fpt or ghec %}, partially verified,{% endif %} or unverified. +1. At the top of the Releases page, click **Tags**. +1. Next to your tag description, there is a box that shows whether your tag signature is verified{% ifversion fpt or ghec %}, partially verified,{% endif %} or unverified. ![Screenshot of a tag in the tag list for a repository. "Verified" is highlighted with an orange outline.](/assets/images/help/commits/gpg-signed-tag-verified.png) -4. To view more detailed information about the tag signature, click **Verified**{% ifversion fpt or ghec %}, **Partially verified**,{% endif %} or **Unverified**. +1. To view more detailed information about the tag signature, click **Verified**{% ifversion fpt or ghec %}, **Partially verified**,{% endif %} or **Unverified**. ## Further reading diff --git a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md index 3776a54b763f..33f5b852664e 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md +++ b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md @@ -58,8 +58,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} {% mac %} {% data reusables.command_line.open_the_multi_os_terminal %} - -2. Verify that you have a private key generated and loaded into SSH. +1. Verify that you have a private key generated and loaded into SSH. ```shell # start the ssh-agent in the background @@ -78,8 +77,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} 1. {% data reusables.desktop.windows_git_bash_turn_on_ssh_agent %} {% data reusables.desktop.windows_git_for_windows_turn_on_ssh_agent %} - -2. Verify that you have a private key generated and loaded into SSH. +1. Verify that you have a private key generated and loaded into SSH. ```shell $ ssh-add -l -E sha256 @@ -92,7 +90,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} {% data reusables.command_line.open_the_multi_os_terminal %} -2. Verify that you have a private key generated and loaded into SSH. +1. Verify that you have a private key generated and loaded into SSH. ```shell $ ssh-add -l -E sha256 @@ -148,14 +146,14 @@ You must provide your public key to {% data variables.product.product_name %} to {% mac %} 1. Open Terminal. -2. Start SSH agent in the background. +1. Start SSH agent in the background. ```shell $ eval "$(ssh-agent -s)" > Agent pid 59566 ``` -3. Find and take a note of your public key fingerprint. +1. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 @@ -164,21 +162,21 @@ You must provide your public key to {% data variables.product.product_name %} to {% 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. +1. Compare the list of SSH keys with the output from the `ssh-add` command. {% endmac %} {% windows %} 1. Open the command line. -2. Start SSH agent in the background. +1. Start SSH agent in the background. ```shell $ ssh-agent -s > Agent pid 59566 ``` -3. Find and take a note of your public key fingerprint. +1. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 @@ -187,21 +185,21 @@ You must provide your public key to {% data variables.product.product_name %} to {% 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. +1. Compare the list of SSH keys with the output from the `ssh-add` command. {% endwindows %} {% linux %} 1. Open Terminal. -2. Start SSH agent in the background. +1. Start SSH agent in the background. ```shell $ eval "$(ssh-agent -s)" > Agent pid 59566 ``` -3. Find and take a note of your public key fingerprint. If you're using OpenSSH 6.7 or older: +1. Find and take a note of your public key fingerprint. If you're using OpenSSH 6.7 or older: ```shell $ ssh-add -l @@ -217,7 +215,7 @@ You must provide your public key to {% data variables.product.product_name %} to {% 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. +1. Compare the list of SSH keys with the output from the `ssh-add` command. {% endlinux %} diff --git a/content/authentication/troubleshooting-ssh/error-unknown-key-type.md b/content/authentication/troubleshooting-ssh/error-unknown-key-type.md index 8dc7e6e68bf3..905d31284d46 100644 --- a/content/authentication/troubleshooting-ssh/error-unknown-key-type.md +++ b/content/authentication/troubleshooting-ssh/error-unknown-key-type.md @@ -31,8 +31,8 @@ If you remove OpenSSH, the passphrases that are stored in your keychain will onc {% endwarning %} 1. Open Terminal. -2. Enter the command `brew install openssh`. -3. Quit and relaunch Terminal. -4. Try the procedure for generating a new SSH key again. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key-for-a-hardware-security-key)." +1. Enter the command `brew install openssh`. +1. Quit and relaunch Terminal. +1. Try the procedure for generating a new SSH key again. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key-for-a-hardware-security-key)." {% endmac %}{% linux %}To solve this issue on Linux, use the package manager for your Linux distribution to install a new version of OpenSSH, or compile a new version from source. If you install a different version of OpenSSH, the ability of other applications to authenticate via SSH may be affected. For more information, review the documentation for your distribution.{% endlinux %} diff --git a/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md b/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md index d35102b7033c..d29cd60b97b8 100644 --- a/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md +++ b/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md @@ -21,11 +21,11 @@ shortTitle: Recover SSH key passphrase If you [configured your SSH passphrase with the macOS keychain](/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases#saving-your-passphrase-in-the-keychain), you may be able to recover it. 1. In Finder, search for the **Keychain Access** app. -2. In Keychain Access, search for **SSH**. -3. Double click on the entry for your SSH key to open a new dialog box. -4. In the lower-left corner, select **Show password**. -5. You'll be prompted for your administrative password. Type it into the "Keychain Access" dialog box. -6. Your password will be revealed. +1. In Keychain Access, search for **SSH**. +1. Double click on the entry for your SSH key to open a new dialog box. +1. In the lower-left corner, select **Show password**. +1. You'll be prompted for your administrative password. Type it into the "Keychain Access" dialog box. +1. Your password will be revealed. {% endmac %} diff --git a/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md b/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md index bb9d498669ea..27d08d1e1608 100644 --- a/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md +++ b/content/billing/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing.md @@ -23,8 +23,8 @@ Each license for {% data variables.product.prodname_GH_advanced_security %} spec 1. Under "{% data variables.product.prodname_GH_advanced_security %} GitHub Advanced Security", click **Committers**. ![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Committers" dropdown is highlighted with an orange line.](/assets/images/help/enterprises/ghas-committers-dropdown.png) -2. Under "Committers", click **Manage committers**. -3. Under "Total committers", click the plus or minus buttons to add or remove committers. +1. Under "Committers", click **Manage committers**. +1. Under "Total committers", click the plus or minus buttons to add or remove committers. ![Screenshot of the {% data variables.product.prodname_GH_advanced_security %} committers screen. A text box with the number 5, a minus button on its left, and a plus button on its right, are highlighted in an orange outline.](/assets/images/help/enterprises/ghas-add-committers.png) 1. Click **Update committers**. @@ -37,4 +37,4 @@ Each license for {% data variables.product.prodname_GH_advanced_security %} spec 1. To the right of "GitHub Advanced Security", click **Manage**, then click **Cancel Subscription**. ![Screenshot of the "Manage" dropdown in the {% data variables.product.prodname_GH_advanced_security %} licensing screen. The "Cancel Subscription" button is highlighted with an orange outline.](/assets/images/help/enterprises/ghas-cancel-subscription.png) -2. To confirm your cancellation, click **I understand, cancel Advanced Security**. +1. To confirm your cancellation, click **I understand, cancel Advanced Security**. diff --git a/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md b/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md index 33fdd0c050eb..39ed6002e737 100644 --- a/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md +++ b/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md @@ -23,7 +23,7 @@ shortTitle: Set up an Advanced Security trial {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} 1. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Start free trial**. -2. Click **Start trial**. +1. Click **Start trial**. ## Finishing your trial diff --git a/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md b/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md index 9d409fb97225..9d210759d933 100644 --- a/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md +++ b/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md @@ -40,7 +40,7 @@ If you downgrade your personal account from {% data variables.product.prodname_p {% data reusables.user-settings.billing_plans %} 1. Under "Current plan", use the **Edit** drop-down and click **Downgrade to Free**. ![Screenshot of the "Current plan" section of the billing settings page. The "Edit" dropdown menu is expanded and highlighted with an orange outline.](/assets/images/help/billing/downgrade-to-free.png) -5. Read the information about the features your personal account will no longer have access to on your next billing date, then click **I understand. Continue with downgrade**. +1. Read the information about the features your personal account will no longer have access to on your next billing date, then click **I understand. Continue with downgrade**. If you published a {% data variables.product.prodname_pages %} site in a private repository and added a custom domain, remove or update your DNS records before downgrading from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, to avoid the risk of a domain takeover. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site)." @@ -70,7 +70,7 @@ Downgrading from {% data variables.product.prodname_ghe_cloud %} disables any SA {% data reusables.dotcom_billing.switch-legacy-billing %} For more information, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription#switching-your-organization-from-per-repository-to-per-user-pricing)." {% data reusables.organizations.billing-settings %} -5. Under "Subscriptions", next to your current subscription, select the **Edit** dropdown menu and click **Edit plan**. +1. Under "Subscriptions", next to your current subscription, select the **Edit** dropdown menu and click **Edit plan**. 1. Under "Billing/Plans", next to the plan you want to change, click **Downgrade**. 1. Enter the reason you're downgrading your account, then click **Downgrade plan**. diff --git a/content/billing/managing-billing-for-your-github-account/managing-invoices-for-your-enterprise.md b/content/billing/managing-billing-for-your-github-account/managing-invoices-for-your-enterprise.md index 64af89e72d2f..976ab35ecd7e 100644 --- a/content/billing/managing-billing-for-your-github-account/managing-invoices-for-your-enterprise.md +++ b/content/billing/managing-billing-for-your-github-account/managing-invoices-for-your-enterprise.md @@ -25,7 +25,7 @@ For more information about viewing the subscription and usage for your enterpris {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} -4. Under "Latest invoice", click **View**. +1. Under "Latest invoice", click **View**. ![Screenshot of the billing summary for an enterprise account. A link, labeled "View", is highlighted with an orange outline.](/assets/images/help/business-accounts/view-invoice-link.png) @@ -34,17 +34,17 @@ For more information about viewing the subscription and usage for your enterpris {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} -4. Under "Latest invoice", click **Pay invoice**. +1. Under "Latest invoice", click **Pay invoice**. ![Screenshot of the billing summary for an enterprise account. A link, labeled "Pay invoice", is highlighted with an orange outline.](/assets/images/help/business-accounts/pay-invoice-link.png) -5. Under "Pay invoice", type your credit card information in the secure form, then click **Pay Invoice**. +1. Under "Pay invoice", type your credit card information in the secure form, then click **Pay Invoice**. ## Downloading your current invoice {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} -4. Under "Quick Actions", click **Download current invoice**. +1. Under "Quick Actions", click **Download current invoice**. ![Screenshot of the billing summary for an enterprise account. A link, labeled "Download current invoice", is highlighted with an orange outline.](/assets/images/help/business-accounts/download-current-invoice.png) @@ -53,6 +53,6 @@ For more information about viewing the subscription and usage for your enterpris {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} -4. To see a summary of your past billing activity, under "Billing", click the **Past invoices** tab. +1. To see a summary of your past billing activity, under "Billing", click the **Past invoices** tab. ![Screenshot of the billing page for an enterprise account. A tab, labeled "Past invoices", is highlighted with an orange outline.](/assets/images/help/business-accounts/view-payment-history.png) diff --git a/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md b/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md index 603e1c0e0fae..b828bd42cf7f 100644 --- a/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md +++ b/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md @@ -44,7 +44,7 @@ You can upgrade your personal account from {% data variables.product.prodname_fr {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} 1. Next to "Current plan", click **Upgrade**. -2. Under "Pro" on the "Compare plans" page, click **Upgrade to Pro**. +1. Under "Pro" on the "Compare plans" page, click **Upgrade to Pro**. {% data reusables.dotcom_billing.choose-monthly-or-yearly-billing %} {% data reusables.dotcom_billing.show-plan-details %} {% data reusables.dotcom_billing.enter-billing-info %} @@ -90,8 +90,8 @@ If you'd like additional users to have access to your {% data variables.product. {% data reusables.dotcom_billing.switch-legacy-billing %} For more information, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/about-per-user-pricing)." {% data reusables.organizations.billing-settings %} -5. To the right of your plan name, select the **Edit** dropdown menu, then click **Edit plan**. -6. To the right of "Advanced tools for teams", click **Upgrade now**. +1. To the right of your plan name, select the **Edit** dropdown menu, then click **Edit plan**. +1. To the right of "Advanced tools for teams", click **Upgrade now**. {% data reusables.dotcom_billing.choose_org_plan %} {% data reusables.dotcom_billing.choose-monthly-or-yearly-billing %} {% data reusables.dotcom_billing.owned_by_business %} diff --git a/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md b/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md index 4792fc06d140..e48f593817c2 100644 --- a/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md +++ b/content/billing/managing-your-github-billing-settings/changing-the-duration-of-your-billing-cycle.md @@ -40,8 +40,8 @@ When you change your billing cycle's duration, your {% data variables.product.pr ### Changing the duration of a legacy per-repository plan {% data reusables.organizations.billing-settings %} -4. Under "Billing overview", next to your plan, click **Change plan**. -5. At the top right corner, click **Switch to monthly billing** or **Switch to yearly billing**. +1. Under "Billing overview", next to your plan, click **Change plan**. +1. At the top right corner, click **Switch to monthly billing** or **Switch to yearly billing**. {% ifversion ghec %} diff --git a/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md b/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md index afceb5e83cd8..d6cbeee36d49 100644 --- a/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md +++ b/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md @@ -27,7 +27,7 @@ You cannot apply coupons to paid plans for {% data variables.product.prodname_ma ## Redeeming a coupon for your personal account {% data reusables.dotcom_billing.enter_coupon_code_on_redeem_page %} -4. Under "Redeem your coupon", click **Choose** next to your _personal_ account's username. +1. Under "Redeem your coupon", click **Choose** next to your _personal_ account's username. {% data reusables.dotcom_billing.redeem_coupon %} ## Redeeming a coupon for your organization @@ -35,5 +35,5 @@ You cannot apply coupons to paid plans for {% data variables.product.prodname_ma {% data reusables.dotcom_billing.org-billing-perms %} {% data reusables.dotcom_billing.enter_coupon_code_on_redeem_page %} -4. Under "Redeem your coupon", click **Choose** next to the _organization_ you want to apply the coupon to. If you'd like to apply your coupon to a new organization that doesn't exist yet, click **Create a new organization**. +1. Under "Redeem your coupon", click **Choose** next to the _organization_ you want to apply the coupon to. If you'd like to apply your coupon to a new organization that doesn't exist yet, click **Create a new organization**. {% data reusables.dotcom_billing.redeem_coupon %} diff --git a/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md b/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md index 98089bddb25b..0b93bbafb561 100644 --- a/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md +++ b/content/billing/managing-your-github-billing-settings/setting-your-billing-email.md @@ -36,7 +36,7 @@ Your organization's billing email is where {% data variables.product.product_nam {% data reusables.organizations.billing-settings %} 1. Under "Billing management", under "Email recipients", find the email address you want to change and click **Edit**. ![Screenshot of the "Email recipients" list. Next to an email address, a button, labeled "Edit", is highlighted with an orange outline.](/assets/images/help/billing/billing-change-email.png) -2. Type a valid email address, then click **Update**. +1. Type a valid email address, then click **Update**. ## Managing additional recipients for your organization's billing email @@ -96,9 +96,9 @@ Only enterprise members with the owner or billing manager role can access or cha {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} 1. Click **Billing emails**. -2. Under "Email recipients", to the right of the billing email address, click **Add**. +1. Under "Email recipients", to the right of the billing email address, click **Add**. ![Screenshot of the "Billing management" section. Next to "Email recipients", a button, labeled "Add", is highlighted with an orange outline.](/assets/images/help/billing/billing-add-email-recipient.png) -3. Type the email address of the recipient, then click **Add**. +1. Type the email address of the recipient, then click **Add**. ### Removing a recipient from billing notifications for your enterprise diff --git a/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md b/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md index 2e2446477dce..612f9a970f91 100644 --- a/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md +++ b/content/billing/managing-your-license-for-github-enterprise/downloading-your-license-for-github-enterprise.md @@ -30,7 +30,7 @@ There are two possible ways to download a license file for {% data variables.pro 1. If you are using a trial of {% data variables.product.prodname_ghe_server %}, if you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, or if you are not sure, you may be able to download your license file from the [{% data variables.product.prodname_enterprise %} website](https://enterprise.github.com/download). -2. If you are an existing {% data variables.product.prodname_enterprise %} customer with an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you can download your license file from {% data variables.product.prodname_dotcom_the_website %} using the following instructions. +1. If you are an existing {% data variables.product.prodname_enterprise %} customer with an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you can download your license file from {% data variables.product.prodname_dotcom_the_website %} using the following instructions. If you have any questions about downloading your license, contact {% data variables.contact.contact_enterprise_sales %}. For more information about enterprise accounts, see "[AUTOTITLE](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts){% ifversion ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} diff --git a/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md index 67c8bb837bf9..6d9152e19831 100644 --- a/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -52,11 +52,11 @@ You can download a JSON file from {% data variables.product.prodname_ghe_server {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -5. In the "User licenses" section, under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**. +1. In the "User licenses" section, under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**. ![Screenshot of the "User licenses" section of the "License" page. A link, labeled "Export license usage", is outlined in dark orange.](/assets/images/enterprise/management-console/export-license-usage-link.png) {% data reusables.enterprise-accounts.access-enterprise-on-dotcom %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.license-tab %} -10. Next to "Enterprise Server instances", click **Add server usage**. -11. Upload the JSON file you downloaded from {% data variables.product.prodname_ghe_server %}. +1. Next to "Enterprise Server instances", click **Add server usage**. +1. Upload the JSON file you downloaded from {% data variables.product.prodname_ghe_server %}. diff --git a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-enterprise-accounts-for-procurement-companies/creating-and-paying-for-an-enterprise-account-on-behalf-of-a-client.md b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-enterprise-accounts-for-procurement-companies/creating-and-paying-for-an-enterprise-account-on-behalf-of-a-client.md index ae8e0997ea60..a6f906670e9b 100644 --- a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-enterprise-accounts-for-procurement-companies/creating-and-paying-for-an-enterprise-account-on-behalf-of-a-client.md +++ b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-enterprise-accounts-for-procurement-companies/creating-and-paying-for-an-enterprise-account-on-behalf-of-a-client.md @@ -30,7 +30,7 @@ You will use your personal account to set up the enterprise account. You'll also {% data reusables.enterprise.create-enterprise-account %} 1. Complete the form with your client's information. -8. Click **Create your enterprise**. +1. Click **Create your enterprise**. ## Step 3: Upgrade the enterprise to a yearly paid subscription @@ -52,11 +52,11 @@ Invite your client to become an enterprise owner. For more information, see "[AU {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -4. Confirm that your client is listed as an enterprise owner. -5. To the right of your username, select the {% octicon "kebab-horizontal" aria-label="Administrator settings" %} dropdown menu, then click **Change role**. +1. Confirm that your client is listed as an enterprise owner. +1. To the right of your username, select the {% octicon "kebab-horizontal" aria-label="Administrator settings" %} dropdown menu, then click **Change role**. ![Screenshot of a user in the administrators list. A dropdown menu, labeled with a kebab icon, is highlighted with an orange outline.](/assets/images/help/business-accounts/administrator-settings.png) -6. Select **Billing manager**, then click **Change role**. +1. Select **Billing manager**, then click **Change role**. ## Next steps diff --git a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md index 768388377573..eb4bbc7915ca 100644 --- a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md +++ b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/creating-and-paying-for-an-organization-on-behalf-of-a-client.md @@ -50,7 +50,7 @@ You will use your personal account to set up the organization. You'll also need {% data reusables.organizations.billing_plans %} {% data reusables.dotcom_billing.upgrade_org %} {% data reusables.dotcom_billing.choose_org_plan %} (You can add more seats to the organization in the next step.) -6. Under "Upgrade summary", select **Pay yearly** to pay for the organization yearly. +1. Under "Upgrade summary", select **Pay yearly** to pay for the organization yearly. {% data reusables.dotcom_billing.enter-payment-info %} {% data reusables.dotcom_billing.finish_upgrade %} @@ -88,5 +88,5 @@ You will use your personal account to set up the organization. You'll also need ## Next steps 1. Contact your client and ask them to [add you to the organization as a billing manager](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization). You'll need to be a billing manager for the organization so that you can renew or make changes to your client's subscription in the future. -2. If you would like your organization's credit card to be removed from the organization so that it's not charged again, contact {% data variables.contact.contact_support %}. -3. When it's time to renew your client's paid subscription, see "[AUTOTITLE](/articles/renewing-your-client-s-paid-organization)." +1. If you would like your organization's credit card to be removed from the organization so that it's not charged again, contact {% data variables.contact.contact_support %}. +1. When it's time to renew your client's paid subscription, see "[AUTOTITLE](/articles/renewing-your-client-s-paid-organization)." diff --git a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md b/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md index 703c6712b171..a4a1680c0bb0 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md @@ -27,15 +27,15 @@ Enabling GHAS across a large organization can be broken down into six core phase 1. [**Align on your rollout strategy and goals**](/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals): Think about what success will look like, and align on how GHAS will be implemented in your company. This phase may only take a few days or a week, but it lays a solid foundation for the rest of the rollout. -2. [**Preparing to enable at scale**](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale): Prepare developers, collect data about your repositories, and ensure you're ready for the next phase. +1. [**Preparing to enable at scale**](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale): Prepare developers, collect data about your repositories, and ensure you're ready for the next phase. -3. [**Pilot programs**](/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs): Optionally, pilot an initial rollout to a few high-impact projects and teams. This will allow an initial group within your company to get familiar with GHAS before you roll out to the remainder of your company. +1. [**Pilot programs**](/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs): Optionally, pilot an initial rollout to a few high-impact projects and teams. This will allow an initial group within your company to get familiar with GHAS before you roll out to the remainder of your company. -4. [**Create internal documentation**](/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation): Create and communicate internal documentation for the consumers of GHAS. Without proper documentation provided to developers, security engineers, and others who will be using GHAS, the value will get lost in the rollout. +1. [**Create internal documentation**](/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation): Create and communicate internal documentation for the consumers of GHAS. Without proper documentation provided to developers, security engineers, and others who will be using GHAS, the value will get lost in the rollout. -5. [**Rollout and scale {% data variables.product.prodname_code_scanning %}**](/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning): Leveraging the available APIs, automatically rollout {% data variables.product.prodname_code_scanning %} by team and by language across your enterprise, using the repository data you collected earlier. +1. [**Rollout and scale {% data variables.product.prodname_code_scanning %}**](/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning): Leveraging the available APIs, automatically rollout {% data variables.product.prodname_code_scanning %} by team and by language across your enterprise, using the repository data you collected earlier. -6. [**Rollout and scale {% data variables.product.prodname_secret_scanning %}**](/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning): Roll out {% data variables.product.prodname_secret_scanning %}, which involves less configuration and is therefore simpler to adopt than {% data variables.product.prodname_code_scanning %}. Still, it's critical to have a strategy for handling new and old results. +1. [**Rollout and scale {% data variables.product.prodname_secret_scanning %}**](/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning): Roll out {% data variables.product.prodname_secret_scanning %}, which involves less configuration and is therefore simpler to adopt than {% data variables.product.prodname_code_scanning %}. Still, it's critical to have a strategy for handling new and old results. ## {% data variables.contact.github_support %} and {% data variables.product.prodname_professional_services_team %} diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index 6c0784f59d5a..f20454bf92ea 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -27,14 +27,14 @@ When you enable {% data variables.product.prodname_secret_scanning %}, you shoul There are a few approaches for tackling newly committed credentials, but one example approach would be: 1. **Notify**: Use webhooks to ensure that any new secret alerts are seen by the right teams as quickly as possible. A webhook fires when a secret alert is either created, resolved, or reopened. You can then parse the webhook payload, and integrate it into any tools you and your team use such Slack, Teams, Splunk, or email. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks)" and "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert)." -2. **Follow Up**: Create a high-level remediation process that works for all secret types. For example, you could contact the developer who committed the secret and their technical lead on that project, highlighting the dangers of committing secrets to GitHub, and asking the them to revoke, and update the detected secret. +1. **Follow Up**: Create a high-level remediation process that works for all secret types. For example, you could contact the developer who committed the secret and their technical lead on that project, highlighting the dangers of committing secrets to GitHub, and asking the them to revoke, and update the detected secret. {% note %} **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. {% endnote %} -3. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. +1. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. Repeat the last two steps for any new secrets leaked. This process encourages developers to take responsibility for managing the secrets used in their code securely, and allows you to measure the reduction in newly committed secrets. @@ -60,7 +60,7 @@ Once you have decided on the secret types, you can do the following: {% endnote %} -2. When you have created the process that teams will follow for revoking credentials, you can collate information about the types of secrets and other metadata associated with the leaked secrets so you can discern who to communicate the new process to. +1. When you have created the process that teams will follow for revoking credentials, you can collate information about the types of secrets and other metadata associated with the leaked secrets so you can discern who to communicate the new process to. {% ifversion not ghae %} You can use security overview to collect this information. For more information about using security overview, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)."{% endif %} @@ -78,7 +78,7 @@ Once you have decided on the secret types, you can do the following: {% endnote %} -3. After you collect information about leaked secrets, create a targeted communication plan for the users who maintain the repositories affected by each secret type. You could use email, messaging, or even create GitHub issues in the affected repositories. If you can use APIs provided by these tools to send out the communications in an automated manner, this will make it easier for you to scale across multiple secret types. +1. After you collect information about leaked secrets, create a targeted communication plan for the users who maintain the repositories affected by each secret type. You could use email, messaging, or even create GitHub issues in the affected repositories. If you can use APIs provided by these tools to send out the communications in an automated manner, this will make it easier for you to scale across multiple secret types. ## 3. Expand the program to include more secret types and custom patterns diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale.md index b35c5d697a0d..c4b96a4391e1 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale.md @@ -19,7 +19,7 @@ There are multiple ways to configure {% data variables.product.prodname_code_sca The best method to use depends on the analysis needs of the repositories. 1. The repositories are eligible for default setup for {% data variables.product.prodname_codeql %} and are owned by an organization. -2. The group of repositories has similar configuration needs for {% data variables.product.prodname_codeql %} advanced setup. +1. The group of repositories has similar configuration needs for {% data variables.product.prodname_codeql %} advanced setup. In addition, {% data variables.product.prodname_actions %} must be enabled for the {% ifversion fpt %}organization{% elsif ghec or ghae %}organization or enterprise{% elsif ghes %}site{% endif %}. @@ -95,7 +95,7 @@ You can select all of the displayed repositories, or a subset of them, and enabl For repositories that are not eligible for default setup, you can use a bulk configuration script to configure advanced setup across multiple repositories. 1. Identify a group of repositories that can be analyzed using the same {% data variables.product.prodname_code_scanning %} configuration. For example, all repositories that build Java artifacts using the production environment. -2. Create and test a {% data variables.product.prodname_actions %} workflow to call the {% data variables.product.prodname_codeql %} action with the appropriate configuration. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository#creating-an-advanced-setup)." -3. Use one of the example scripts create a custom script to add the workflow to each repository in the group. +1. Create and test a {% data variables.product.prodname_actions %} workflow to call the {% data variables.product.prodname_codeql %} action with the appropriate configuration. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository#creating-an-advanced-setup)." +1. Use one of the example scripts create a custom script to add the workflow to each repository in the group. - PowerShell example: [`jhutchings1/Create-ActionsPRs`](https://github.com/jhutchings1/Create-ActionsPRs) repository - NodeJS example: [`nickliffen/ghas-enablement`](https://github.com/NickLiffen/ghas-enablement) repository diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md index 1a66bf432903..c8af6b5c9c94 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists.md @@ -69,10 +69,10 @@ The status of the tracked alert won't change if you change the checkbox state of {% data variables.product.prodname_dotcom %} prepopulates the issue: - The title contains the name of the {% data variables.product.prodname_code_scanning %} alert. - The body contains the task list item with the full URL to the {% data variables.product.prodname_code_scanning %} alert. -2. Optionally, edit the title and the body of the issue. +1. Optionally, edit the title and the body of the issue. {% warning %} **Warning:** You may want to edit the title of the issue as it may expose security information. You can also edit the body of the issue. Make sure that you keep the task list item with a link to the alert otherwise the issue will no longer track the alert. {% endwarning %} -3. Click **Submit new issue**. +1. Click **Submit new issue**. diff --git a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index d979962c2b93..e340ce36063f 100644 --- a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -35,8 +35,8 @@ You use three different commands to generate results and upload them to {% data 1. `database create` to create a {% data variables.product.prodname_codeql %} database to represent the hierarchical structure of each supported programming language in the repository. -2. `database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. -3. `github upload-results` to upload the resulting SARIF files to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. +1. `database analyze` to run queries to analyze each {% data variables.product.prodname_codeql %} database and summarize the results in a SARIF file. +1. `github upload-results` to upload the resulting SARIF files to {% data variables.product.product_name %} where the results are matched to a branch or pull request and displayed as {% data variables.product.prodname_code_scanning %} alerts. You can display the command-line help for any command using the `--help` option. @@ -47,9 +47,9 @@ You can display the command-line help for any command using the `--help`/`, where `` is the name of the {% data variables.product.prodname_dotcom %} organization or user account that you will publish to. -2. In the `qlpack.yml` file, include a `version` property with a semver identifier, as well as an optional `dependencies` block. +1. In the `qlpack.yml` file, include a `version` property with a semver identifier, as well as an optional `dependencies` block. -3. Migrate the list of dependencies in `libraryPathDependencies` to the `dependencies` block. Specify the version range for each dependency. If the range is unimportant, or you are unsure of compatibility, you can specify `"\*"`, which indicates that any version is acceptable and will default to the latest version when you run `codeql pack install`. +1. Migrate the list of dependencies in `libraryPathDependencies` to the `dependencies` block. Specify the version range for each dependency. If the range is unimportant, or you are unsure of compatibility, you can specify `"\*"`, which indicates that any version is acceptable and will default to the latest version when you run `codeql pack install`. For more information about the properties, see "[About {% data variables.product.prodname_codeql %} packs](/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs#about-codeql-packs)." diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/extractor-options.md b/content/code-security/codeql-cli/using-the-codeql-cli/extractor-options.md index 737e30a14ac3..790ecec45b43 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/extractor-options.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/extractor-options.md @@ -153,6 +153,6 @@ extractor: You can specify `--extractor-options-file` multiple times. The extractor option assignments are processed in the following order: 1. All extractor option files specified by `--extractor-options-file` are processed in the order they appear on the command line, then -2. All extractor option assignments specified by `--extractor-option` are processed in the order they appear on the command line +1. All extractor option assignments specified by `--extractor-option` are processed in the order they appear on the command line The same rules govern what happens when the same extractor option is set multiple times, regardless of whether the assignments are done using `--extractor-option`, using `--extractor-options-file`, or some combination of the two. If you set a `string` extractor option multiple times, the last option value overwrites all previous values. If you set an `array` extractor option multiple times, all option values are concatenated in order. diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.md b/content/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.md index 573dab650989..5adbea7efe81 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.md @@ -72,9 +72,9 @@ Alternatively, you can download `codeql.zip`, which contains the CLI for all sup If you use macOS version 10.15 ("Catalina"), version 11 ("Big Sur"), or the upcoming version 12 ("Monterey"), you need to ensure that your web browser does not automatically extract zip files. If you use Safari, complete the following steps before downloading the {% data variables.product.prodname_codeql_cli %} zip archive: 1. Open Safari. -2. From the Safari menu, select **Preferences…**. -3. Click the **General** Tab. -4. Ensure the check-box labeled **Open "safe" files after downloading** is unchecked. +1. From the Safari menu, select **Preferences…**. +1. Click the **General** Tab. +1. Ensure the check-box labeled **Open "safe" files after downloading** is unchecked. ### 2. Extract the zip archive @@ -86,9 +86,9 @@ simply extract the zip archive. macOS "Catalina", "Big Sur", or "Monterey" users should run the following commands in the Terminal, where `${extraction-root}` is the path to the directory where you will extract the {% data variables.product.prodname_codeql_cli %} zip archive: 1. `mv ~/Downloads/codeql\*.zip ${extraction-root}` -2. `cd ${extraction-root}` -3. `/usr/bin/xattr -c codeql\*.zip` -4. `unzip codeql\*.zip` +1. `cd ${extraction-root}` +1. `/usr/bin/xattr -c codeql\*.zip` +1. `unzip codeql\*.zip` ### 3. Launch `codeql` @@ -154,7 +154,7 @@ the queries and libraries required for {% data variables.product.prodname_codeql Clone a copy of this repository into `codeql-home`. By default, the root of the cloned repository will be called `codeql`. -Rename this folder `codeql-repo` to avoid conflicting with the {% data variables.product.prodname_codeql_cli %} that you will extract in step 4. If you use git on the command line, you can +Rename this folder `codeql-repo` to avoid conflicting with the {% data variables.product.prodname_codeql_cli %} that you will extract in step 1. If you use git on the command line, you can clone and rename the repository in a single step by running `git clone git@github.com:github/codeql.git codeql-repo` in the `codeql-home` folder. diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs.md b/content/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs.md index cebcb867abe2..a43b62f4fe63 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs.md @@ -166,14 +166,14 @@ You can publish packs and download private packs by authenticating to the approp You can authenticate to the {% data variables.product.prodname_container_registry %} on {% data variables.product.prodname_dotcom_the_website %} in two ways: 1. Pass the `--github-auth-stdin` option to the {% data variables.product.prodname_codeql_cli %}, then supply a {% data variables.product.prodname_github_apps %} token or {% data variables.product.pat_generic %} via standard input. -2. Set the `GITHUB_TOKEN` environment variable to a {% data variables.product.prodname_github_apps %} token or {% data variables.product.pat_generic %}. +1. Set the `GITHUB_TOKEN` environment variable to a {% data variables.product.prodname_github_apps %} token or {% data variables.product.pat_generic %}. {% ifversion ghes %} Similarly, you can authenticate to a {% data variables.product.prodname_ghe_server %} {% data variables.product.prodname_container_registry %}, or authenticate to multiple registries simultaneously (for example, to download or run private packs from multiple registries) in two ways: 1. Pass the `--registries-auth-stdin` option to the {% data variables.product.prodname_codeql_cli %}, then supply a registry authentication string via standard input. -2. Set the `CODEQL_REGISTRIES_AUTH` environment variable to a registry authentication string. +1. Set the `CODEQL_REGISTRIES_AUTH` environment variable to a registry authentication string. A registry authentication string is a comma-separated list of `=` pairs, where `registry-url` is a {% data variables.product.prodname_container_registry %} URL, such as `https://containers.GHE_HOSTNAME/v2/`, and `token` is a {% data variables.product.prodname_github_apps %} token or {% data variables.product.pat_generic %} for that {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %}. This ensures that each token is only passed to the {% data variables.product.prodname_container_registry %} you specify. diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries.md b/content/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries.md index 29ec7ad81a3a..a7999e4d9b76 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries.md @@ -128,10 +128,10 @@ blocks in Java code: select ifstmt, "This if statement has an empty then." ``` -2. Save the query to a file named `EmptyThen.ql` in a directory with your +1. Save the query to a file named `EmptyThen.ql` in a directory with your other custom queries. For example, `custom-queries/java/queries/EmptyThen.ql`. -3. If you haven’t already added your custom queries to a {% data variables.product.prodname_codeql %} pack, create a {% data variables.product.prodname_codeql %} pack now. For example, if your custom Java queries are stored in `custom-queries/java/queries`, add a `qlpack.yml` file with the following contents to `custom-queries/java/queries`: +1. If you haven’t already added your custom queries to a {% data variables.product.prodname_codeql %} pack, create a {% data variables.product.prodname_codeql %} pack now. For example, if your custom Java queries are stored in `custom-queries/java/queries`, add a `qlpack.yml` file with the following contents to `custom-queries/java/queries`: ```yaml name: my-custom-queries @@ -141,21 +141,21 @@ other custom queries. For example, `custom-queries/java/queries/EmptyThen.ql`. For more information about {% data variables.product.prodname_codeql %} packs, see "[About {% data variables.product.prodname_codeql %} packs](/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs)." -4. Create a {% data variables.product.prodname_codeql %} pack for your Java tests by adding a `qlpack.yml` file with the following contents to `custom-queries/java/tests`, updating the `dependencies` to match the name of your {% data variables.product.prodname_codeql %} pack of custom queries: +1. Create a {% data variables.product.prodname_codeql %} pack for your Java tests by adding a `qlpack.yml` file with the following contents to `custom-queries/java/tests`, updating the `dependencies` to match the name of your {% data variables.product.prodname_codeql %} pack of custom queries: {% data reusables.codeql-cli.test-qlpack %} -5. Run `codeql pack install` in the root of the test directory. This generates a `codeql-pack.lock.yml` file that specifies all of the transitive dependencies required to run queries in this pack. +1. Run `codeql pack install` in the root of the test directory. This generates a `codeql-pack.lock.yml` file that specifies all of the transitive dependencies required to run queries in this pack. -6. Within the Java test pack, create a directory to contain the test files +1. Within the Java test pack, create a directory to contain the test files associated with `EmptyThen.ql`. For example, `custom-queries/java/tests/EmptyThen`. -7. In the new directory, create `EmptyThen.qlref` to define the location of `EmptyThen.ql`. The path to the query must be specified relative to the root of +1. In the new directory, create `EmptyThen.qlref` to define the location of `EmptyThen.ql`. The path to the query must be specified relative to the root of the {% data variables.product.prodname_codeql %} pack that contains the query. In this case, the query is in the top level directory of the {% data variables.product.prodname_codeql %} pack named `my-custom-queries`, which is declared as a dependency for `my-query-tests`. Therefore, `EmptyThen.qlref` should simply contain `EmptyThen.ql`. -8. Create a code snippet to test. The following Java code contains an empty `if` statement on the third line. Save it in `custom-queries/java/tests/EmptyThen/Test.java`. +1. Create a code snippet to test. The following Java code contains an empty `if` statement on the third line. Save it in `custom-queries/java/tests/EmptyThen/Test.java`. ```java @@ -186,9 +186,9 @@ When the test runs, it: 1. Finds one test in the `EmptyThen` directory. -2. Extracts a {% data variables.product.prodname_codeql %} database from the `.java` files stored in the `EmptyThen` directory. +1. Extracts a {% data variables.product.prodname_codeql %} database from the `.java` files stored in the `EmptyThen` directory. -3. Compiles the query referenced by the `EmptyThen.qlref` file. +1. Compiles the query referenced by the `EmptyThen.qlref` file. If this step fails, it’s because the CLI can’t find your custom {% data variables.product.prodname_codeql %} pack. Re-run the command and specify the location of your custom {% data variables.product.prodname_codeql %} pack, for example: @@ -196,11 +196,11 @@ When the test runs, it: For information about saving the search path as part of your configuration, see "[Specifying command options in a {% data variables.product.prodname_codeql %} configuration file](/code-security/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file)." -4. Executes the test by running the query and generating an `EmptyThen.actual` results file. +1. Executes the test by running the query and generating an `EmptyThen.actual` results file. -5. Checks for an `EmptyThen.expected` file to compare with the `.actual` results file. +1. Checks for an `EmptyThen.expected` file to compare with the `.actual` results file. -6. Reports the results of the test — in this case, a failure: `0 tests passed; 1 tests failed:`. The test failed because we haven’t yet added a file with the expected results of the query. +1. Reports the results of the test — in this case, a failure: `0 tests passed; 1 tests failed:`. The test failed because we haven’t yet added a file with the expected results of the query. ### View the query test output diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 05b9434bccf7..d4aea83c69b2 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -193,12 +193,12 @@ If you schedule extensive work to upgrade a dependency, or decide that an alert ### Dismissing multiple alerts at once 1. View the open {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-dependabot-alerts)". -2. Optionally, filter the list of alerts by selecting a dropdown menu, then clicking the filter that you would like to apply. You can also type filters into the search bar. -3. To the left of each alert title, select the alerts that you want to dismiss. +1. Optionally, filter the list of alerts by selecting a dropdown menu, then clicking the filter that you would like to apply. You can also type filters into the search bar. +1. To the left of each alert title, select the alerts that you want to dismiss. ![Screenshot of the {% data variables.product.prodname_dependabot_alerts %} view. Two alerts are selected and these check boxes are highlighted with an orange outline.](/assets/images/help/graphs/select-multiple-alerts.png) -4. Optionally, at the top of the list of alerts, select all alerts on the page. +1. Optionally, at the top of the list of alerts, select all alerts on the page. ![Screenshot of the header section of the {% data variables.product.prodname_dependabot_alerts %} view. The "Select all" checkbox is highlighted with a dark orange outline.](/assets/images/help/graphs/select-all-alerts.png) -5. Select the "Dismiss alerts" dropdown, and click a reason for dismissing the alerts. +1. Select the "Dismiss alerts" dropdown, and click a reason for dismissing the alerts. ![Screenshot of a list of alerts. Below the "Dismiss alerts" button, a dropdown labeled "Select a reason to dismiss" is expanded. The dropdown contains radio buttons for various options.](/assets/images/help/graphs/dismiss-multiple-alerts.png) {% endif %} @@ -231,10 +231,10 @@ You can view all open alerts, and you can reopen alerts that have been previousl ### Reopening multiple alerts at once 1. View the closed {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-and-updating-closed-alerts)" (above). -2. To the left of each alert title, select the alerts that you want to reopen by clicking the checkbox adjacent to each alert. -3. Optionally, at the top of the list of alerts, select all closed alerts on the page. +1. To the left of each alert title, select the alerts that you want to reopen by clicking the checkbox adjacent to each alert. +1. Optionally, at the top of the list of alerts, select all closed alerts on the page. ![Screenshot of alerts in the "Closed" tab. The "Select all" checkbox is highlighted with a dark orange outline.](/assets/images/help/graphs/select-all-closed-alerts.png) -4. Click **Reopen** to reopen the alerts. Alerts that have already been fixed cannot be reopened. +1. Click **Reopen** to reopen the alerts. Alerts that have already been fixed cannot be reopened. {% endif %} diff --git a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md b/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md index a7b16b834a09..b1ae4b21bffe 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md @@ -109,7 +109,7 @@ On a fork, you also need to explicitly enable {% data variables.product.prodname {% data reusables.repositories.accessing-repository-graphs %} {% data reusables.repositories.click-dependency-graph %} {% data reusables.dependabot.click-dependabot-tab %} -5. Under "Enable Dependabot", click **Enable Dependabot**. +1. Under "Enable Dependabot", click **Enable Dependabot**. {% endif %} diff --git a/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md b/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md index c0e6321ce7c0..bdd8ff83964a 100644 --- a/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md @@ -38,4 +38,4 @@ If any dependencies are missing, check the log files for errors. If any package ## Viewing {% data variables.product.prodname_dependabot %} log files 1. On the **{% data variables.product.prodname_dependabot %}** tab, click **Last checked _TIME_ ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. -2. Optionally, to rerun the version check, click **Check for updates**. +1. Optionally, to rerun the version check, click **Check for updates**. diff --git a/content/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries.md b/content/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries.md index c036726cd8c1..ee59bbb986e7 100644 --- a/content/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries.md +++ b/content/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries.md @@ -189,7 +189,7 @@ encoding@^0.1.11: If the `yarn.lock` file doesn't list the private registry as the dependency source, you can set up Yarn Classic according to the normal package manager instructions: 1. Define the private registry configuration in a `dependabot.yml` file - 2. Add the registry to a `.yarnrc` file in the project root with the key registry. Alternatively run `yarn config set registry `. + 1. Add the registry to a `.yarnrc` file in the project root with the key registry. Alternatively run `yarn config set registry `. ```yaml registry https://private_registry_url @@ -238,7 +238,7 @@ encoding@^0.1.11: If the `yarn.lock` file doesn't list the private registry as the dependency source, you can set up Yarn Berry according to the normal package manager instructions: 1. Define the private registry configuration in a `dependabot.yml` file - 2. Add the registry to a `.yarnrc.yml` file in the project root with the key `npmRegistryServer`. Alternatively run `yarn config set npmRegistryServer `. + 1. Add the registry to a `.yarnrc.yml` file in the project root with the key `npmRegistryServer`. Alternatively run `yarn config set npmRegistryServer `. ``` npmRegistryServer: "https://private_registry_url" ``` diff --git a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md index 630163412b0f..75f87195316f 100644 --- a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md +++ b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md @@ -48,9 +48,9 @@ By making security reporting instructions clearly available, you make it easy fo {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. In the left sidebar, under "Reporting", click **{% octicon "law" aria-hidden="true" %} Policy**. -4. Click **Start setup**. -5. In the new `SECURITY.md` file, add information about supported versions of your project and how to report a vulnerability. +1. In the left sidebar, under "Reporting", click **{% octicon "law" aria-hidden="true" %} Policy**. +1. Click **Start setup**. +1. In the new `SECURITY.md` file, add information about supported versions of your project and how to report a vulnerability. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/content/code-security/getting-started/dependabot-quickstart-guide.md b/content/code-security/getting-started/dependabot-quickstart-guide.md index 79b8b4132947..286d182c51d6 100644 --- a/content/code-security/getting-started/dependabot-quickstart-guide.md +++ b/content/code-security/getting-started/dependabot-quickstart-guide.md @@ -37,9 +37,9 @@ For the purpose of this guide, we're going to use a demo repository to illustrat You need to start by forking the demo repository. 1. Navigate to [https://github.com/dependabot/demo](https://github.com/dependabot/demo). -2. At the top of the page, on the right, click **{% octicon "repo-forked" aria-hidden="true" %} Fork**. -3. Select an owner (you can select your {% data variables.product.prodname_dotcom %} personal account) and type a repository name. For more information about forking repositories, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo#forking-a-repository)." -4. Click **Create fork**. +1. At the top of the page, on the right, click **{% octicon "repo-forked" aria-hidden="true" %} Fork**. +1. Select an owner (you can select your {% data variables.product.prodname_dotcom %} personal account) and type a repository name. For more information about forking repositories, see "[AUTOTITLE](/get-started/quickstart/fork-a-repo#forking-a-repository)." +1. Click **Create fork**. ## Enabling {% data variables.product.prodname_dependabot %} for your repository @@ -49,7 +49,7 @@ You need to follow the steps below on the repository you forked in "[Prerequisit {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} 1. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Enable** for {% data variables.product.prodname_dependabot_alerts %}, {% data variables.product.prodname_dependabot_security_updates %}, and {% data variables.product.prodname_dependabot_version_updates %}. -2. Optionally, if you are interested in experimenting with {% data variables.product.prodname_dependabot_version_updates %}, click **.github/dependabot.yml**. This will create a default _dependabot.yml_ configuration file in the `/.github` directory of your repository. To enable {% data variables.product.prodname_dependabot_version_updates %} for your repository, you typically configure this file to suit your needs by editing the default file, and committing your changes. You can refer to the snippet provided in "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#example-dependabotyml-file)" for an example. +1. Optionally, if you are interested in experimenting with {% data variables.product.prodname_dependabot_version_updates %}, click **.github/dependabot.yml**. This will create a default _dependabot.yml_ configuration file in the `/.github` directory of your repository. To enable {% data variables.product.prodname_dependabot_version_updates %} for your repository, you typically configure this file to suit your needs by editing the default file, and committing your changes. You can refer to the snippet provided in "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#example-dependabotyml-file)" for an example. {% note %} @@ -72,7 +72,7 @@ If {% data variables.product.prodname_dependabot_alerts %} are enabled for a rep You can filter {% data variables.product.prodname_dependabot_alerts %} in the list, using a variety of filters or labels. For more infomation, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#prioritizing-dependabot-alerts)."{% ifversion dependabot-alert-rules-auto-dismissal-npm-dev-dependencies %} You can also use {% data variables.product.prodname_dependabot %} alert rules to filter out false positive alerts or alerts you're not interested in. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/using-alert-rules-to-prioritize-dependabot-alerts)."{% endif %} -2. Click the "Command Injection in lodash" alert on the _javascript/package-lock.json_ file. The details page for the alert will show the following information (note that some information may not apply to all alerts): +1. Click the "Command Injection in lodash" alert on the _javascript/package-lock.json_ file. The details page for the alert will show the following information (note that some information may not apply to all alerts): - Whether {% data variables.product.prodname_dependabot %} created a pull request that will fix the vulnerability. You can review the suggested security update by clicking **Review security update**. - Package involved - Affected versions @@ -81,7 +81,7 @@ If {% data variables.product.prodname_dependabot_alerts %} are enabled for a rep ![Screenshot of the detailed page of an alert in the demo repository, showing the main information.](/assets/images/help/repository/alert-details-page-demo-repo.png) -3. Optionally, you can also explore the information on the right-side of the page. Some of the information shown in the screenshot may not apply to every alert. +1. Optionally, you can also explore the information on the right-side of the page. Some of the information shown in the screenshot may not apply to every alert. - Severity - CVSS metrics—we use CVSS levels to assign severity levels. For more information, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-cvss-levels)." - Tags diff --git a/content/code-security/getting-started/securing-your-organization.md b/content/code-security/getting-started/securing-your-organization.md index f140714cf4f9..f6a859f8e50f 100644 --- a/content/code-security/getting-started/securing-your-organization.md +++ b/content/code-security/getting-started/securing-your-organization.md @@ -41,10 +41,10 @@ You can create a default security policy that will display in any of your organi {% data reusables.dependabot.quickstart-link %} 1. Click your profile photo, then click **Organizations**. -2. Click **Settings** next to your organization. -3. Click **Security & analysis**. -4. Click **Enable all** or **Disable all** next to the feature that you want to manage. -5. Optionally, select **Automatically enable for new repositories**. +1. Click **Settings** next to your organization. +1. Click **Security & analysis**. +1. Click **Enable all** or **Disable all** next to the feature that you want to manage. +1. Optionally, select **Automatically enable for new repositories**. {% endif %} {% data reusables.dependabot.dependabot-alerts-beta %} @@ -71,10 +71,10 @@ Dependency review is an {% data variables.product.prodname_advanced_security %} For any repository that uses {% data variables.product.prodname_dependabot_alerts %}, you can enable {% data variables.product.prodname_dependabot_security_updates %} to raise pull requests with security updates when vulnerabilities are detected. You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories across your organization. 1. Click your profile photo, then click **Organizations**. -2. Click **Settings** next to your organization. -3. Click **Security & analysis**. -4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_dependabot_security_updates %}. -5. Optionally, select **Automatically enable for new repositories**. +1. Click **Settings** next to your organization. +1. Click **Security & analysis**. +1. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_dependabot_security_updates %}. +1. Optionally, select **Automatically enable for new repositories**. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." @@ -97,10 +97,10 @@ You can enable or disable {% data variables.product.prodname_advanced_security % {% endif %} 1. Click your profile photo, then click **Organizations**. -2. Click **Settings** next to your organization. -3. Click **Security & analysis**. -4. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_GH_advanced_security %}. -5. Optionally, select **Automatically enable for new private repositories**. +1. Click **Settings** next to your organization. +1. Click **Security & analysis**. +1. Click **Enable all** or **Disable all** next to {% data variables.product.prodname_GH_advanced_security %}. +1. Optionally, select **Automatically enable for new private repositories**. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." {% endif %} diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md index 99c34a877887..6685202ae4ea 100644 --- a/content/code-security/getting-started/securing-your-repository.md +++ b/content/code-security/getting-started/securing-your-repository.md @@ -145,9 +145,9 @@ Alternatively, you can use the advanced setup, which generates a workflow file y If you are a repository maintainer, it's good practice to specify a security policy for your repository by creating a file named `SECURITY.md` in the repository. This file instructs users about how to best contact you and collaborate with you when they want to report security vulnerabilities in your repository. You can view the security policy of a repository from the repository’s **Security** tab. 1. From the main page of your repository, click **{% octicon "shield" aria-label="The shield symbol" %} Security**. -2. Click **Security policy**. -3. Click **Start setup**. -4. Add information about supported versions of your project and how to report vulnerabilities. +1. Click **Security policy**. +1. Click **Start setup**. +1. Add information about supported versions of your project and how to report vulnerabilities. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository)." diff --git a/content/code-security/secret-scanning/about-secret-scanning.md b/content/code-security/secret-scanning/about-secret-scanning.md index 78407ad34c60..dc26a584c941 100644 --- a/content/code-security/secret-scanning/about-secret-scanning.md +++ b/content/code-security/secret-scanning/about-secret-scanning.md @@ -44,7 +44,7 @@ If your project communicates with an external service, you might use a token or 1. **{% data variables.secret-scanning.partner_alerts_caps %}.** Runs automatically on all public repositories and public npm packages. Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning, hence the term "partners." {% data reusables.secret-scanning.partner-program-link %} Any strings that match patterns that were provided by secret scanning partners are reported directly to the relevant partner. For more information, see the "[About {% data variables.secret-scanning.partner_alerts %}](#about-secret-scanning-alerts-for-partners)" section below. -2. **{% data variables.secret-scanning.user_alerts_caps %}.** {% ifversion fpt %}The following users can enable and configure additional scanning: +1. **{% data variables.secret-scanning.user_alerts_caps %}.** {% ifversion fpt %}The following users can enable and configure additional scanning: - Owners of repositories on {% data variables.product.prodname_dotcom_the_website %}, on any _public_ repositories they own. - Organizations owning _public_ repositories, on any of these repositories. - Organizations using {% data variables.product.prodname_ghe_cloud %}, on any public repositories (for free), and on any private and internal repositories, when you have a license for {% data variables.product.prodname_GH_advanced_security %}.{% elsif ghec %}You can enable and configure additional scanning for repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} for any public repositories (for free), and for private and internal repositorites when you have a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} diff --git a/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md b/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md index bb5b0564e0af..3616a556a241 100644 --- a/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md +++ b/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md @@ -69,9 +69,9 @@ You can use the organization settings page for "Code security and analysis" to e {% ifversion ghae %} 1. Before you can enable {% data variables.product.prodname_secret_scanning %}, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository.](/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png) -2. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action. +1. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action. ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository.](/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png) -3. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. +1. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. ![Enable {% data variables.product.prodname_secret_scanning %} for your repository.](/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png) {% endif %} @@ -98,8 +98,8 @@ You can configure a _secret_scanning.yml_ file to exclude directories from {% da {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type _.github/secret_scanning.yml_. -4. Under **Edit new file**, type `paths-ignore:` followed by the paths you want to exclude from {% data variables.product.prodname_secret_scanning %}. +1. In the file name field, type _.github/secret_scanning.yml_. +1. Under **Edit new file**, type `paths-ignore:` followed by the paths you want to exclude from {% data variables.product.prodname_secret_scanning %}. ``` yaml paths-ignore: - "foo/bar/*.js" diff --git a/content/code-security/secret-scanning/secret-scanning-patterns.md b/content/code-security/secret-scanning/secret-scanning-patterns.md index 90e21fb41b92..95968d46a3b9 100644 --- a/content/code-security/secret-scanning/secret-scanning-patterns.md +++ b/content/code-security/secret-scanning/secret-scanning-patterns.md @@ -25,8 +25,8 @@ redirect_from: {% data variables.product.product_name %} maintains these different sets of default {% data variables.product.prodname_secret_scanning %} patterns: 1. **Partner patterns.** Used to detect potential secrets in all public repositories as well as public npm packages.{% data reusables.secret-scanning.partner-program-link %} -2. **User alert patterns.** Used to detect potential secrets in {% ifversion fpt %}public{% endif %} repositories with {% data variables.secret-scanning.user_alerts %} enabled. {% ifversion secret-scanning-push-protection %} -3. **Push protection patterns.** Used to detect potential secrets in repositories with {% data variables.product.prodname_secret_scanning %} as a push protection enabled.{% endif %} +1. **User alert patterns.** Used to detect potential secrets in {% ifversion fpt %}public{% endif %} repositories with {% data variables.secret-scanning.user_alerts %} enabled. {% ifversion secret-scanning-push-protection %} +1. **Push protection patterns.** Used to detect potential secrets in repositories with {% data variables.product.prodname_secret_scanning %} as a push protection enabled.{% endif %} {% ifversion fpt %} Owners of public repositories, as well as organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %}, can enable {% data variables.secret-scanning.user_alerts %} on their repositories. diff --git a/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md b/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md index 899a28df66ec..5224719f0724 100644 --- a/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database.md @@ -28,13 +28,13 @@ topics: You can access any advisory in the {% data variables.product.prodname_advisory_database %}. 1. Navigate to https://github.com/advisories. -2. Optionally, to filter the list of advisories, use the search field or the drop-down menus at the top of the list. +1. Optionally, to filter the list of advisories, use the search field or the drop-down menus at the top of the list. {% tip %} **Tip:** You can use the sidebar on the left to explore {% data variables.product.company_short %}-reviewed and unreviewed advisories separately, or to filter by ecosystem. {% endtip %} -3. Click an advisory to view details. By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. {% ifversion GH-advisory-db-supports-malware %}To show malware advisories, use `type:malware` in the search bar.{% endif %} +1. Click an advisory to view details. By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. {% ifversion GH-advisory-db-supports-malware %}To show malware advisories, use `type:malware` in the search bar.{% endif %} {% note %} @@ -81,11 +81,11 @@ A `GHSA-ID` qualifier is a unique ID that we at {% data variables.product.prodna For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %}. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts#access-to-dependabot-alerts)." 1. Navigate to https://github.com/advisories. -2. Click an advisory. -3. At the top of the advisory page, click **Dependabot alerts**. +1. Click an advisory. +1. At the top of the advisory page, click **Dependabot alerts**. ![Screenshot of a "global security advisory". The "Dependabot alerts" button is highlighted with an orange outline.](/assets/images/help/security/advisory-database-dependabot-alerts.png) -4. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). -5. For more details about the advisory, and for advice on how to fix the vulnerable repository, click the repository name. +1. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). +1. For more details about the advisory, and for advice on how to fix the vulnerable repository, click the repository name. {% ifversion security-advisories-ghes-ghae %} @@ -96,13 +96,13 @@ If your site administrator has enabled {% data variables.product.prodname_github You can use your local advisory database to check whether a specific security vulnerability is included, and therefore whether you'd get alerts for vulnerable dependencies. You can also view any vulnerable repositories. 1. Navigate to `https://HOSTNAME/advisories`. -2. Optionally, to filter the list, use any of the drop-down menus. +1. Optionally, to filter the list, use any of the drop-down menus. {% note %} **Note:** Only reviewed advisories will be listed. Unreviewed advisories can be viewed in the {% data variables.product.prodname_advisory_database %} on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Accessing an advisory in the GitHub Advisory Database](#accessing-an-advisory-in-the-github-advisory-database)". {% endnote %} -3. Click an advisory to view details.{% ifversion GH-advisory-db-supports-malware %} By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. To show malware advisories, use `type:malware` in the search bar.{% endif %} +1. Click an advisory to view details.{% ifversion GH-advisory-db-supports-malware %} By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. To show malware advisories, use `type:malware` in the search bar.{% endif %} You can also suggest improvements to any advisory directly from your local advisory database. For more information, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database#editing-advisories-from-your-github-enterprise-server-instance)". @@ -113,10 +113,10 @@ You can also suggest improvements to any advisory directly from your local advis In the local advisory database, you can see which repositories are affected by each security vulnerability{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %}. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts#access-to-dependabot-alerts)." 1. Navigate to `https://HOSTNAME/advisories`. -2. Click an advisory. -3. At the top of the advisory page, click **Dependabot alerts**. +1. Click an advisory. +1. At the top of the advisory page, click **Dependabot alerts**. ![Screenshot of a "global security advisory". The "Dependabot alerts" button is highlighted with an orange outline.](/assets/images/help/security/advisory-database-dependabot-alerts.png) -4. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). -5. For more details about the advisory, and for advice on how to fix the vulnerable repository, click the repository name. +1. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user). +1. For more details about the advisory, and for advice on how to fix the vulnerable repository, click the repository name. {% endif %} diff --git a/content/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database.md b/content/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database.md index 0e0de0e90c01..157c9da3a7cf 100644 --- a/content/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database.md @@ -50,7 +50,7 @@ You can also open a pull request directly on an advisory file in the [github/adv If you have {% data variables.product.prodname_github_connect %} enabled for {% data variables.location.product_location %}, you will be able to see advisories by adding `/advisories` to the instance url. 1. Navigate to `https://HOSTNAME/advisories`. -2. Select the security advisory you would like to contribute to. -3. On the right-hand side of the page, click the **Suggest improvements for this vulnerability on {% data variables.product.prodname_dotcom_the_website %}.** link. A new tab opens with the same security advisory on {% data variables.product.prodname_dotcom_the_website %}. -4. Edit the advisory, following steps four through six in "[Editing advisories in the GitHub Advisory Database](#editing-advisories-in-the-github-advisory-database)" above. +1. Select the security advisory you would like to contribute to. +1. On the right-hand side of the page, click the **Suggest improvements for this vulnerability on {% data variables.product.prodname_dotcom_the_website %}.** link. A new tab opens with the same security advisory on {% data variables.product.prodname_dotcom_the_website %}. +1. Edit the advisory, following steps four through six in "[Editing advisories in the GitHub Advisory Database](#editing-advisories-in-the-github-advisory-database)" above. {% endif %} diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md b/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md index 4004afb485a6..b7ae4486fa28 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md +++ b/content/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities.md @@ -33,7 +33,7 @@ For more information about configuring notification preferences, see "[AUTOTITLE ![Screenshot of a "Security Advisories" list.](/assets/images/help/security/advisory-list.png) -2. Carefully review the report, then choose how to proceed. +1. Carefully review the report, then choose how to proceed. - To collaborate on a patch in private, click **Start a temporary private fork** to create a place for further discussions with the contributor. This does not change the status of the proposed advisory from `Triage`. - To accept the reported vulnerability, click **Accept and open as draft** to accept the vulnerability report as a draft advisory on {% data variables.product.prodname_dotcom %}. If you choose this option: - This doesn't make the report public. diff --git a/content/code-security/security-advisories/repository-security-advisories/about-repository-security-advisories.md b/content/code-security/security-advisories/repository-security-advisories/about-repository-security-advisories.md index 3c285dbf4549..fcf30876f522 100644 --- a/content/code-security/security-advisories/repository-security-advisories/about-repository-security-advisories.md +++ b/content/code-security/security-advisories/repository-security-advisories/about-repository-security-advisories.md @@ -31,8 +31,8 @@ topics: With repository security advisories, you can: 1. Create a draft security advisory, and use the draft to privately discuss the impact of the vulnerability on your project. For more information, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory)." -2. Privately collaborate to fix the vulnerability in a temporary private fork. -3. Publish the security advisory to alert your community of the vulnerability once a patch is released. For more information, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory)." +1. Privately collaborate to fix the vulnerability in a temporary private fork. +1. Publish the security advisory to alert your community of the vulnerability once a patch is released. For more information, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory)." {% data reusables.repositories.security-advisories-republishing %} diff --git a/content/code-security/security-advisories/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory.md b/content/code-security/security-advisories/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory.md index 28f48060162c..252060e199bf 100644 --- a/content/code-security/security-advisories/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory.md +++ b/content/code-security/security-advisories/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory.md @@ -35,9 +35,9 @@ Collaborators have write permissions to the security advisory. For more informat {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %} -4. In the "Security Advisories" list, click the security advisory you'd like to add a collaborator to. -5. On the right side of the page, under "Collaborators", type the name of the user or team you'd like to add to the security advisory. -6. Click **{% octicon "plus" aria-label="Add Collaborator" %}** to add the selected user or team as a collaborator. +1. In the "Security Advisories" list, click the security advisory you'd like to add a collaborator to. +1. On the right side of the page, under "Collaborators", type the name of the user or team you'd like to add to the security advisory. +1. Click **{% octicon "plus" aria-label="Add Collaborator" %}** to add the selected user or team as a collaborator. ![Screenshot of the "Collaborators" area in the right sidebar of a draft security advisory. The "Add collaborator" button, a plus icon, is outlined in dark orange.](/assets/images/help/security/security-advisory-add-collaborator-button.png) ## Further reading diff --git a/content/code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability.md b/content/code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability.md index 3ee483622d95..528c22ab59ca 100644 --- a/content/code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability.md +++ b/content/code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability.md @@ -33,8 +33,8 @@ To keep information about vulnerabilities secure, integrations, including CI, ca {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %} -4. In the "Security Advisories" list, click the name of the security advisory you'd like to create a temporary private fork in. -5. Scroll to the bottom of the advisory form and click **Start a temporary private fork**. +1. In the "Security Advisories" list, click the name of the security advisory you'd like to create a temporary private fork in. +1. Scroll to the bottom of the advisory form and click **Start a temporary private fork**. ![Screenshot of the "Collaborate on a patch in private" area of the form. A button, labeled "Start a temporary private fork", is outlined in dark orange.](/assets/images/help/security/new-temporary-private-fork-button.png) @@ -51,8 +51,8 @@ Anyone with write permissions to a security advisory can collaborate on a patch {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %} -4. In the "Security Advisories" list, click the name of the security advisory you'd like to work on. -5. You can make your changes on {% data variables.product.product_name %} or locally: +1. In the "Security Advisories" list, click the name of the security advisory you'd like to work on. +1. You can make your changes on {% data variables.product.product_name %} or locally: - To make your changes on {% data variables.product.product_name %}, under "Collaborate on a patch", click **the temporary private fork**. Then, create a new branch and edit files. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" and "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)." - To add changes locally, follow the instructions under "Clone and create a new branch" and "Make your changes, then push." diff --git a/content/code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory.md b/content/code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory.md index 2bead78975ff..dd3efee60c46 100644 --- a/content/code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory.md +++ b/content/code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory.md @@ -27,8 +27,8 @@ You can also use the REST API to edit repository security advisories. For more i {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %} -4. In the "Security Advisories" list, click the name of the security advisory you'd like to edit. -5. In the upper-right corner of the details for the security advisory, click **Edit advisory**. This will open the security advisory form in edit mode. +1. In the "Security Advisories" list, click the name of the security advisory you'd like to edit. +1. In the upper-right corner of the details for the security advisory, click **Edit advisory**. This will open the security advisory form in edit mode. {% data reusables.repositories.security-advisory-edit-cve %} {% data reusables.repositories.security-advisory-edit-description %} {% data reusables.repositories.security-advisory-edit-details %} diff --git a/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md b/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md index 8d11f679e27e..e89b0472e9fc 100644 --- a/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md +++ b/content/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory.md @@ -72,8 +72,8 @@ Publishing a security advisory deletes the temporary private fork for the securi {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %} -4. In the "Security Advisories" list, click the name of the security advisory you'd like to publish. -5. Scroll to the bottom of the advisory form and click **Publish advisory**. +1. In the "Security Advisories" list, click the name of the security advisory you'd like to publish. +1. Scroll to the bottom of the advisory form and click **Publish advisory**. ![Screenshot of the "Required advisory information has been provided" area of a draft security advisory. The "Publish advisory" button is outlined in dark orange.](/assets/images/help/security/publish-advisory-button.png) @@ -94,8 +94,8 @@ Publishing a security advisory deletes the temporary private fork for the securi {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %} -4. In the "Security Advisories" list, click the name of the security advisory you'd like to request a CVE identification number for. -6. Scroll to the bottom of the advisory form and click **Request CVE**. +1. In the "Security Advisories" list, click the name of the security advisory you'd like to request a CVE identification number for. +1. Scroll to the bottom of the advisory form and click **Request CVE**. ![Screenshot of the "Required advisory information has been provided" area of a draft security advisory. The "Request CVE" button is outlined in dark orange.](/assets/images/help/security/security-advisory-request-cve-button.png) diff --git a/content/code-security/security-advisories/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory.md b/content/code-security/security-advisories/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory.md index 148d51b391dd..bd5e1f3a0561 100644 --- a/content/code-security/security-advisories/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory.md +++ b/content/code-security/security-advisories/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory.md @@ -27,9 +27,9 @@ People with admin permissions to a security advisory can remove collaborators fr {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-advisories %} -4. In the "Security Advisories" list, click the name of the security advisory you'd like to remove a collaborator from. -5. On the right side of the page, under "Collaborators", find the name of the user or team you'd like to remove from the security advisory. -6. Next to the collaborator you want to remove, click **Remove**. +1. In the "Security Advisories" list, click the name of the security advisory you'd like to remove a collaborator from. +1. On the right side of the page, under "Collaborators", find the name of the user or team you'd like to remove from the security advisory. +1. Next to the collaborator you want to remove, click **Remove**. ![Screenshot of the "Collaborators" area in the right sidebar of a draft security advisory. The "Remove username" button is outlined in dark orange.](/assets/images/help/security/security-advisory-remove-collaborator.png) diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md index 26bae36aa711..4aaf7a7264b2 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md @@ -127,8 +127,8 @@ When you set up 2FA, you should always download the recovery codes and set up mo If you're an organization owner, you can see which users don't have 2FA enabled, help them get set up, and then require 2FA for your organization. To guide you through that process, see: 1. "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/viewing-whether-users-in-your-organization-have-2fa-enabled)" -2. "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/preparing-to-require-two-factor-authentication-in-your-organization)" -3. "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization)" +1. "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/preparing-to-require-two-factor-authentication-in-your-organization)" +1. "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization)" {% endif %} diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md index 7114beea3323..e27d734a80e3 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md @@ -30,9 +30,9 @@ There are several security capabilities a build system should have: 1. The build steps should be clear and repeatable. -2. You should know exactly what was running during the build process. +1. You should know exactly what was running during the build process. -3. Each build should start in a fresh environment, so a compromised build doesn't persist to affect future builds. +1. Each build should start in a fresh environment, so a compromised build doesn't persist to affect future builds. {% data variables.product.prodname_actions %} can help you meet these capabilities. Build instructions are stored in your repository, alongside your code. You choose what environment your build runs on, including Windows, Mac, Linux, or runners you host yourself. Each build starts with a fresh runner image, making it difficult for an attack to persist in your build environment. diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md index b2fe8e26ade1..0593b3a9c38a 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md @@ -96,7 +96,7 @@ The "Used by" section represents a single package from the repository. If you ha {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -4. Under "Code security and analysis", click the drop-down menu in the "Used by counter" section and choose a package. +1. Under "Code security and analysis", click the drop-down menu in the "Used by counter" section and choose a package. {% endif %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md index c792bd30cdba..5a5b252b990d 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md @@ -63,7 +63,7 @@ Yes, the dependency graph has {% ifversion dependency-graph-repository-view-upda - vendors/dependency1 - /externals/vendor1/dependency1 {% ifversion ghes < 3.10 or ghae < 3.10 %} -2. **Visualization limits** +1. **Visualization limits** These affect what's displayed in the dependency graph within {% data variables.product.prodname_dotcom %}. However, they don't affect the {% data variables.product.prodname_dependabot_alerts %} that are created. diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md index bed2f262b1a1..4f93e8ef9d15 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md @@ -85,8 +85,8 @@ jobs: Alternatively, you can write your own action to submit dependencies for your project at build-time. Your workflow should: 1. Generate a list of dependencies for your project. - 2. Translate the list of dependencies into the snapshot format accepted by the Dependency submission API. For more information about the format, see the body parameters for the "Create a repository snapshot" API operation in the [Dependency submission REST API documentation](/rest/dependency-graph/dependency-submission). - 3. Submit the formatted list of dependencies to the Dependency submission API. + 1. Translate the list of dependencies into the snapshot format accepted by the Dependency submission API. For more information about the format, see the body parameters for the "Create a repository snapshot" API operation in the [Dependency submission REST API documentation](/rest/dependency-graph/dependency-submission). + 1. Submit the formatted list of dependencies to the Dependency submission API. {% data variables.product.product_name %} maintains the [Dependency Submission Toolkit](https://github.com/github/dependency-submission-toolkit), a TypeScript library to help you build your own GitHub Action for submitting dependencies to the Dependency submission API. For more information about writing an action, see "[AUTOTITLE](/actions/creating-actions)". diff --git a/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md b/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md index ac204363cea4..b50b463330b1 100644 --- a/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md +++ b/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md @@ -151,7 +151,7 @@ You can use your selected dotfiles repository to personalize your {% data variab ![Screenshot of the "Dotfiles" section of the codespace settings, with the "Automatically install dotfiles" option cleared.](/assets/images/help/codespaces/install-custom-dotfiles.png) -2. Use the dropdown to choose the repository you want to install dotfiles from. +1. Use the dropdown to choose the repository you want to install dotfiles from. ![Screenshot of the "Automatically install dotfiles" option selected and "monalisa/dotfiles" selected from a dropdown list of repositories.](/assets/images/help/codespaces/select-dotfiles-repo.png) diff --git a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md b/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md index e193d35ec55e..7ee59d4f053e 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md +++ b/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md @@ -20,4 +20,6 @@ You can manually select the region that your codespaces will be created in, allo {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} 1. Under "Region", select the setting you want: **Set automatically** or **Set manually**. -2. If you chose **Set manually**, select the dropdown menu and click your region. + +1. If you chose **Set manually**, select the dropdown menu and click your region. + diff --git a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md index 58646abb93fc..b15dd6fe3358 100644 --- a/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/developing-in-a-codespace.md @@ -89,14 +89,14 @@ Within the {% data variables.product.prodname_github_codespaces %} documentation The main components of the user interface are: 1. **Navigation bar** - This displays the path to the currently selected file or directory. Use the buttons to the right of the navigation bar to perform various actions, including building, running, or debugging the project, or running Git commands to commit and push your changes. -2. **Project tool window** - This shows you the structure of your project and allows you to open files in the editor. -3. **{% data variables.product.prodname_github_codespaces %} tool window** - This is displayed by clicking the {% data variables.product.prodname_github_codespaces %} plugin in the bar to the left of the tool window. It displays information about your codespace, including its display name and machine type. The buttons at the top of this tool window allow you to: +1. **Project tool window** - This shows you the structure of your project and allows you to open files in the editor. +1. **{% data variables.product.prodname_github_codespaces %} tool window** - This is displayed by clicking the {% data variables.product.prodname_github_codespaces %} plugin in the bar to the left of the tool window. It displays information about your codespace, including its display name and machine type. The buttons at the top of this tool window allow you to: - Refresh the details in the tool window for the active codespace - Display the "Your codespaces" web page - View the codespace creation logs -4. **Editor** - This is where you edit your files. You can right-click the tab for a file to access options such as moving the tab to a new window. -5. **Terminal** - This is displayed by clicking **Terminal** in the tool window bar at the bottom of the main window (just above the status bar). The integrated terminal allows you to perform command-line tasks without having to switch to a dedicated terminal application. -6. **Status bar** - Hover over the icon at the left of the status bar to see a list of tools. Click the icon to hide or show the tool window bars. The right side of the status bar shows information about the project, including the current Git branch. +1. **Editor** - This is where you edit your files. You can right-click the tab for a file to access options such as moving the tab to a new window. +1. **Terminal** - This is displayed by clicking **Terminal** in the tool window bar at the bottom of the main window (just above the status bar). The integrated terminal allows you to perform command-line tasks without having to switch to a dedicated terminal application. +1. **Status bar** - Hover over the icon at the left of the status bar to see a list of tools. Click the icon to hide or show the tool window bars. The right side of the status bar shows information about the project, including the current Git branch. For more information about the IntelliJ IDEA user interface, see the [JetBrains documentation for IntelliJ IDEA](https://www.jetbrains.com/help/idea/guided-tour-around-the-user-interface.html). diff --git a/content/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code.md b/content/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code.md index baec3239cb19..bfb7923ebe91 100644 --- a/content/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code.md +++ b/content/codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code.md @@ -78,11 +78,11 @@ If you are using the {% data variables.product.prodname_vscode_shortname %} web After you switch versions in a codespace, the web client will continue to use the Insiders version if you stop and restart the codespace. New codespaces that you create and open in the {% data variables.product.prodname_vscode_shortname %} web client will also use the Insiders version. 1. In bottom left of the browser window that's displaying a codespace, click **{% octicon "gear" aria-label="Manage" %}**. -2. In the menu, select "Switch to Insiders Version." +1. In the menu, select "Switch to Insiders Version." ![Screenshot of the {% data variables.product.prodname_vscode_shortname %} web client. A gear icon is highlighted with an orange outline. "Switch to Insiders Version" is shown in the menu.](/assets/images/help/codespaces/codespaces-insiders-vscode.png) -3. Click **Reload**. +1. Click **Reload**. To switch back to the Stable version of {% data variables.product.prodname_vscode_shortname %}, repeat the process but choose **Switch to Stable Version**. After you switch back, the codespace will continue to use the Stable version if you stop and restart the codespace. New codespaces that you create and open in the {% data variables.product.prodname_vscode_shortname %} web client will also use the Stable version. diff --git a/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file.md b/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file.md index 99c935accf2d..4d27f6d087a6 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file.md @@ -27,7 +27,7 @@ redirect_from: ![Screenshot of the "Marketplace" tab with "Terra" in the search box and the Terraform feature listed in the search results.](/assets/images/help/codespaces/feature-marketplace.png) -3. Under "Installation," click the code snippet to copy it to your clipboard, then paste the snippet into the `features` object in your `devcontainer.json` file. +1. Under "Installation," click the code snippet to copy it to your clipboard, then paste the snippet into the `features` object in your `devcontainer.json` file. ![Screenshot of the "Marketplace" tab showing the installation code snippet for Terraform.](/assets/images/help/codespaces/feature-installation-code.png) diff --git a/content/codespaces/the-githubdev-web-based-editor.md b/content/codespaces/the-githubdev-web-based-editor.md index 8627bb93d948..18e53043d4d3 100644 --- a/content/codespaces/the-githubdev-web-based-editor.md +++ b/content/codespaces/the-githubdev-web-based-editor.md @@ -107,8 +107,8 @@ Because {% data variables.codespaces.serverless %} uses the GitHub Repositories You can use {% data variables.codespaces.serverless %} to work with an existing pull request. 1. Browse to the pull request you'd like to open in {% data variables.codespaces.serverless %}. -2. Press `.` to open the pull request in {% data variables.codespaces.serverless %}. -3. Once you have made any changes, commit them using the steps in [Commit your changes](#commit-your-changes). Your changes will be committed directly to the branch, it's not necessary to push the changes. +1. Press `.` to open the pull request in {% data variables.codespaces.serverless %}. +1. Once you have made any changes, commit them using the steps in [Commit your changes](#commit-your-changes). Your changes will be committed directly to the branch, it's not necessary to push the changes. ## Using extensions diff --git a/content/codespaces/troubleshooting/github-codespaces-logs.md b/content/codespaces/troubleshooting/github-codespaces-logs.md index 8da1bd815d8e..6faa41abbfad 100644 --- a/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -93,7 +93,7 @@ These logs contain information about the container, dev container, and their con {% webui %} 1. Connect to the codespace you want to debug. -2. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type `creation log`. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type `creation log`. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. diff --git a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index 01aefe3aed49..5c903b072b64 100644 --- a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -34,8 +34,8 @@ For more information about included usage for personal accounts, and setting a s If you create a codespace and it does not open: 1. Try reloading the page in case there was a caching or reporting problem. -2. Go to your {% data variables.product.prodname_github_codespaces %} page: https://github.com/codespaces and check whether the new codespace is listed there. The process may have successfully created the codespace but failed to report back to your browser. If the new codespace is listed, you can open it directly from that page. -3. Retry creating the codespace for the repository to rule out a transient communication failure. +1. Go to your {% data variables.product.prodname_github_codespaces %} page: https://github.com/codespaces and check whether the new codespace is listed there. The process may have successfully created the codespace but failed to report back to your browser. If the new codespace is listed, you can open it directly from that page. +1. Retry creating the codespace for the repository to rule out a transient communication failure. If you still cannot create a codespace for a repository where {% data variables.product.prodname_github_codespaces %} is available, {% data reusables.codespaces.contact-support %} @@ -71,7 +71,7 @@ If you create a codespace and the creation fails: Log messages are printed to the Terminal in {% data variables.product.prodname_vscode_shortname %} {% endnote %} -2. If you have a container that takes a long time to build, consider using prebuilds to speed up codespace creations. For more information, see "[AUTOTITLE](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-prebuilds)." +1. If you have a container that takes a long time to build, consider using prebuilds to speed up codespace creations. For more information, see "[AUTOTITLE](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-prebuilds)." ## Deleting codespaces diff --git a/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md index 977c775e9eec..970de35e81f0 100644 --- a/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md @@ -85,14 +85,14 @@ For example, if the global `.gitconfig` file on your local machine contains a `g {% endnote %} 1. On your local machine, open a terminal. -2. To remove the conflicting value from `~/.gitconfig` (Mac/Linux) or `C:\Users\YOUR-USER\.gitconfig` (Windows), use the `git config --global --unset` command. +1. To remove the conflicting value from `~/.gitconfig` (Mac/Linux) or `C:\Users\YOUR-USER\.gitconfig` (Windows), use the `git config --global --unset` command. ```Shell git config --global --unset gpg.program ``` -3. Push the change to your dotfiles repository on {% data variables.product.prodname_dotcom %}. -4. Optionally, to keep your local configuration, set the value again in a Git configuration file that you do not push to your dotfiles repository. +1. Push the change to your dotfiles repository on {% data variables.product.prodname_dotcom %}. +1. Optionally, to keep your local configuration, set the value again in a Git configuration file that you do not push to your dotfiles repository. For example, you can use the `--system` flag to set the configuration in the system-level file at `PATH/etc/gitconfig`, where `PATH` is the directory in which Git is installed on your system. diff --git a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index c1197669b96c..6734d10b4a8b 100644 --- a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -46,10 +46,10 @@ If you cannot connect to a codespace from {% data variables.product.prodname_vsc 1. Check that you have the latest version of the {% data variables.product.prodname_github_codespaces %} extension installed. The extension is a preview release and frequent updates are released. 1. In {% data variables.product.prodname_vscode %}, display the "Extensions" tab. - 2. Select the {% data variables.product.prodname_github_codespaces %} extension to display the extension's overview page. - 3. If an update is available, a button is shown, click **Update to X.X.X** to upgrade to the latest version. -2. Check whether you are using the stable build of {% data variables.product.prodname_vscode %} or the [{% data variables.product.prodname_vscode %} Insiders](https://code.visualstudio.com/insiders/) release (nightly updates). If you are using the insiders release, try installing the [stable build](https://code.visualstudio.com/). -3. Your company network may be blocking the connection. If possible, check any logging for rejected connections on your device. + 1. Select the {% data variables.product.prodname_github_codespaces %} extension to display the extension's overview page. + 1. If an update is available, a button is shown, click **Update to X.X.X** to upgrade to the latest version. +1. Check whether you are using the stable build of {% data variables.product.prodname_vscode %} or the [{% data variables.product.prodname_vscode %} Insiders](https://code.visualstudio.com/insiders/) release (nightly updates). If you are using the insiders release, try installing the [stable build](https://code.visualstudio.com/). +1. Your company network may be blocking the connection. If possible, check any logging for rejected connections on your device. If you still cannot connect, {% data reusables.codespaces.contact-support %} diff --git a/content/communities/maintaining-your-safety-on-github/viewing-users-who-are-blocked-from-your-organization.md b/content/communities/maintaining-your-safety-on-github/viewing-users-who-are-blocked-from-your-organization.md index 129d173f154d..2771e6d547bd 100644 --- a/content/communities/maintaining-your-safety-on-github/viewing-users-who-are-blocked-from-your-organization.md +++ b/content/communities/maintaining-your-safety-on-github/viewing-users-who-are-blocked-from-your-organization.md @@ -16,7 +16,7 @@ shortTitle: View blocked users in org {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.block_users %} -5. Under "Blocked users", review the list of users who are blocked from your organization. +1. Under "Blocked users", review the list of users who are blocked from your organization. ## Further reading diff --git a/content/communities/maintaining-your-safety-on-github/viewing-users-youve-blocked-from-your-personal-account.md b/content/communities/maintaining-your-safety-on-github/viewing-users-youve-blocked-from-your-personal-account.md index f81b34516fc5..e0b102bad6c3 100644 --- a/content/communities/maintaining-your-safety-on-github/viewing-users-youve-blocked-from-your-personal-account.md +++ b/content/communities/maintaining-your-safety-on-github/viewing-users-youve-blocked-from-your-personal-account.md @@ -15,7 +15,7 @@ shortTitle: View blocked users in account {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.blocked_users %} -3. Under "Blocked users", review the list of users you've blocked from your account. +1. Under "Blocked users", review the list of users you've blocked from your account. ## Further reading diff --git a/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md b/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md index 9f96df42c3f1..767c87f41f9d 100644 --- a/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md +++ b/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md @@ -25,11 +25,11 @@ If a comment is off-topic, outdated, or resolved, you may want to hide a comment ![Screenshot of a hidden comment. The only visible content is "This comment has been minimized", with a button to show the comment.](/assets/images/help/repository/hidden-comment.png) 1. Navigate to the comment you'd like to hide. -2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Hide**. +1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Hide**. ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Hide" is outlined in orange.](/assets/images/help/repository/comment-menu-hide.png) -3. Using the "Choose a reason" dropdown menu, choose a reason to hide the comment. Then select **Hide comment**. +1. Using the "Choose a reason" dropdown menu, choose a reason to hide the comment. Then select **Hide comment**. {% ifversion fpt or ghec %} ![Screenshot of a {% data variables.product.prodname_dotcom %} comment showing a menu to select a reason to hide the comment: Spam, Abuse, Off Topic, Outdated, Duplicate, or Resolved.](/assets/images/help/repository/choose-reason-for-hiding-comment.png) {% else %} @@ -92,9 +92,9 @@ Deleting a comment creates a timeline event that is visible to anyone with read ### Steps to delete a comment 1. Navigate to the comment you'd like to delete. -2. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Delete**. +1. In the upper-right corner of the comment, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Delete**. ![Screenshot of a pull request comment by octo-user. Below an icon of three horizontal dots, a dropdown menu is expanded, and "Delete" is outlined in orange.](/assets/images/help/repository/comment-menu-delete.png) -3. Optionally, write a comment noting that you deleted a comment and why. +1. Optionally, write a comment noting that you deleted a comment and why. {% ifversion fpt or ghec %} diff --git a/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md b/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md index 4126a5cbd8d7..c591d08a387a 100644 --- a/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md +++ b/content/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment.md @@ -29,10 +29,10 @@ When you delete sensitive information from the comment's edit history, the perso 1. Navigate to the comment where you would like to delete sensitive information from the edit history. {% data reusables.repositories.edited-comment-list %} -3. In the top right of the edit history window, click **Options**. Then click **Delete revision from history** to delete the diff that shows the content being added. +1. In the top right of the edit history window, click **Options**. Then click **Delete revision from history** to delete the diff that shows the content being added. ![Screenshot of the edit history window for a comment. A dropdown menu, labeled "Options," is expanded, and the "Delete revision from history" option is outlined in orange.](/assets/images/help/repository/delete-comment-edit-details.png) -4. To confirm deletion, click **OK**. +1. To confirm deletion, click **OK**. ## Further reading diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md b/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md index b362e90c7e71..95639f0e9572 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md @@ -15,7 +15,7 @@ shortTitle: Access community profiles {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Community Standards** to show the checklist for the community profile of the repository. +1. In the left sidebar, click **Community Standards** to show the checklist for the community profile of the repository. ## Further reading diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md index 51036de8a5b0..87e4c933babf 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md @@ -29,13 +29,13 @@ You can create a default code of conduct for your organization or personal accou {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type _CODE_OF_CONDUCT.md_. -4. Select **Choose a code of conduct template**. +1. In the file name field, type _CODE_OF_CONDUCT.md_. +1. Select **Choose a code of conduct template**. ![Screenshot of a {% data variables.product.prodname_dotcom %} repository showing a new markdown file being created. A button at right, labeled "Choose a code of conduct template," is outlined in dark orange.](/assets/images/help/repository/code-of-conduct-tool.png) -5. On the left side of the page, select a code of conduct to preview and add to your project. -6. On the right side of the page, complete the fields to populate the selected code of conduct with the appropriate information. -7. Click **Review and submit**. -8. Review the contents of the code of conduct that's in the text area. +1. On the left side of the page, select a code of conduct to preview and add to your project. +1. On the right side of the page, complete the fields to populate the selected code of conduct with the appropriate information. +1. Click **Review and submit**. +1. Review the contents of the code of conduct that's in the text area. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} @@ -46,11 +46,11 @@ If the code of conduct you want to use isn't available in the provided templates {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type the name and extension for the file. +1. In the file name field, type the name and extension for the file. - To make your code of conduct visible in the repository's root directory, type _CODE_OF_CONDUCT_ in the file name field. - To make your code of conduct visible in the repository's `docs` directory, type _docs/CODE_OF_CONDUCT_. - To make your code of conduct visible in the repository's `.github` directory, type _.github/CODE_OF_CONDUCT_. -4. In the new file, add your custom code of conduct. +1. In the new file, add your custom code of conduct. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md index 0a8dd90ce670..ee4ae02a12da 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md @@ -42,11 +42,11 @@ Open source licenses enable others to freely use, change, and distribute the pro {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type _LICENSE_ or _LICENSE.md_ (with all caps). -4. On the **Edit new file** tab, paste the full text of the license you want to use. +1. In the file name field, type _LICENSE_ or _LICENSE.md_ (with all caps). +1. On the **Edit new file** tab, paste the full text of the license you want to use. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} -7. Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is `main`, you should choose to create a new branch for your commit and then create a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)". +1. Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is `main`, you should choose to create a new branch for your commit and then create a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)". ![Screenshot of a {% data variables.product.prodname_dotcom %} pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.](/assets/images/help/repository/choose-commit-branch.png) {% data reusables.files.propose_file_change %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md index fdd357714069..6e9e583977a9 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md @@ -34,9 +34,9 @@ You can create default support resources for your organization or personal accou {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type _SUPPORT.md_ (with all caps). -4. On the **Edit new file** tab, add information about how people can get support for your project. -5. To review your SUPPORT file, click **Preview**. +1. In the file name field, type _SUPPORT.md_ (with all caps). +1. On the **Edit new file** tab, add information about how people can get support for your project. +1. To review your SUPPORT file, click **Preview**. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index b7b5e601d7a5..84668da0f602 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -51,7 +51,7 @@ You cannot create a default license file. License files must be added to individ ![Screenshot of the owner menu for a new {% data variables.product.prodname_dotcom %} repository. The menu shows two options, octocat and github.](/assets/images/help/repository/create-repository-owner.png) 1. In the "Repository name" field, type **.github**. 1. Optionally, in the "Description" field, type a description. -2. Make sure the repository status is set to **Public**. A repository for default files cannot be private. +1. Make sure the repository status is set to **Public**. A repository for default files cannot be private. {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} 1. In the repository, create one of the supported community health files. Issue templates{% ifversion fpt or ghes or ghec %} and their configuration file{% endif %} must be in a folder called `.github/ISSUE_TEMPLATE`. All other supported files may be in the root of the repository, the `.github` folder, or the `docs` folder. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index 03c77d003b32..e98086b44eea 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -40,11 +40,11 @@ You can create default contribution guidelines for your organization{% ifversion {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." +1. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." - To make your contributing guidelines visible in the repository's root directory, type _CONTRIBUTING_. - To make your contributing guidelines visible in the repository's `docs` directory, type _docs/_ to create the new directory, then _CONTRIBUTING_. - If a repository contains more than one _CONTRIBUTING_ file, then the file shown in links is chosen from locations in the following order: the `.github` directory, then the repository's root directory, and finally the `docs` directory. -4. In the new file, add contribution guidelines. These could include: +1. In the new file, add contribution guidelines. These could include: - Steps for creating good issues or pull requests. - Links to external documentation, mailing lists, or a code of conduct. - Community and behavioral expectations. diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md index c9f08dcdd049..aa3ab4d1d2c7 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md @@ -59,8 +59,8 @@ Here is the rendered version of the issue form. 1. Choose a repository where you want to create an issue form. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)." 1. In your repository, create a file called `.github/ISSUE_TEMPLATE/FORM-NAME.yml`, replacing `FORM-NAME` with the name for your issue form. For more information about creating new files on GitHub, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." -3. In the body of the new file, type the contents of your issue form. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)." -4. Commit your file to the default branch of your repository. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." +1. In the body of the new file, type the contents of your issue form. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)." +1. Commit your file to the default branch of your repository. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." {% endif %} diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md index 389e3919ec25..33147ca64761 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md @@ -55,12 +55,12 @@ assignees: octocat {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field: +1. In the file name field: - To make your issue template visible in the repository's root directory, type the name of your _issue_template_. For example, `issue_template.md`. - To make your issue template visible in the repository's `docs` directory, type _docs/_ followed by the name of your _issue_template_. For example, `docs/issue_template.md`, - To store your file in a hidden directory, type _.github/_ followed by the name of your _issue_template_. For example, `.github/issue_template.md`. - To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type _.github/ISSUE_TEMPLATE/_, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." -4. In the body of the new file, add your issue template. This could include: +1. In the body of the new file, add your issue template. This could include: - YAML frontmatter - Expected behavior and actual behavior - Steps to reproduce the problem diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md index 3be257f3072f..1b35d6bdcb0b 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms.md @@ -84,9 +84,9 @@ Note: Please search to see if an issue already exists for the bug you encountere {% raw %}<{% endraw %}!-- Example: steps to reproduce the behavior: 1. In this environment... -2. With this config... -3. Run '...' -4. See error... +1. With this config... +1. Run '...' +1. See error... --{% raw %}>{% endraw %} ### Environment: @@ -136,9 +136,9 @@ body: description: Steps to reproduce the behavior. placeholder: | 1. In this environment... - 2. With this config... - 3. Run '...' - 4. See error... + 1. With this config... + 1. Run '...' + 1. See error... validations: required: false - type: textarea diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md index fc02eb06a3bc..fcdbf73f90d0 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md @@ -81,7 +81,7 @@ Alternatively, you can open the log folder for {% data variables.product.prodnam - Use: Shift+Command+P - For Windows or Linux: - Use: Ctrl+Shift+P -2. Type "Logs", and then select **Developer: Open Extension Logs Folder** from the list. +1. Type "Logs", and then select **Developer: Open Extension Logs Folder** from the list. ## Viewing network connectivity diagnostics logs diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md index 34b601fb8e87..aea9ffc5131e 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/adding-a-repository-from-your-local-computer-to-github-desktop.md @@ -18,9 +18,9 @@ shortTitle: Add a repository 1. In the menu bar, select **File**, then click **Add Local Repository**. ![Screenshot of the menu bar on a Mac. The "File" dropdown menu is open, and an option labeled "Add Local Repository" is highlighted with an orange outline.](/assets/images/help/desktop/add-local-repository-mac.png) -2. In the "Add Local Repository" window, click **Choose...**, then use the Finder window to navigate to the local repository you want to add. +1. In the "Add Local Repository" window, click **Choose...**, then use the Finder window to navigate to the local repository you want to add. ![Screenshot of the "Add Local Repository" window. Next to the "repository path" field, a button, labeled "Choose", is highlighted with an orange outline.](/assets/images/help/desktop/add-repo-choose-button-mac.png) -3. When you have chosen the local repository, in the "Add Local Repository" window, click **Add Repository**. +1. When you have chosen the local repository, in the "Add Local Repository" window, click **Add Repository**. {% endmac %} @@ -28,8 +28,8 @@ shortTitle: Add a repository 1. In the menu bar, select **File**, then click **Add local repository**. ![Screenshot of the menu bar on Windows. The "File" dropdown menu is open, and an option labeled "Add local repository" is highlighted with an orange outline.](/assets/images/help/desktop/add-local-repository-windows.png) -2. In the "Add local repository" window, click **Choose...**, then use Windows Explorer to navigate to the local repository you want to add. +1. In the "Add local repository" window, click **Choose...**, then use Windows Explorer to navigate to the local repository you want to add. ![Screenshot of the "Add local repository" window. Next to the "repository path" field, a button, labeled "Choose", is highlighted with an orange outline.](/assets/images/help/desktop/add-repo-choose-button-mac.png) -4. Click **Add repository**. +1. Click **Add repository**. {% endwindows %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md index 0563dbc3fb77..4c6910eca21b 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop.md @@ -47,9 +47,9 @@ You can change how a fork behaves with the upstream repository in {% data variab You can create an alias for a local repository to help differentiate between repositories of the same name in {% data variables.product.prodname_desktop %}. Creating an alias does not affect the repository's name on {% data variables.product.prodname_dotcom %}. In the repositories list, aliases appear in italics. 1. In the upper-left corner of {% data variables.product.prodname_desktop %}, to the right of the current repository name, click {% octicon "triangle-down" aria-label="The triangle-down icon" %}. -2. Right-click the repository you want to create an alias for, then click **Create Alias**. -3. Type an alias for the repository. -4. Click **Create Alias**. +1. Right-click the repository you want to create an alias for, then click **Create Alias**. +1. Type an alias for the repository. +1. Click **Create Alias**. ## Further reading diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch-in-github-desktop.md index e1b12405f9d0..2a3444c8d15b 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch-in-github-desktop.md @@ -22,11 +22,11 @@ Some workflows require or benefit from rebasing instead of merging. By rebasing ## Pulling to your local branch from the remote 1. In {% data variables.product.prodname_desktop %}, use the {% octicon "git-branch" aria-hidden="true" %} **Current Branch** drop-down, and select the local branch you want to update. -2. To check for commits on the remote branch, click **Fetch origin** +1. To check for commits on the remote branch, click **Fetch origin** ![Screenshot of the repository bar. The "Fetch origin" button, displayed with an icon of two arrows forming a circle, is outlined in orange.](/assets/images/help/desktop/fetch-button.png) -3. To pull any commits from the remote branch, click **Pull origin** or **Pull origin with rebase**. +1. To pull any commits from the remote branch, click **Pull origin** or **Pull origin with rebase**. ![Screenshot of the repository bar. The "Pull origin" button, displayed with an icon of a downward-facing arrow, is outlined in orange.](/assets/images/help/desktop/pull-button.png) @@ -61,10 +61,10 @@ Some workflows require or benefit from rebasing instead of merging. By rebasing {% endwindows %} -2. Click the branch you want to rebase into the current branch, then click **Rebase**. -3. If you're sure you want to rebase, click **Begin Rebase**. +1. Click the branch you want to rebase into the current branch, then click **Rebase**. +1. If you're sure you want to rebase, click **Begin Rebase**. {% data reusables.desktop.resolve-merge-conflicts %} -4. To push your local changes, click **Force push origin**. +1. To push your local changes, click **Force push origin**. ![Screenshot of the repository bar. A button, labeled "Force push origin" and displayed with an icon of a double upward arrow, is outlined in orange.](/assets/images/help/desktop/force-push-origin.png) @@ -84,7 +84,7 @@ Some workflows require or benefit from rebasing instead of merging. By rebasing {% endwindows %} -2. In the "Squash and merge" window, click the branch you want to merge into the current branch, then click **Squash and merge**. +1. In the "Squash and merge" window, click the branch you want to merge into the current branch, then click **Squash and merge**. {% note %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md index 0e78dfd5d99a..890d094b47cb 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md @@ -110,14 +110,14 @@ Once you're satisfied with the changes you've chosen to include in your commit, ![Screenshot of the "Changes" tab. In the corner of the "Description" field, a "person with a plus sign" icon for adding a co-author is outlined in orange.](/assets/images/help/desktop/add-co-author-commit.png) {% data reusables.desktop.commit-button %} -4. If the branch you're trying to commit to is protected, Desktop will warn you. +1. If the branch you're trying to commit to is protected, Desktop will warn you. - To move your changes, click **switch branches**. - To commit your changes to the protected branch, click **Commit to BRANCH**. For more information about protected branches, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." {% data reusables.desktop.push-origin %} -6. If you have a pull request based off the branch you are working on, {% data variables.product.prodname_desktop %} will display the status of the checks that have run for the pull request next to the "Current Branch" section of the repository bar. For more information about checks, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)." +1. If you have a pull request based off the branch you are working on, {% data variables.product.prodname_desktop %} will display the status of the checks that have run for the pull request next to the "Current Branch" section of the repository bar. For more information about checks, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)." If a pull request has not been created for the current branch, {% data variables.product.prodname_desktop %} will give you the option to preview the changes and create one. For more information, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop)." diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md index ddf75bf289b1..0aebffee0d1d 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches-in-github-desktop.md @@ -46,7 +46,7 @@ You can always create a branch in {% data variables.product.prodname_desktop %} ## Creating a branch from a previous commit {% data reusables.desktop.history-tab %} -2. Right-click on the commit you would like to create a new branch from and select **Create Branch from Commit**. +1. Right-click on the commit you would like to create a new branch from and select **Create Branch from Commit**. ![Screenshot of a list of commits in the "History" tab. Next to a commit, in a context menu, the cursor hovers over the "Create Branch from Commit" option.](/assets/images/help/desktop/create-branch-from-commit-context-menu.png) @@ -59,7 +59,7 @@ If you create a branch on {% data variables.product.product_name %}, you'll need 1. In the repository bar, click {% octicon "git-branch" aria-hidden="true" %} **Current Branch**, then click the branch that you want to publish. ![Screenshot of the "Current Branch" dropdown view. Under "Recent Branches", a branch, named "my-feature", is highlighted with an orange outline.](/assets/images/help/desktop/select-branch-from-dropdown.png) -2. Click **Publish branch**. +1. Click **Publish branch**. ![Screenshot of the repository bar. On the right-hand side, a button, labeled "Publish branch", is highlighted with an orange outline.](/assets/images/help/desktop/publish-branch-button.png) ## Switching between branches diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md index 5f4d0df68725..d6bf03de6291 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop.md @@ -33,7 +33,7 @@ Each commit shows: ![Screenshot of a list of commits in the "History" tab. Three consecutive selected commits are highlighted in blue and outlined in orange.](/assets/images/help/desktop/branch-history-commit.png) -2. If there are multiple files in the commit or range of commits, click on an individual file to see the changes made to that file. +1. If there are multiple files in the commit or range of commits, click on an individual file to see the changes made to that file. ![Screenshot of a commit view. To the right of the "History" tab, in a list of files, the "hello.txt" file is selected and highlighted with an orange outline.](/assets/images/help/desktop/branch-history-file.png) diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md index 7d107e50c7a6..f904bd641908 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/cherry-picking-a-commit-in-github-desktop.md @@ -17,12 +17,12 @@ You can also use cherry-picking when collaborating with a team. Some projects in ## Cherry-picking a commit {% data reusables.desktop.current-branch-menu %} -2. In the list of branches, click the branch that has the commit that you want to cherry-pick. +1. In the list of branches, click the branch that has the commit that you want to cherry-pick. ![Screenshot of the "Current Branch" dropdown view. Under "Recent Branches", a branch, named "my-feature", is highlighted with an orange outline.](/assets/images/help/desktop/select-branch-from-dropdown.png) {% data reusables.desktop.history-tab %} -4. Drag the commit that you want to cherry-pick from the "History" tab to the {% octicon "git-branch" aria-hidden="true" %} **Current Branch** dropdown menu, then drop the commit on the branch that you want to copy the commit to. +1. Drag the commit that you want to cherry-pick from the "History" tab to the {% octicon "git-branch" aria-hidden="true" %} **Current Branch** dropdown menu, then drop the commit on the branch that you want to copy the commit to. ![Screenshot of the "History" tab and the "Current Branch" dropdown view. The cursor hovers over the "my-feature" branch, and "plus one" icons indicate the addition of one commit.](/assets/images/help/desktop/cherry-picking.png) diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/managing-tags-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/managing-tags-in-github-desktop.md index ccca94e447ec..eb0ae3188837 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/managing-tags-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/managing-tags-in-github-desktop.md @@ -25,7 +25,7 @@ versions: ## Viewing tags {% data reusables.desktop.history-tab %} -2. Click the commit. +1. Click the commit. {% note %} **Note**: {% data variables.product.prodname_desktop %} displays an arrow {% octicon "arrow-up" aria-label="The up arrow icon" %} if the tag has not been pushed to the remote repository. @@ -34,7 +34,7 @@ versions: ![Screenshot of a list of commits in the "History" tab. Next to a commit, a "hello-tag" label and an "up arrow" icon are outlined in orange.](/assets/images/help/desktop/viewing-tags-in-history.png) -3. All tags associated with the commit are visible in that commit's metadata. +1. All tags associated with the commit are visible in that commit's metadata. ![Screenshot of the detailed view of a commit. Above the commit's diff, in the commit's metadata, a tag icon and the label "hello-tag" are outlined in orange.](/assets/images/help/desktop/viewing-tags-in-commit.png) diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reordering-commits-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reordering-commits-in-github-desktop.md index 33dfbb0c9369..44cf4e32d0dc 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reordering-commits-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reordering-commits-in-github-desktop.md @@ -15,12 +15,12 @@ Reordering allows you to alter your commit history to provide a more meaningful ## Reordering a commit {% data reusables.desktop.current-branch-menu %} -2. In the list of branches, click the branch with the commits that you want to reorder. +1. In the list of branches, click the branch with the commits that you want to reorder. ![Screenshot of the "Current Branch" dropdown view. Under "Recent Branches", a branch, named "my-feature", is highlighted with an orange outline.](/assets/images/help/desktop/select-branch-from-dropdown.png) {% data reusables.desktop.history-tab %} -4. Drag the commit that you want to reorder and drop it between two adjoining commits. +1. Drag the commit that you want to reorder and drop it between two adjoining commits. ![Screenshot of a list of commits in the "History" tab. The cursor hovers over a narrow horizontal line between two commits, with a "one" icon indicating one commit is being moved.](/assets/images/help/desktop/reorder-drag-and-drop.png) @@ -38,4 +38,5 @@ When you reorder commits, you may see one of the following notifications or erro ![Screenshot of a notification about conflicts. At the end of the message, a link, labeled "View commits", is highlighted with an orange outline.](/assets/images/help/desktop/reorder-resolve-conflicts.png) {% data reusables.desktop.resolve-merge-conflicts %} - 3. When all conflicts are resolved, you can reorder your commits. + + 1. When all conflicts are resolved, you can reorder your commits. diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/squashing-commits-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/squashing-commits-in-github-desktop.md index 6985a05ab92f..99a678ccf17b 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/squashing-commits-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/squashing-commits-in-github-desktop.md @@ -15,9 +15,9 @@ Squashing allows you to combine multiple commits in your branch's history into a ## Squashing a commit {% data reusables.desktop.current-branch-menu %} -2. In the list of branches, select the branch that has the commits that you want to squash. +1. In the list of branches, select the branch that has the commits that you want to squash. {% data reusables.desktop.history-tab %} -4. Select the commits to squash and drop them on the commit you want to combine them with. +1. Select the commits to squash and drop them on the commit you want to combine them with. {% mac %} @@ -33,8 +33,8 @@ Squashing allows you to combine multiple commits in your branch's history into a ![Screenshot of a list of commits in the "History" tab. The cursor hovers over a commit, highlighted in blue. A hover-over text box says, "Squash 2 commits".](/assets/images/help/desktop/squash-drag-and-drop.png) -5. Modify the commit message of your new commit. The commit messages of the selected commits you want to squash are pre-filled into the **Summary** and **Description** fields. -6. Click **Squash Commits**. +1. Modify the commit message of your new commit. The commit messages of the selected commits you want to squash are pre-filled into the **Summary** and **Description** fields. +1. Click **Squash Commits**. ## Error messages when squashing commits diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/changing-the-remote-url-for-a-repository-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/changing-the-remote-url-for-a-repository-in-github-desktop.md index f84f449516a9..24ff03cc3666 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/changing-the-remote-url-for-a-repository-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/changing-the-remote-url-for-a-repository-in-github-desktop.md @@ -22,7 +22,7 @@ shortTitle: Change the remote URL for a repository {% windows %} {% data reusables.desktop.windows-repository-settings-menu %} -2. On the **Remote** pane, under "Primary remote repository", type the desired URL. +1. On the **Remote** pane, under "Primary remote repository", type the desired URL. {% data reusables.desktop.repository-settings-save %} {% endwindows %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md index a9e31b92ce6b..5b9f55e227d4 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md @@ -33,9 +33,9 @@ If system notifications are disabled for {% data variables.product.prodname_desk {% mac %} 1. In the menu bar, select the Apple icon, then click **System Preferences**. -2. Select **Notifications & Focus**. -3. Select **{% data variables.product.prodname_desktop %}** from the list of applications. -4. Click **Allow Notifications**. +1. Select **Notifications & Focus**. +1. Select **{% data variables.product.prodname_desktop %}** from the list of applications. +1. Click **Allow Notifications**. For more information about macOS system notifications, see "[Use notifications on your Mac](https://support.apple.com/en-us/HT204079)." @@ -44,8 +44,8 @@ For more information about macOS system notifications, see "[Use notifications o {% windows %} 1. Open the **Start** menu, then select **Settings**. -2. Select **System**, then click **Notifications**. -3. Find **{% data variables.product.prodname_desktop %}** in the application list and click **On**. +1. Select **System**, then click **Notifications**. +1. Find **{% data variables.product.prodname_desktop %}** in the application list and click **On**. For more information about Windows system notifications, see "[Change notification settings in Windows](https://support.microsoft.com/en-us/windows/change-notification-settings-in-windows-8942c744-6198-fe56-4639-34320cf9444e)." diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md index 442549301f69..136a81dfefe0 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop.md @@ -40,7 +40,7 @@ Before you create a pull request, you'll need to push changes to a branch on {% {% endwindows %} -2. On {% data variables.product.prodname_dotcom %}, click **Get started** to open an issue template or click **Open a blank issue**. +1. On {% data variables.product.prodname_dotcom %}, click **Get started** to open an issue template or click **Open a blank issue**. {% note %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md index 63d069f7bc27..a2866403a1ad 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md @@ -37,8 +37,8 @@ You cannot comment on a pull request from {% data variables.product.prodname_des ## Opening a pull request branch in {% data variables.product.prodname_desktop %} from {% data variables.product.prodname_dotcom %} {% data reusables.repositories.sidebar-pr %} -2. In the list of pull requests, click the pull request that you would like to open in {% data variables.product.prodname_desktop %}. -3. To the right of the title of the pull request, click **{% octicon "code" aria-label="" %} Code**, then, on the **Local** tab, click **Checkout with GitHub Desktop**. +1. In the list of pull requests, click the pull request that you would like to open in {% data variables.product.prodname_desktop %}. +1. To the right of the title of the pull request, click **{% octicon "code" aria-label="" %} Code**, then, on the **Local** tab, click **Checkout with GitHub Desktop**. ![Screenshot of a pull request on GitHub. The "Code" dropdown menu is expanded, and a button, labeled "Checkout with GitHub Desktop" is outlined in orange.](/assets/images/help/desktop/open-pr-in-desktop-button.png) diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md index 876cf1819a1c..38cfddce448e 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md @@ -16,13 +16,13 @@ versions: {% data reusables.desktop.current-branch-menu %} {% data reusables.desktop.click-pull-requests %} {% data reusables.desktop.choose-pr-from-list %} -4. Click on the pull request number, to the right of the pull request branch name. +1. Click on the pull request number, to the right of the pull request branch name. ![Screenshot of the repository bar. Next to the "Current Branch" button, a numbered label, displayed with a red cross for failing checks, is outlined in orange.](/assets/images/help/desktop/checks-dialog.png) -5. To re-run failed checks, click **{% octicon "sync" aria-hidden="true" %} Re-run** and select **Re-run Failed Checks**. +1. To re-run failed checks, click **{% octicon "sync" aria-hidden="true" %} Re-run** and select **Re-run Failed Checks**. ![Screenshot of a dropdown view from a pull request label. Next to the message "Some checks were not successful", a button labeled "Re-run" is outlined in orange.](/assets/images/help/desktop/re-run-failed-checks.png) -6. To re-run individual checks, hover over the individual check you want to re-run and select the {% octicon "sync" aria-label="The sync icon" %} icon to re-run the check. +1. To re-run individual checks, hover over the individual check you want to re-run and select the {% octicon "sync" aria-label="The sync icon" %} icon to re-run the check. ![Screenshot of a dropdown view from a pull request label. The cursor hovers over a check, and an icon of two arrows forming a circle is outlined in orange.](/assets/images/help/desktop/re-run-individual-checks.png) -7. You will see a confirmation dialog with the summary of the checks that will be re-run. Click **Re-run Checks** to confirm that you want to perform the re-run. +1. You will see a confirmation dialog with the summary of the checks that will be re-run. Click **Re-run Checks** to confirm that you want to perform the re-run. diff --git a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md index 260a70bca598..f6181ac36889 100644 --- a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md @@ -78,19 +78,19 @@ shortTitle: Configure default editor {% mac %} {% data reusables.desktop.mac-select-desktop-menu %} -3. In the Preferences window, select **Integrations**. +1. In the Preferences window, select **Integrations**. ![Screenshot of the "Preferences" window. In the left sidebar, the "Integrations" option is highlighted in blue and outlined in orange.](/assets/images/help/desktop/mac-select-integrations-pane.png) -4. Under "External Editor", use the dropdown menu to select the editor you want to set as your default. -5. Click **Save**. +1. Under "External Editor", use the dropdown menu to select the editor you want to set as your default. +1. Click **Save**. {% endmac %} {% windows %} {% data reusables.desktop.windows-choose-options %} -3. In the Options window, select **Integrations**. +1. In the Options window, select **Integrations**. ![Screenshot of the "Options" window. In the left sidebar, the "Integrations" option is highlighted in blue and outlined in orange.](/assets/images/help/desktop/windows-select-integrations-pane.png) -4. Under "External Editor", use the dropdown menu to select the editor you want to set as your default. -5. Click **Save**. +1. Under "External Editor", use the dropdown menu to select the editor you want to set as your default. +1. Click **Save**. {% endwindows %} diff --git a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md index fe737779e94a..6da1d5acad49 100644 --- a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-basic-settings-in-github-desktop.md @@ -23,7 +23,7 @@ shortTitle: Configure basic settings {% windows %} {% data reusables.desktop.windows-choose-options %} -3. To view or change your settings, toggle between the panes in the "Options" window. +1. To view or change your settings, toggle between the panes in the "Options" window. ![Screenshot of the "Options" window. The left sidebar, with menu options such as "Accounts" and "Integrations", is highlighted with an orange outline.](/assets/images/help/desktop/window-select-options-pane.png) diff --git a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md index 6bbfde1e00e7..0bfeeedaa4f7 100644 --- a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md @@ -60,7 +60,7 @@ Before you authenticate, {% data reusables.desktop.get-an-account %} {% data reusables.desktop.authenticate-in-browser %} {% data reusables.desktop.2fa-in-browser %} -7. After {% data variables.product.prodname_dotcom %} authenticates your account, follow the prompts to return to {% data variables.product.prodname_desktop %}. +1. After {% data variables.product.prodname_dotcom %} authenticates your account, follow the prompts to return to {% data variables.product.prodname_desktop %}. ## Authenticating an account on {% data variables.product.prodname_enterprise %} @@ -69,7 +69,7 @@ Before you authenticate, {% data reusables.desktop.get-an-account %} ![Screenshot of the "Accounts" pane in the "Options" window. Next to "GitHub Enterprise", a button, labeled "Sign In", is outlined in orange.](/assets/images/help/desktop/windows-sign-in-ghes.png) -4. To add a {% data variables.product.prodname_enterprise %} account, type your credentials under "Enterprise address," then click **Continue**. +1. To add a {% data variables.product.prodname_enterprise %} account, type your credentials under "Enterprise address," then click **Continue**. {% data reusables.desktop.retrieve-2fa %} {% endwindows %} @@ -88,7 +88,7 @@ For some errors, {% data variables.product.prodname_desktop %} will prompt you w ![Screenshot of the "GitHub Desktop" menu bar on a Mac. Under the expanded "Help" dropdown menu, a cursor hovers over "Show Logs in Finder", highlighted in blue.](/assets/images/help/desktop/mac-show-logs.png) -2. Select the log file from the date when you encountered the authentication error. +1. Select the log file from the date when you encountered the authentication error. {% endmac %} @@ -98,7 +98,7 @@ For some errors, {% data variables.product.prodname_desktop %} will prompt you w ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the expanded "Help" dropdown menu, an option labeled "Show Logs in Explorer" is outlined in orange.](/assets/images/help/desktop/windows-show-logs.png) -2. Select the log file from the date when you encountered the authentication error. +1. Select the log file from the date when you encountered the authentication error. {% endwindows %} @@ -183,8 +183,8 @@ If the `Command Processor` registry entries are modified, {% data variables.prod 1. Open the Registry Editor (`regedit.exe`) and navigate to the following locations. `HKEY_CURRENT_USER\Software\Microsoft\Command Processor\` `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Command Processor\` -2. Check to see if there is an `Autorun` value in either location. -3. If there is an `Autorun` value, delete it. +1. Check to see if there is an `Autorun` value in either location. +1. If there is an `Autorun` value, delete it. If your Windows username has extended Unicode characters, it may cause an AskPass response error. To troubleshoot, create a new Windows user account and migrate your files to that account. For more information, see "[Create a user account in Windows](https://support.microsoft.com/en-us/help/13951/windows-create-user-account)" in the Microsoft documentation. diff --git a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md index b8e13a81b256..a9ec48b8f722 100644 --- a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md @@ -29,10 +29,10 @@ If a user runs the Windows Installer package for {% data variables.product.prodn You can install {% data variables.product.prodname_desktop %} on {% data variables.desktop.mac-osx-versions %}. {% data reusables.desktop.download-desktop-page %} -2. Click **Download for macOS**. -3. In your computer's `Downloads` folder, double-click the **{% data variables.product.prodname_desktop %}** zip file. -4. After the file has been unzipped, double-click the **{% data variables.product.prodname_desktop %}** application file. -5. {% data variables.product.prodname_desktop %} will launch after installation is complete. +1. Click **Download for macOS**. +1. In your computer's `Downloads` folder, double-click the **{% data variables.product.prodname_desktop %}** zip file. +1. After the file has been unzipped, double-click the **{% data variables.product.prodname_desktop %}** application file. +1. {% data variables.product.prodname_desktop %} will launch after installation is complete. {% endmac %} @@ -47,8 +47,8 @@ You can install {% data variables.product.prodname_desktop %} on {% data variabl {% endwarning %} {% data reusables.desktop.download-desktop-page %} -2. Click **Download for Windows**. -3. In your computer's `Downloads` folder, double-click the **{% data variables.product.prodname_desktop %}** setup file. -4. {% data variables.product.prodname_desktop %} will launch after installation is complete. +1. Click **Download for Windows**. +1. In your computer's `Downloads` folder, double-click the **{% data variables.product.prodname_desktop %}** setup file. +1. {% data variables.product.prodname_desktop %} will launch after installation is complete. {% endwindows %} diff --git a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/uninstalling-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/uninstalling-github-desktop.md index 93f3794c1ad4..ab56cc5fbecf 100644 --- a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/uninstalling-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/uninstalling-github-desktop.md @@ -11,20 +11,20 @@ shortTitle: Uninstalling {% mac %} 1. Open the Finder on your Mac and navigate to the "Applications" folder. -2. Right-click **{% data variables.product.prodname_desktop %}** and click **Move to Trash**. -4. In the menu bar, select the **Finder** dropdown menu, then click **Empty Trash**. +1. Right-click **{% data variables.product.prodname_desktop %}** and click **Move to Trash**. +1. In the menu bar, select the **Finder** dropdown menu, then click **Empty Trash**. ![Screenshot of the menu bar on a Mac. The "Finder" dropdown menu is expanded.](/assets/images/help/desktop/mac-empty-trash-menu.png) -5. Read the warning in the pop-up box and click **Empty Trash**. +1. Read the warning in the pop-up box and click **Empty Trash**. {% endmac %} {% windows %} 1. Open Control Panel. For more information, see [Where is Control Panel?](https://support.microsoft.com/en-us/help/13764/windows-where-is-control-panel) in Windows Help. -2. Under "Programs", click **Uninstall a program**. +1. Under "Programs", click **Uninstall a program**. ![Screenshot of a window labeled "Adjust your computer's settings". A link, labeled "Uninstall a program", is highlighted with an orange outline.](/assets/images/help/desktop/windows-uninstall-a-program.png) -3. Right-click the entry named **{% data variables.product.prodname_desktop %}**, then click **Uninstall**. +1. Right-click the entry named **{% data variables.product.prodname_desktop %}**, then click **Uninstall**. {% endwindows %} diff --git a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md index 6c017caa71fd..23b1cbbd79be 100644 --- a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/updating-github-desktop.md @@ -17,9 +17,9 @@ versions: ![Screenshot of the menu bar on a Mac. Under the open "GitHub Desktop" dropdown menu, a cursor hovers over "About GitHub Desktop", highlighted in blue.](/assets/images/help/desktop/desktop-menu-about-desktop-mac.png) -2. In the modal window, click **Check for Updates**. +1. In the modal window, click **Check for Updates**. ![Screenshot of the "GitHub Desktop" window. Under version details and links to external resources, a button, labeled "Check for Updates", is outlined in orange.](/assets/images/help/desktop/check-for-updates.png) -3. If an update is available, quit and relaunch {% data variables.product.prodname_desktop %} to install the update. +1. If an update is available, quit and relaunch {% data variables.product.prodname_desktop %} to install the update. ## Resolving a crash at launch by updating {% data variables.product.prodname_desktop %} @@ -42,10 +42,10 @@ If you encounter a crash when attempting to launch {% data variables.product.pro ![Screenshot of the "GitHub Desktop" menu bar on Windows. In the open "Help" dropdown menu, an option labeled "About GitHub Desktop" is outlined in orange.](/assets/images/help/desktop/help-about-desktop-win.png) -2. Click **Check for Updates**. +1. Click **Check for Updates**. ![Screenshot of the "GitHub Desktop" window. Under version details and links to external resources, a button, labeled "Check for Updates", is outlined in orange.](/assets/images/help/desktop/check-for-updates.png) -3. If an update is available, quit and relaunch {% data variables.product.prodname_desktop %} to install the update. +1. If an update is available, quit and relaunch {% data variables.product.prodname_desktop %} to install the update. {% endwindows %} diff --git a/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md index d01810839656..e87a9c0af73f 100644 --- a/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md @@ -33,21 +33,21 @@ If you do not have any repositories associated with {% data variables.product.pr We recommend that you create and clone a tutorial repository as your first project to practice using {% data variables.product.prodname_desktop %}. 1. Click **Create a Tutorial Repository...**. -2. Follow the prompts in the tutorial to install a text editor, create a branch, edit a file, make a commit, publish to {% data variables.product.prodname_dotcom %}, and open a pull request. +1. Follow the prompts in the tutorial to install a text editor, create a branch, edit a file, make a commit, publish to {% data variables.product.prodname_dotcom %}, and open a pull request. ### Creating a new repository If you do not wish to create and clone a tutorial repository, you can create a new repository. 1. Click **Create a New Repository on your Hard Drive...**. -2. In the "Create a New Repository" window, fill in the fields and select your preferred options. +1. In the "Create a New Repository" window, fill in the fields and select your preferred options. - "Name" defines the name of your repository both locally and on {% data variables.product.product_name %}. - "Description" is an optional field that you can use to provide more information about the purpose of your repository. - "Local path" sets the location of your repository on your computer. By default, {% data variables.product.prodname_desktop %} creates a _GitHub_ folder inside your _Documents_ folder to store your repositories, but you can choose any location on your computer. Your new repository will be a folder inside the chosen location. For example, if you name your repository `Tutorial`, a folder named _Tutorial_ is created inside the folder you selected for your local path. {% data variables.product.prodname_desktop %} remembers your chosen location the next time you create or clone a new repository. - **Initialize this repository with a README** creates an initial commit with a _README.md_ file. READMEs helps people understand the purpose of your project, so we recommend selecting this and filling it out with helpful information. When someone visits your repository on {% data variables.product.product_name %}, the README is the first thing they'll see as they learn about your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." - The **Git ignore** drop-down menu lets you add a custom file to ignore specific files in your local repository that you don't want to store in version control. If there's a specific language or framework that you'll be using, you can select an option from the available list. If you're just getting started, feel free to skip this selection. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)." - The **License** drop-down menu lets you add an open-source license to a LICENSE file in your repository. You don't need to worry about adding a license right away. For more information about available open-source licenses and how to add them to your repository, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." -3. Click **Create repository**. +1. Click **Create repository**. ## Part 3: Exploring {% data variables.product.prodname_desktop %} @@ -92,21 +92,21 @@ Now that you've created and published your repository, you're ready to make chan 1. To launch your external editor from within {% data variables.product.prodname_desktop %}, in the "{% data variables.product.prodname_desktop %}" menu bar, select **Repository**, then click **Open in EDITOR**. For more information, see "[AUTOTITLE](/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop)." ![Screenshot of a menu bar on a Mac. Under the open "Repository" dropdown menu, a cursor hovers over "Open in Visual Studio Code", highlighted in blue.](/assets/images/help/desktop/open-in-editor.png) -2. Make some changes to the _README.md_ file that you previously created. You can add information that describes your project, like what it does and why it is useful. When you are satisfied with your changes, save them in your text editor. -3. In {% data variables.product.prodname_desktop %}, navigate to the **Changes** view. In the file list, you should see your _README.md_. The checkbox to the left of the _README.md_ file indicates that the changes you've made to the file will be part of the commit you make. In the future, you might make changes to multiple files but only want to commit the changes you've made to some of the files. If you click the checkbox next to a file, that file will not be included in the commit. +1. Make some changes to the _README.md_ file that you previously created. You can add information that describes your project, like what it does and why it is useful. When you are satisfied with your changes, save them in your text editor. +1. In {% data variables.product.prodname_desktop %}, navigate to the **Changes** view. In the file list, you should see your _README.md_. The checkbox to the left of the _README.md_ file indicates that the changes you've made to the file will be part of the commit you make. In the future, you might make changes to multiple files but only want to commit the changes you've made to some of the files. If you click the checkbox next to a file, that file will not be included in the commit. ![Screenshot of the "Changes" tab in the sidebar. To the left of the "README.md" file, a selected checkbox is highlighted with an orange outline.](/assets/images/help/desktop/viewing-changes.png) -4. At the bottom of the **Changes** list, enter a commit message. To the right of your profile picture, type a short description of the commit. Since we're changing the _README.md_ file, "Add information about purpose of project" would be a good commit summary. Below the summary, you'll see a "Description" text field where you can type a longer description of the changes in the commit, which is helpful when looking back at the history of a project and understanding why changes were made. Since you're making a basic update of a _README.md_ file, you can skip the description. +1. At the bottom of the **Changes** list, enter a commit message. To the right of your profile picture, type a short description of the commit. Since we're changing the _README.md_ file, "Add information about purpose of project" would be a good commit summary. Below the summary, you'll see a "Description" text field where you can type a longer description of the changes in the commit, which is helpful when looking back at the history of a project and understanding why changes were made. Since you're making a basic update of a _README.md_ file, you can skip the description. ![Screenshot of the "Changes" tab in the sidebar. To the right of a profile picture, a text field containing a commit message is outlined in orange.](/assets/images/help/desktop/commit-message.png) -5. Below your commit message, click **Commit to BRANCH NAME**. The commit button shows your current branch so you can be sure to commit to the branch you want. -6. To push your changes to the remote repository on {% data variables.product.product_name %}, click **Push origin**. +1. Below your commit message, click **Commit to BRANCH NAME**. The commit button shows your current branch so you can be sure to commit to the branch you want. +1. To push your changes to the remote repository on {% data variables.product.product_name %}, click **Push origin**. ![Screenshot of the "Repository" menu bar. A button, labeled "Push origin", is highlighted with an orange outline.](/assets/images/help/desktop/push-to-origin.png) - The **Push origin** button is the same one that you clicked to publish your repository to {% data variables.product.product_name %}. This button changes contextually based on where you are at in the Git workflow. It should now say `Push origin` with a `1` next to it, indicating that there is one commit that has not been pushed up to {% data variables.product.product_name %}. - The "origin" in **Push origin** means that you are pushing changes to the remote called `origin`, which in this case is your project's repository on {% data variables.product.prodname_dotcom_the_website %}. Until you push any new commits to {% data variables.product.product_name %}, there will be differences between your project's repository on your computer and your project's repository on {% data variables.product.prodname_dotcom_the_website %}. This allows you to work locally and only push your changes to {% data variables.product.prodname_dotcom_the_website %} when you're ready. -7. In the window to the right of the **Changes** view, you'll see suggestions for actions you can do next. To open the repository on {% data variables.product.product_name %} in your browser, click **View on {% data variables.product.product_name %}**. +1. In the window to the right of the **Changes** view, you'll see suggestions for actions you can do next. To open the repository on {% data variables.product.product_name %} in your browser, click **View on {% data variables.product.product_name %}**. ![Screenshot of the "No local changes" screen. In a list of suggestions, a button, labeled "View on GitHub", is highlighted with an orange outline.](/assets/images/help/desktop/available-actions.png) -8. In your browser, click **2 commits**. You'll see a list of the commits in this repository on {% data variables.product.product_name %}. The first commit should be the commit you just made in {% data variables.product.prodname_desktop %}. +1. In your browser, click **2 commits**. You'll see a list of the commits in this repository on {% data variables.product.product_name %}. The first commit should be the commit you just made in {% data variables.product.prodname_desktop %}. ![Screenshot of the repository page on GitHub. Above the list of files and next to a clock icon, a link, labeled "2 commits", is outlined in orange.](/assets/images/help/desktop/click-two-commits.png) ## Conclusion diff --git a/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md index 17cc88ab4086..ada2da07bd00 100644 --- a/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop.md @@ -33,17 +33,17 @@ After you have installed {% data variables.product.prodname_desktop %}, you can 1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account. For more information about creating an account, see "[AUTOTITLE](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)" or contact your {% data variables.product.prodname_enterprise %} site administrator. {% data reusables.desktop.mac-select-desktop-menu %} -3. In the "Preferences" window, on the **Accounts** pane, click one of the **Sign In** buttons to sign in to your account on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_enterprise %}. +1. In the "Preferences" window, on the **Accounts** pane, click one of the **Sign In** buttons to sign in to your account on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_enterprise %}. ![Screenshot of the "Accounts" pane in the "Preferences" window. Next to "GitHub.com", a button, labeled "Sign In", is outlined in orange.](/assets/images/help/desktop/sign-in-github.png) -4. Follow the steps to sign in. For more information about authentication, see "[AUTOTITLE](/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop)." +1. Follow the steps to sign in. For more information about authentication, see "[AUTOTITLE](/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop)." {% endmac %} {% windows %} 1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account. For more information about creating an account, see "[AUTOTITLE](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)" or contact your {% data variables.product.prodname_enterprise %} site administrator. -2. In the File drop-down menu, click **Options**. In the options window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[AUTOTITLE](/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop)." +1. In the File drop-down menu, click **Options**. In the options window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[AUTOTITLE](/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop)." ![Screenshot of the "Accounts" pane in the "Options" window. Next to "GitHub.com", a button, labeled "Sign In", is outlined in orange.](/assets/images/help/desktop/windows-sign-in-github.png) {% endwindows %} diff --git a/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md b/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md index 8d5d1b0e3179..8cd50d53ca0d 100644 --- a/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md +++ b/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md @@ -12,8 +12,8 @@ versions: 1. In the menu bar, select the **{% data variables.product.prodname_desktop %}** menu, then click **Install Command Line Tool**. ![Screenshot of the menu bar on a Mac. Under the expanded "GitHub Desktop" dropdown menu, the cursor hovers over "Install command line tool", highlighted in blue.](/assets/images/help/desktop/mac-install-command-line-tool.png) -2. Open Terminal. -3. {% data reusables.desktop.launch-desktop-from-command-line %} +1. Open Terminal. +1. {% data reusables.desktop.launch-desktop-from-command-line %} ```shell github /PATH/TO/REPO @@ -31,7 +31,7 @@ versions: {% windows %} 1. Open a command prompt. -2. {% data reusables.desktop.launch-desktop-from-command-line %} +1. {% data reusables.desktop.launch-desktop-from-command-line %} ```shell C:\Users\octocat> github PATH\TO\REPO diff --git a/content/desktop/installing-and-configuring-github-desktop/overview/supported-operating-systems-for-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/overview/supported-operating-systems-for-github-desktop.md index 1d66c577a0f7..4d99c2a358c5 100644 --- a/content/desktop/installing-and-configuring-github-desktop/overview/supported-operating-systems-for-github-desktop.md +++ b/content/desktop/installing-and-configuring-github-desktop/overview/supported-operating-systems-for-github-desktop.md @@ -26,9 +26,9 @@ This error can occur when {% data variables.product.prodname_desktop %} can't ac To troubleshoot this error, follow these steps. 1. Open the "Keychain Access" app. -2. In the left sidebar, in the list of keychains, right-click **login** and then click **Lock Keychain "login"**. -3. Right-click **login** and click **Unlock Keychain "login"**. Follow any onscreen prompts to finish unlocking the Keychain "login." -4. Re-authenticate your account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}. +1. In the left sidebar, in the list of keychains, right-click **login** and then click **Lock Keychain "login"**. +1. Right-click **login** and click **Unlock Keychain "login"**. Follow any onscreen prompts to finish unlocking the Keychain "login." +1. Re-authenticate your account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}. ### `Could not create temporary directory: Permission denied` error after checking for updates @@ -37,12 +37,12 @@ This error can be caused by missing permissions for the `~/Library/Caches/com.gi To troubleshoot this error, follow these steps. 1. Close {% data variables.product.prodname_desktop %}. -2. Open "Finder" and navigate to `~/Library/Caches/`. -3. Right-click `com.github.GitHubClient.ShipIt` and then click **Get Info**. -4. Click the arrow to the left of "Sharing & Permissions." -5. If the Privilege to the right of your user account does not say "Read & Write," click the text and then click **Read & Write**. +1. Open "Finder" and navigate to `~/Library/Caches/`. +1. Right-click `com.github.GitHubClient.ShipIt` and then click **Get Info**. +1. Click the arrow to the left of "Sharing & Permissions." +1. If the Privilege to the right of your user account does not say "Read & Write," click the text and then click **Read & Write**. ![Screenshot of the info window on a Mac. Under "Sharing and permissions", a context menu is open, with "Read & Write" marked by a checkmark.](/assets/images/help/desktop/mac-adjust-permissions.png) -6. Open {% data variables.product.prodname_desktop %} and check for updates. +1. Open {% data variables.product.prodname_desktop %} and check for updates. ## Troubleshooting problems on Windows diff --git a/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md b/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md index e5f25c432e0b..b83fd8d9b11e 100644 --- a/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md +++ b/content/discussions/managing-discussions-for-your-community/creating-discussion-category-forms.md @@ -27,6 +27,6 @@ Here is the rendered version of the issue form. People with write access to a repository can create a discussion category form. 1. Navigate to the repository where you want to create a discussion category form. -2. In your repository, create a file called `/.github/DISCUSSION_TEMPLATE/FORM-NAME.yml`, replacing `FORM-NAME` with the name for your discussion category form. {% data reusables.discussions.discussion-category-forms-name %} For more information about creating new files on GitHub, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." -3. In the body of the new file, type the contents of your discussion category form. For more information, see "[AUTOTITLE](/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms)." -4. Commit your file to the default branch of your repository. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." +1. In your repository, create a file called `/.github/DISCUSSION_TEMPLATE/FORM-NAME.yml`, replacing `FORM-NAME` with the name for your discussion category form. {% data reusables.discussions.discussion-category-forms-name %} For more information about creating new files on GitHub, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." +1. In the body of the new file, type the contents of your discussion category form. For more information, see "[AUTOTITLE](/discussions/managing-discussions-for-your-community/syntax-for-discussion-category-forms)." +1. Commit your file to the default branch of your repository. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." diff --git a/content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md b/content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md index 42ac0ec994f3..63700f86eb36 100644 --- a/content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md +++ b/content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md @@ -36,11 +36,11 @@ If you choose to accept an internship project, you will be asked to submit your You can use the {% data variables.product.prodname_octernships %} website to find and apply to internships. 1. Navigate to [education.github.com/students/octernship](https://education.github.com/students/octernships). -2. If you are not already signed in, click **Sign in** on the top right of the website to sign in to your {% data variables.product.prodname_dotcom %} account. -3. Click **Explore Octernships**. -4. Browse the available opportunities and information, such as the closing date for submitting the assignment, and click **I'm interested** on an opportunity. If **I'm interested** is disabled, you are not eligible. -5. Click the link in the confirmation dialog to view the repository containing your assignment. -6. Accept **Terms of Service** of the program. You must accept it to move forward. +1. If you are not already signed in, click **Sign in** on the top right of the website to sign in to your {% data variables.product.prodname_dotcom %} account. +1. Click **Explore Octernships**. +1. Browse the available opportunities and information, such as the closing date for submitting the assignment, and click **I'm interested** on an opportunity. If **I'm interested** is disabled, you are not eligible. +1. Click the link in the confirmation dialog to view the repository containing your assignment. +1. Accept **Terms of Service** of the program. You must accept it to move forward. You can find all the projects that you have applied to, and links to the assignment repositories, on the left of the {% data variables.product.prodname_octernships %} dashboard. Use the assignment repository to complete the task provided by the organization and commit your work for the company to review. @@ -54,10 +54,10 @@ If you get accepted or rejected by the organization, you will receive an email a If you are successful in your application, you will be notified by email. You can also visit your {% data variables.product.prodname_octernships %} dashboard to accept any successful applications. If no action is taken it will be declined automatically. 1. Follow the link in your email or navigate to [education.github.com/students/octernships](https://education.github.com/students/octernships). -2. If you are not already signed in, click **Sign in** on the top right of the website to sign in to your {% data variables.product.prodname_dotcom %} account. -3. Projects that you have been accepted for are displayed above the others. To accept a project, click **Accept**. -4. To enable the {% data variables.product.prodname_education %} team to invite you to the Discord server, type your Discord username in the text box. For more information, see the [Beginner's Guide to Discord](https://support.discord.com/hc/en-us/articles/360045138571-Beginner-s-Guide-to-Discord) in the Discord documentation. -5. Click **I accept the project**. +1. If you are not already signed in, click **Sign in** on the top right of the website to sign in to your {% data variables.product.prodname_dotcom %} account. +1. Projects that you have been accepted for are displayed above the others. To accept a project, click **Accept**. +1. To enable the {% data variables.product.prodname_education %} team to invite you to the Discord server, type your Discord username in the text box. For more information, see the [Beginner's Guide to Discord](https://support.discord.com/hc/en-us/articles/360045138571-Beginner-s-Guide-to-Discord) in the Discord documentation. +1. Click **I accept the project**. ## Further reading diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md index c6049b1b76e4..fa873c9177c6 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md @@ -37,7 +37,7 @@ For information about renewing your {% data variables.product.prodname_global_ca {% data reusables.education.benefits-page %} 1. Under "Individuals", click **Get student benefits**. -2. Under "Select the academic status", select **Student**. +1. Under "Select the academic status", select **Student**. {% data reusables.education.select-email-address %} {% data reusables.education.school-name %} {% data reusables.education.plan-to-use-github %} diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md index 231d42cd7d0a..41ca66a3693f 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/about-using-visual-studio-code-with-github-classroom.md @@ -16,8 +16,8 @@ redirect_from: The GitHub Classroom integration with {% data variables.product.prodname_vscode_shortname %} provides students with an extension pack which contains: 1. [GitHub Classroom Extension](https://aka.ms/classroom-vscode-ext) with custom abstractions that make it easy for students to navigate getting started. -2. [Visual Studio Live Share Extension](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare) integrating into a student view for easy access to teaching assistants and classmates for help and collaboration. -3. [GitHub Pull Request Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) allowing students to see feedback from their instructors within the editor. +1. [Visual Studio Live Share Extension](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare) integrating into a student view for easy access to teaching assistants and classmates for help and collaboration. +1. [GitHub Pull Request Extension](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) allowing students to see feedback from their instructors within the editor. ### How to launch the assignment in {% data variables.product.prodname_vscode_shortname %} diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md index 4c5eae082255..d5b9100d097b 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md @@ -43,13 +43,13 @@ An administrator needs to register your LMS instance with classroom before you c 1. Sign into [Canvas](https://www.instructure.com/canvas/#login). 1. Select the Canvas course to integrate with {% data variables.product.prodname_classroom %}. -2. Click "Settings" in the left sidebar, then click the "Apps" tab. -3. Click the **+ App** button. -4. Under "Configuration Type", select **By Client ID** from the dropdown menu. -5. Under "Client ID", input the Client ID that your LMS administrator created when registering your LMS instance with {% data variables.product.prodname_classroom %}. -6. Click **Submit**, then click **Install**. -7. Refresh the page, and you should see a **GitHub Classroom** link in the course sub-navigation menu on the right hand side of the course details page. Note that the name may be different if your LMS admin named it something else when registering your LMS. -8. Clicking the **GitHub Classroom** link will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. +1. Click "Settings" in the left sidebar, then click the "Apps" tab. +1. Click the **+ App** button. +1. Under "Configuration Type", select **By Client ID** from the dropdown menu. +1. Under "Client ID", input the Client ID that your LMS administrator created when registering your LMS instance with {% data variables.product.prodname_classroom %}. +1. Click **Submit**, then click **Install**. +1. Refresh the page, and you should see a **GitHub Classroom** link in the course sub-navigation menu on the right hand side of the course details page. Note that the name may be different if your LMS admin named it something else when registering your LMS. +1. Clicking the **GitHub Classroom** link will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. Once your course is linked, you can import your roster from your LMS course to your classroom. For more information, see "[Importing a roster from your LMS](#importing-a-roster-from-your-lms)." @@ -63,8 +63,8 @@ You must be using Moodle version 3.0 or greater. 1. Sign into [Moodle](https://moodle.org/login/). 1. Select the Moodle course to integrate with {% data variables.product.prodname_classroom %}. -2. Under "External Tools, under "General", you should see a button with the name "GitHub Classroom". Note that the name may be different if your LMS admin named it something else when registering your LMS. -3. Clicking the **GitHub Classroom** button will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. +1. Under "External Tools, under "General", you should see a button with the name "GitHub Classroom". Note that the name may be different if your LMS admin named it something else when registering your LMS. +1. Clicking the **GitHub Classroom** button will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. Once your course is linked, you can import your roster from your LMS course to your classroom. For more information, see "[Importing a roster from your LMS](#importing-a-roster-from-your-lms)." @@ -75,10 +75,10 @@ You can link your Sakai course with a classroom in {% data variables.product.pro An administrator needs to register your LMS instance with classroom before you can link an LMS course. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom#configuring-moodle-for-github-classroom)." 1. Sign into your Sakai instance. -2. Select the Sakai course to integrate with {% data variables.product.prodname_classroom %}. -3. Click on **External Tools**. -4. Click on **Tool Links**. -5. Clicking the "GitHub Classroom" link will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. +1. Select the Sakai course to integrate with {% data variables.product.prodname_classroom %}. +1. Click on **External Tools**. +1. Click on **Tool Links**. +1. Clicking the "GitHub Classroom" link will launch you into {% data variables.product.prodname_classroom %}, where you can select a classroom to link with your LMS course. Once your course is linked, you can import your roster from your LMS course to your classroom. For more information, see "[Importing a roster from your LMS](#importing-a-roster-from-your-lms)." diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md index 60c7df18ce4b..13cfcbf51f5d 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md @@ -27,10 +27,10 @@ You can register your Canvas installation with {% data variables.product.prodnam ### 1. Register {% data variables.product.prodname_classroom %} Developer Keys in Canvas 1. Sign into [Canvas](https://www.instructure.com/canvas/#login). -2. In the left sidebar on the home page, click **Admin**, then click **Site Admin**. -3. Click **Developer Keys**. -4. Under "Developer Keys", click the **+ Developer Key** button, then select **+ LTI Key** from the dropdown menu. -5. On the "Key Settings" configuration screen, set the fields to the following values. +1. In the left sidebar on the home page, click **Admin**, then click **Site Admin**. +1. Click **Developer Keys**. +1. Under "Developer Keys", click the **+ Developer Key** button, then select **+ LTI Key** from the dropdown menu. +1. On the "Key Settings" configuration screen, set the fields to the following values. | Field in Canvas app configuration | Value or setting | | :- | :- | @@ -45,14 +45,14 @@ You can register your Canvas installation with {% data variables.product.prodnam | **LTI Advantage Services** dropdown | Select the "Can retrieve user data associated with the context the tool is installed in" checkbox. | | **Additional Settings** dropdown | Under "Privacy Level", select `Public` | | **Placements** | Select `Course Settings Sub Navigation`.

**Note**: If you set the placement to something else, this must be communicated to teachers. Our documentation will expect that this is the placement of the button. | -6. Click **Save**. -7. In the table on the "Developer Keys" page, in the row for the GitHub Classroom developer key, take note of the value of the client ID in the "Details" column -- this must be communicated to teachers for them to finish setup. -8. In the table on the "Developer Keys" page, under the "State" column, toggle the state of the key to "On". +1. Click **Save**. +1. In the table on the "Developer Keys" page, in the row for the GitHub Classroom developer key, take note of the value of the client ID in the "Details" column -- this must be communicated to teachers for them to finish setup. +1. In the table on the "Developer Keys" page, under the "State" column, toggle the state of the key to "On". ### 2. Register your developer keys with {% data variables.product.prodname_classroom %} 1. Go to https://classroom.github.com/register-lms. -2. Fill in the following information: +1. Fill in the following information: - Under "LMS Type", choose "Canvas" from the dropdown menu. - "Issuer Identifier": `https://canvas.instructure.com` @@ -74,20 +74,20 @@ You must be using Moodle version 3.0 or greater. ### 1. Enable publishing as an LTI tool in Moodle 1. Sign into [Moodle](https://moodle.org/login/). -2. Click the "Site administration" tab in the top level menu. -3. On the "Site administration" page, click the "Plugins" tab, then scroll down to the "Authentication" section and click **Manage authentication**. -4. Next to the "LTI" field, click the toggle button to enable LTI. -5. Click the "Plugins" tab again, then scroll down to "Enrolments" and click **Manage enrol plugins**. -6. Next to the "Publish as LTI tool" field, click the toggle button to enable publishing as an LTI tool. -7. Return to the "Site administration" page by clicking on the "Site administration" tab in the top level menu, then scroll down to the "Security" section and click **HTTP Security**. -8. Next to "Allow frame embedding", select the checkbox to enable frame embedding, then click **Save changes**. +1. Click the "Site administration" tab in the top level menu. +1. On the "Site administration" page, click the "Plugins" tab, then scroll down to the "Authentication" section and click **Manage authentication**. +1. Next to the "LTI" field, click the toggle button to enable LTI. +1. Click the "Plugins" tab again, then scroll down to "Enrolments" and click **Manage enrol plugins**. +1. Next to the "Publish as LTI tool" field, click the toggle button to enable publishing as an LTI tool. +1. Return to the "Site administration" page by clicking on the "Site administration" tab in the top level menu, then scroll down to the "Security" section and click **HTTP Security**. +1. Next to "Allow frame embedding", select the checkbox to enable frame embedding, then click **Save changes**. ### 2. Register {% data variables.product.prodname_classroom %} as an external tool 1. Return to the Moodle "Site administration" page by clicking on the "Site administration" tab in the top level menu. -2. Click the "Plugins" tab, then next to the "Activity modules" section, under "External tool", click **Manage tools**. -3. Click **Configure a tool manually**. -4. Enter the following values in the fields. +1. Click the "Plugins" tab, then next to the "Activity modules" section, under "External tool", click **Manage tools**. +1. Click **Configure a tool manually**. +1. Enter the following values in the fields. | Field in Moodle app configuration | Value or setting | | :- | :- | @@ -100,10 +100,10 @@ You must be using Moodle version 3.0 or greater. | **Redirection URI(s)** | `https://classroom.github.com/lti1p3/openid-connect/redirect` | | **Default launch container** | `New window` | -5. Select the **Supports Deep Linking (Content-Item Message)** checkbox. -6. Under the "Services" dropdown, next to "IMS LTI Names and Role Provisioning", select "Use this service to retrieve members' information as per privacy settings" from the dropdown menu. -7. Click **Save changes**. -8. GitHub Classroom has now been registered as an external tool. Under "Tools", on the 'GitHub Classroom" box, click the menu icon to see the "Tool configuration details" screen. This screen contains important information you'll need to input in the last step of registering your instance in {% data variables.product.prodname_classroom %} below. +1. Select the **Supports Deep Linking (Content-Item Message)** checkbox. +1. Under the "Services" dropdown, next to "IMS LTI Names and Role Provisioning", select "Use this service to retrieve members' information as per privacy settings" from the dropdown menu. +1. Click **Save changes**. +1. GitHub Classroom has now been registered as an external tool. Under "Tools", on the 'GitHub Classroom" box, click the menu icon to see the "Tool configuration details" screen. This screen contains important information you'll need to input in the last step of registering your instance in {% data variables.product.prodname_classroom %} below. ### 3. Registering your Moodle instance with {% data variables.product.prodname_classroom %} @@ -126,9 +126,9 @@ You must be using Moodle version 3.0 or greater. ### 1. Register {% data variables.product.prodname_classroom %} as an external tool 1. Go to Sakai and log in. -2. Go to "Administration Workspace" and select **External Tools** in the left hand sidebar. -3. Click **Install LTI 1.x Tool**. -4. Enter the following values in the fields. +1. Go to "Administration Workspace" and select **External Tools** in the left hand sidebar. +1. Click **Install LTI 1.x Tool**. +1. Enter the following values in the fields. | Field in Sakai app configuration | Value or setting | | :- | :- | @@ -141,7 +141,7 @@ You must be using Moodle version 3.0 or greater. | **LTI 1.3 Tool Keyset URL** | `https://classroom.github.com/.well-known/jwks.json` | | **LTI 1.3 Tool OpenID Connect/Initialization Endpoint** | `https://classroom.github.com/lti1p3/openid-connect/auth` | | **LTI 1.3 Tool Redirect Endpoint** | `https://classroom.github.com/lti1p3/openid-connect/redirect` | -5. Upon submitting, Sakai will show you the information you need to register your Sakai instance with {% data variables.product.prodname_classroom %}. +1. Upon submitting, Sakai will show you the information you need to register your Sakai instance with {% data variables.product.prodname_classroom %}. ### 2. Registering your Sakai instance with {% data variables.product.prodname_classroom %} diff --git a/content/education/quickstart.md b/content/education/quickstart.md index 5fed5217cba8..3935759d7b21 100644 --- a/content/education/quickstart.md +++ b/content/education/quickstart.md @@ -31,7 +31,7 @@ After you create your personal account, create a free organization account. You' {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.organizations %} {% data reusables.organizations.new-organization %} -4. Follow the prompts to create a free organization. +1. Follow the prompts to create a free organization. For more information, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)." diff --git a/content/get-started/exploring-projects-on-github/following-organizations.md b/content/get-started/exploring-projects-on-github/following-organizations.md index 55a783df8fb6..8a10ffbaad6f 100644 --- a/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/content/get-started/exploring-projects-on-github/following-organizations.md @@ -23,12 +23,12 @@ You can unfollow an organization if you do not wish to see their {% ifversion fp ## Unfollowing an organization on {% data variables.product.product_name %} 1. Go to the organization page you want to unfollow. -2. In the top-right corner, click **Unfollow**. +1. In the top-right corner, click **Unfollow**. ## Viewing people and organizations a user follows on {% data variables.product.product_name %} {% data reusables.profile.navigate-to-user-profile %} -2. Under the user's profile picture, click **following**. +1. Under the user's profile picture, click **following**. ![Screenshot of the sidebar of @octocat's profile page. A link, labeled "9 following", is outlined in dark orange.](/assets/images/help/profile/user-profile-following.png) diff --git a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md index 4eac94132787..acb72f425060 100644 --- a/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md +++ b/content/get-started/exploring-projects-on-github/saving-repositories-with-stars.md @@ -69,36 +69,36 @@ You can add a repository to an existing or new list wherever you see a repositor ### Creating a list {% data reusables.stars.stars-page-navigation %} -2. Next to "Lists", click **Create list**. -3. Enter a name and description for your list and click **Create**. +1. Next to "Lists", click **Create list**. +1. Enter a name and description for your list and click **Create**. ### Adding a repository to a list {% data reusables.stars.stars-page-navigation %} -2. Find the repository you want to add to your list by typing it into the search bar. -3. Next to the repository you want to add, use the **Starred** dropdown menu and select your list. +1. Find the repository you want to add to your list by typing it into the search bar. +1. Next to the repository you want to add, use the **Starred** dropdown menu and select your list. ![Screenshot of a list of repositories on the "Stars" page. Next to a repository, under the "Starred" button, a dropdown menu is outlined in orange.](/assets/images/help/stars/add-repo-to-list.png) ### Removing a repository from your list {% data reusables.stars.stars-page-navigation %} -2. Select your list. -3. Next to the repository you want to remove, use the **Starred** drop-down menu and deselect your list. +1. Select your list. +1. Next to the repository you want to remove, use the **Starred** drop-down menu and deselect your list. ![Screenshot of a list of repositories on the "Stars" page. Next to a repository, under the "Starred" button, a dropdown menu is outlined in orange.](/assets/images/help/stars/add-repo-to-list.png) ### Editing a list name or description {% data reusables.stars.stars-page-navigation %} 1. Select the list you want to edit. -2. Click **Edit list**. -3. Update the name or description and click **Save list**. +1. Click **Edit list**. +1. Update the name or description and click **Save list**. ### Deleting a list {% data reusables.stars.stars-page-navigation %} -2. Select the list you want to delete. -3. Click **Delete list**. -4. To confirm, click **Delete**. +1. Select the list you want to delete. +1. Click **Delete list**. +1. To confirm, click **Delete**. {% endif %} diff --git a/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md b/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md index cb3546479c27..888dd84bd0b0 100644 --- a/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md +++ b/content/get-started/getting-started-with-git/caching-your-github-credentials-in-git.md @@ -27,7 +27,7 @@ shortTitle: Caching credentials {% data variables.product.prodname_cli %} will automatically store your Git credentials for you when you choose `HTTPS` as your preferred protocol for Git operations and answer "yes" to the prompt asking if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials. 1. [Install](https://github.com/cli/cli#installation) {% data variables.product.prodname_cli %} on macOS, Windows, or Linux. -2. In the command line, enter `gh auth login`, then follow the prompts. +1. In the command line, enter `gh auth login`, then follow the prompts. - When prompted for your preferred protocol for Git operations, select `HTTPS`. - When asked if you would like to authenticate to Git with your {% data variables.product.product_name %} credentials, enter `Y`. @@ -45,7 +45,7 @@ For more information about authenticating with {% data variables.product.prodnam brew install git ``` -2. Install GCM using Homebrew: +1. Install GCM using Homebrew: ```shell brew tap microsoft/git @@ -92,9 +92,9 @@ For Linux, install Git and GCM, then configure Git to use GCM. 1. Install Git from your distro's packaging system. Instructions will vary depending on the flavor of Linux you run. -2. Install GCM. See the [instructions in the GCM repo](https://github.com/git-ecosystem/git-credential-manager/blob/release/docs/install.md), as they'll vary depending on the flavor of Linux you run. +1. Install GCM. See the [instructions in the GCM repo](https://github.com/git-ecosystem/git-credential-manager/blob/release/docs/install.md), as they'll vary depending on the flavor of Linux you run. -3. Configure Git to use GCM. There are several backing stores that you may choose from, so see the GCM docs to complete your setup. For more information, see "[GCM Linux](https://aka.ms/gcmcore-linuxcredstores)." +1. Configure Git to use GCM. There are several backing stores that you may choose from, so see the GCM docs to complete your setup. For more information, see "[GCM Linux](https://aka.ms/gcmcore-linuxcredstores)." {% data reusables.gcm-core.next-time-you-clone %} diff --git a/content/get-started/getting-started-with-git/ignoring-files.md b/content/get-started/getting-started-with-git/ignoring-files.md index 2081272fe08a..9ebfc11af253 100644 --- a/content/get-started/getting-started-with-git/ignoring-files.md +++ b/content/get-started/getting-started-with-git/ignoring-files.md @@ -22,10 +22,9 @@ To share the ignore rules with other users who clone the repository, commit the GitHub maintains an official list of recommended _.gitignore_ files for many popular operating systems, environments, and languages in the `github/gitignore` public repository. You can also use gitignore.io to create a _.gitignore_ file for your operating system, programming language, or IDE. For more information, see "[github/gitignore](https://github.com/github/gitignore)" and the "[gitignore.io](https://www.gitignore.io/)" site. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navigate to the location of your Git repository. +1. Navigate to the location of your Git repository. +1. Create a _.gitignore_ file for your repository. -3. Create a _.gitignore_ file for your repository. - ```shell touch .gitignore ``` @@ -46,8 +45,8 @@ You can also create a global _.gitignore_ file to define a list of rules for ign {% data reusables.command_line.open_the_multi_os_terminal %} -2. Configure Git to use the exclude file _~/.gitignore_global_ for all Git repositories. - +1. Configure Git to use the exclude file _~/.gitignore_global_ for all Git repositories. + ```shell git config --global core.excludesfile ~/.gitignore_global ``` @@ -59,8 +58,8 @@ If you don't want to create a _.gitignore_ file to share with others, you can cr Use your favorite text editor to open the file called _.git/info/exclude_ within the root of your Git repository. Any rule you add here will not be checked in, and will only ignore files for your local repository. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navigate to the location of your Git repository. -3. Using your favorite text editor, open the file _.git/info/exclude_. +1. Navigate to the location of your Git repository. +1. Using your favorite text editor, open the file _.git/info/exclude_. ## Further Reading diff --git a/content/get-started/getting-started-with-git/managing-remote-repositories.md b/content/get-started/getting-started-with-git/managing-remote-repositories.md index 97b45aba24f2..375519bac097 100644 --- a/content/get-started/getting-started-with-git/managing-remote-repositories.md +++ b/content/get-started/getting-started-with-git/managing-remote-repositories.md @@ -90,8 +90,8 @@ The `git remote set-url` command takes two arguments: ### Switching remote URLs from SSH to HTTPS {% data reusables.command_line.open_the_multi_os_terminal %} -2. Change the current working directory to your local project. -3. List your existing remotes in order to get the name of the remote you want to change. +1. Change the current working directory to your local project. +1. List your existing remotes in order to get the name of the remote you want to change. ```shell $ git remote -v @@ -99,13 +99,13 @@ The `git remote set-url` command takes two arguments: > origin git@{% data variables.command_line.codeblock %}:OWNER/REPOSITORY.git (push) ``` -4. Change your remote's URL from SSH to HTTPS with the `git remote set-url` command. +1. Change your remote's URL from SSH to HTTPS with the `git remote set-url` command. ```shell git remote set-url origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git ``` -5. Verify that the remote URL has changed. +1. Verify that the remote URL has changed. ```shell $ git remote -v @@ -121,8 +121,8 @@ You can [use a credential helper](/get-started/getting-started-with-git/caching- ### Switching remote URLs from HTTPS to SSH {% data reusables.command_line.open_the_multi_os_terminal %} -2. Change the current working directory to your local project. -3. List your existing remotes in order to get the name of the remote you want to change. +1. Change the current working directory to your local project. +1. List your existing remotes in order to get the name of the remote you want to change. ```shell $ git remote -v @@ -130,13 +130,13 @@ You can [use a credential helper](/get-started/getting-started-with-git/caching- > origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) ``` -4. Change your remote's URL from HTTPS to SSH with the `git remote set-url` command. +1. Change your remote's URL from HTTPS to SSH with the `git remote set-url` command. ```shell git remote set-url origin git@{% data variables.command_line.codeblock %}:OWNER/REPOSITORY.git ``` -5. Verify that the remote URL has changed. +1. Verify that the remote URL has changed. ```shell $ git remote -v diff --git a/content/get-started/getting-started-with-git/setting-your-username-in-git.md b/content/get-started/getting-started-with-git/setting-your-username-in-git.md index 75a474d55954..54b8bb5a6815 100644 --- a/content/get-started/getting-started-with-git/setting-your-username-in-git.md +++ b/content/get-started/getting-started-with-git/setting-your-username-in-git.md @@ -23,13 +23,13 @@ Changing the name associated with your Git commits using `git config` will only {% data reusables.command_line.open_the_multi_os_terminal %} -2. {% data reusables.user-settings.set_your_git_username %} +1. {% data reusables.user-settings.set_your_git_username %} ```shell git config --global user.name "Mona Lisa" ``` -3. {% data reusables.user-settings.confirm_git_username_correct %} +1. {% data reusables.user-settings.confirm_git_username_correct %} ```shell $ git config --global user.name @@ -40,15 +40,15 @@ Changing the name associated with your Git commits using `git config` will only {% 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 name that is associated with your Git commits. +1. Change the current working directory to the local repository where you want to configure the name that is associated with your Git commits. -3. {% data reusables.user-settings.set_your_git_username %} +1. {% data reusables.user-settings.set_your_git_username %} ```shell git config user.name "Mona Lisa" ``` -3. {% data reusables.user-settings.confirm_git_username_correct %} +1. {% data reusables.user-settings.confirm_git_username_correct %} ```shell $ git config user.name diff --git a/content/get-started/quickstart/contributing-to-projects.md b/content/get-started/quickstart/contributing-to-projects.md index 03650b53f63d..b4d36efe60a6 100644 --- a/content/get-started/quickstart/contributing-to-projects.md +++ b/content/get-started/quickstart/contributing-to-projects.md @@ -32,12 +32,12 @@ This tutorial uses [the Spoon-Knife project](https://github.com/octocat/Spoon-Kn ![Screenshot of the main page of repository. A button, labeled with a fork icon and "Fork 59.3k," is outlined in dark orange.](/assets/images/help/repository/fork_button.png) {%- ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %} 1. Under "Owner," select the dropdown menu and click an owner for the forked repository. -2. By default, forks are named the same as their upstream repositories. Optionally, to further distinguish your fork, in the "Repository name" field, type a name. -3. Optionally, in the "Description" field, type a description of your fork. -4. Optionally, select **Copy the DEFAULT branch only**. +1. By default, forks are named the same as their upstream repositories. Optionally, to further distinguish your fork, in the "Repository name" field, type a name. +1. Optionally, in the "Description" field, type a description of your fork. +1. Optionally, select **Copy the DEFAULT branch only**. For many forking scenarios, such as contributing to open-source projects, you only need to copy the default branch. If you do not select this option, all branches will be copied into the new fork. -5. Click **Create fork**. +1. Click **Create fork**. {% note %} @@ -58,13 +58,13 @@ You can clone your fork with the command line, {% data variables.product.prodnam {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.change-current-directory-clone %} -4. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`: +1. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`: ```shell git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife ``` -5. Press **Enter**. Your local clone will be created. +1. Press **Enter**. Your local clone will be created. ```shell $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife diff --git a/content/get-started/quickstart/create-a-repo.md b/content/get-started/quickstart/create-a-repo.md index 99ae9522272c..5dc81bf1a225 100644 --- a/content/get-started/quickstart/create-a-repo.md +++ b/content/get-started/quickstart/create-a-repo.md @@ -45,10 +45,10 @@ You can store a variety of projects in {% data variables.product.product_name %} {% webui %} {% data reusables.repositories.create_new %} -2. Type a short, memorable name for your repository. For example, "hello-world". +1. Type a short, memorable name for your repository. For example, "hello-world". ![Screenshot of the first step in creating a {% data variables.product.prodname_dotcom %} repository. The "Repository name" field contains the text "hello-world" and is outlined in dark orange.](/assets/images/help/repository/create-repository-name.png) -3. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}." +1. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}." {% data reusables.repositories.choose-repo-visibility %} {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} @@ -62,9 +62,9 @@ Congratulations! You've successfully created your first repository, and initiali {% data reusables.cli.cli-learn-more %} 1. In the command line, navigate to the directory where you would like to create a local clone of your new project. -2. To create a repository for your project, use the `gh repo create` subcommand. When prompted, select **Create a new repository on GitHub from scratch** and enter the name of your new project. If you want your project to belong to an organization instead of to your personal account, specify the organization name and project name with `organization-name/project-name`. -3. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. -4. Alternatively, to skip the prompts supply the repository name and a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create project-name --public`. To clone the repository locally, pass the `--clone` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). +1. To create a repository for your project, use the `gh repo create` subcommand. When prompted, select **Create a new repository on GitHub from scratch** and enter the name of your new project. If you want your project to belong to an organization instead of to your personal account, specify the organization name and project name with `organization-name/project-name`. +1. Follow the interactive prompts. To clone the repository locally, confirm yes when asked if you would like to clone the remote project directory. +1. Alternatively, to skip the prompts supply the repository name and a visibility flag (`--public`, `--private`, or `--internal`). For example, `gh repo create project-name --public`. To clone the repository locally, pass the `--clone` flag. For more information about possible arguments, see the [GitHub CLI manual](https://cli.github.com/manual/gh_repo_create). {% endcli %} diff --git a/content/get-started/quickstart/fork-a-repo.md b/content/get-started/quickstart/fork-a-repo.md index 87a9dcec7d80..9f916a70972f 100644 --- a/content/get-started/quickstart/fork-a-repo.md +++ b/content/get-started/quickstart/fork-a-repo.md @@ -61,8 +61,8 @@ You might fork a project to propose changes to the upstream repository. In this ![Screenshot of the main page of repository. A button, labeled with a fork icon and "Fork 59.3k," is outlined in dark orange.](/assets/images/help/repository/fork_button.png) {%- ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %} 1. Under "Owner," select the dropdown menu and click an owner for the forked repository. -2. By default, forks are named the same as their upstream repositories. Optionally, to further distinguish your fork, in the "Repository name" field, type a name. -3. Optionally, in the "Description" field, type a description of your fork. +1. By default, forks are named the same as their upstream repositories. Optionally, to further distinguish your fork, in the "Repository name" field, type a name. +1. Optionally, in the "Description" field, type a description of your fork. {%- ifversion fpt or ghec or ghes > 3.6 or ghae > 3.6 %} 1. Optionally, select **Copy the DEFAULT branch only**. @@ -112,13 +112,13 @@ Right now, you have a fork of the Spoon-Knife repository, but you do not have th {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.change-current-directory-clone %} -4. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`: +1. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`: ```shell git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife ``` -5. Press **Enter**. Your local clone will be created. +1. Press **Enter**. Your local clone will be created. ```shell $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife @@ -162,12 +162,12 @@ When you fork a project in order to propose changes to the upstream repository, 1. On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.location.product_location %}{% endif %}, navigate to the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} -4. Change directories to the location of the fork you cloned. +1. Change directories to the location of the fork you cloned. - To go to your home directory, type just `cd` with no other text. - To list the files and folders in your current directory, type `ls`. - To go into one of your listed directories, type `cd your_listed_directory`. - To go up one directory, type `cd ..`. -5. Type `git remote -v` and press **Enter**. You will see the current configured remote repository for your fork. +1. Type `git remote -v` and press **Enter**. You will see the current configured remote repository for your fork. ```shell $ git remote -v @@ -175,13 +175,13 @@ When you fork a project in order to propose changes to the upstream repository, > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) ``` -6. Type `git remote add upstream`, and then paste the URL you copied in Step 3 and press **Enter**. It will look like this: +1. Type `git remote add upstream`, and then paste the URL you copied in Step 3 and press **Enter**. It will look like this: ```shell git remote add upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/Spoon-Knife.git ``` -7. To verify the new upstream repository you have specified for your fork, type `git remote -v` again. You should see the URL for your fork as `origin`, and the URL for the upstream repository as `upstream`. +1. To verify the new upstream repository you have specified for your fork, type `git remote -v` again. You should see the URL for your fork as `origin`, and the URL for the upstream repository as `upstream`. ```shell $ git remote -v diff --git a/content/get-started/quickstart/hello-world.md b/content/get-started/quickstart/hello-world.md index 906bb9d31466..b2591a9c3f46 100644 --- a/content/get-started/quickstart/hello-world.md +++ b/content/get-started/quickstart/hello-world.md @@ -69,11 +69,11 @@ Here at {% data variables.product.product_name %}, our developers, writers, and ### Create a branch 1. Click the **Code** tab of your `hello-world` repository. -2. Above the file list, click the dropdown menu that says **main**. +1. Above the file list, click the dropdown menu that says **main**. ![Screenshot of the repository page. A dropdown menu, labeled with a branch icon and "main", is highlighted with an orange outline.](/assets/images/help/branches/branch-selection-dropdown.png) -3. Type a branch name, `readme-edits`, into the text box. -4. Click **Create branch: readme-edits from main**. +1. Type a branch name, `readme-edits`, into the text box. +1. Click **Create branch: readme-edits from main**. ![Screenshot of the branch dropdown for a repository. "Create branch: readme-edits from 'main'" is outlined in dark orange.](/assets/images/help/repository/new-branch.png) Now you have two branches, `main` and `readme-edits`. Right now, they look exactly the same. Next you'll add changes to the new branch. @@ -111,16 +111,16 @@ By using {% data variables.product.product_name %}'s `@mention` feature in your You can even open pull requests in your own repository and merge them yourself. It's a great way to learn the {% data variables.product.product_name %} flow before working on larger projects. 1. Click the **Pull requests** tab of your `hello-world` repository. -2. Click **New pull request** -3. In the **Example Comparisons** box, select the branch you made, `readme-edits`, to compare with `main` (the original). -4. Look over your changes in the diffs on the Compare page, make sure they're what you want to submit. +1. Click **New pull request** +1. In the **Example Comparisons** box, select the branch you made, `readme-edits`, to compare with `main` (the original). +1. Look over your changes in the diffs on the Compare page, make sure they're what you want to submit. ![Screenshot of a diff for the README.md file. 3 red lines list the text that's being removed, and 3 green lines list the text being added.](/assets/images/help/repository/diffs.png) -5. Click **Create pull request**. -6. Give your pull request a title and write a brief description of your changes. You can include emojis and drag and drop images and gifs. -7. Optionally, to the right of your title and description, click the {% octicon "gear" aria-label="The Gear icon" %} next to **Reviewers**. **Assignees**, **Labels**, **Projects**, or **Milestone** to add any of these options to your pull request. You do not need to add any yet, but these options offer different ways to collaborate using pull requests. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -7. Click **Create pull request**. +1. Click **Create pull request**. +1. Give your pull request a title and write a brief description of your changes. You can include emojis and drag and drop images and gifs. +1. Optionally, to the right of your title and description, click the {% octicon "gear" aria-label="The Gear icon" %} next to **Reviewers**. **Assignees**, **Labels**, **Projects**, or **Milestone** to add any of these options to your pull request. You do not need to add any yet, but these options offer different ways to collaborate using pull requests. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." +1. Click **Create pull request**. Your collaborators can now review your edits and make suggestions. diff --git a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md index 636af64a0646..9f1b36ee5512 100644 --- a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -87,4 +87,4 @@ If you cancel your trial, all enterprise owners and members also lose access to {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} 1. At the top of the page, click **Buy Enterprise** or **Cancel trial**. -6. Follow the prompts. +1. Follow the prompts. diff --git a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md index 9e518452f94f..6685aa7b90f3 100644 --- a/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md +++ b/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-server.md @@ -38,14 +38,14 @@ To install {% data variables.product.prodname_ghe_server %}, download the necess To get the most out of your trial, follow these steps: 1. [Create an organization](/enterprise-server@latest/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch). -2. To learn the basics of using {% data variables.product.prodname_dotcom %}, see: +1. To learn the basics of using {% data variables.product.prodname_dotcom %}, see: - [Intro to {% data variables.product.prodname_dotcom %}](https://resources.github.com/devops/methodology/maximizing-devops-roi/) webcast - [Understanding the {% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow/) in {% data variables.product.prodname_dotcom %} Guides - [Hello World](https://guides.github.com/activities/hello-world/) in {% data variables.product.prodname_dotcom %} Guides - "[AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs)" -3. To configure your instance to meet your organization's needs, see "[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-your-enterprise)." -4. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[AUTOTITLE](/enterprise-server@latest/admin/identity-and-access-management/using-saml-for-enterprise-iam)" and "[AUTOTITLE](/enterprise-server@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap)." -5. Invite an unlimited number of people to join your trial. +1. To configure your instance to meet your organization's needs, see "[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-your-enterprise)." +1. To integrate {% data variables.product.prodname_ghe_server %} with your identity provider, see "[AUTOTITLE](/enterprise-server@latest/admin/identity-and-access-management/using-saml-for-enterprise-iam)" and "[AUTOTITLE](/enterprise-server@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap)." +1. Invite an unlimited number of people to join your trial. - Add users to your {% data variables.product.prodname_ghe_server %} instance using built-in authentication or your configured identity provider. For more information, see "[AUTOTITLE](/enterprise-server@latest/admin/identity-and-access-management/using-built-in-authentication/configuring-built-in-authentication)." - To invite people to become account administrators, visit the [{% data variables.product.prodname_enterprise %} Web portal](https://enterprise.github.com/login). diff --git a/content/get-started/signing-up-for-github/verifying-your-email-address.md b/content/get-started/signing-up-for-github/verifying-your-email-address.md index c617b120a3fc..012d7b88d05f 100644 --- a/content/get-started/signing-up-for-github/verifying-your-email-address.md +++ b/content/get-started/signing-up-for-github/verifying-your-email-address.md @@ -48,7 +48,7 @@ If you do not verify your email address, you will not be able to: 1. Under your email address, click **Resend verification email**. ![Screenshot of a list of email addresses on the "Emails" page. Under an email address, a link, labeled "Resend verification email," is outlined in orange.](/assets/images/help/settings/email-verify-button.png) -4. {% data variables.product.prodname_dotcom %} will send you an email with a link in it. After you click that link, you'll be taken to your {% data variables.product.prodname_dotcom %} dashboard and see a confirmation banner. +1. {% data variables.product.prodname_dotcom %} will send you an email with a link in it. After you click that link, you'll be taken to your {% data variables.product.prodname_dotcom %} dashboard and see a confirmation banner. ## Troubleshooting email verification @@ -63,9 +63,9 @@ The verification link expires after 24 hours. If you don't verify your email wit If you click on the link in the confirmation email within 24 hours and you are directed to an error page, you should ensure that you're signed into the correct account on {% data variables.location.product_location %}. 1. {% data variables.product.signout_link %} of your personal account on {% data variables.location.product_location %}. -2. Quit and restart your browser. -3. {% data variables.product.signin_link %} to your personal account on {% data variables.location.product_location %}. -4. Click on the verification link in the email we sent you. +1. Quit and restart your browser. +1. {% data variables.product.signin_link %} to your personal account on {% data variables.location.product_location %}. +1. Click on the verification link in the email we sent you. ## Further reading diff --git a/content/get-started/using-git/about-git-subtree-merges.md b/content/get-started/using-git/about-git-subtree-merges.md index 22a6781b146b..8a71c3997252 100644 --- a/content/get-started/using-git/about-git-subtree-merges.md +++ b/content/get-started/using-git/about-git-subtree-merges.md @@ -28,21 +28,21 @@ The best way to explain subtree merges is to show by example. We will: ## Setting up the empty repository for a subtree merge {% data reusables.command_line.open_the_multi_os_terminal %} -2. Create a new directory and navigate to it. +1. Create a new directory and navigate to it. ```shell mkdir test cd test ``` -3. Initialize a new Git repository. +1. Initialize a new Git repository. ```shell $ git init > Initialized empty Git repository in /Users/octocat/tmp/test/.git/ ``` -4. Create and commit a new file. +1. Create and commit a new file. ```shell $ touch .gitignore @@ -70,7 +70,7 @@ The best way to explain subtree merges is to show by example. We will: > * [new branch] main -> Spoon-Knife/main ``` -2. Merge the `Spoon-Knife` project into the local Git project. This doesn't change any of your files locally, but it does prepare Git for the next step. +1. Merge the `Spoon-Knife` project into the local Git project. This doesn't change any of your files locally, but it does prepare Git for the next step. If you're using Git 2.9 or above: @@ -86,14 +86,14 @@ The best way to explain subtree merges is to show by example. We will: > Automatic merge went well; stopped before committing as requested ``` -3. Create a new directory called **spoon-knife**, and copy the Git history of the `Spoon-Knife` project into it. +1. Create a new directory called **spoon-knife**, and copy the Git history of the `Spoon-Knife` project into it. ```shell $ git read-tree --prefix=spoon-knife/ -u spoon-knife/main > fatal: refusing to merge unrelated histories ``` -4. Commit the changes to keep them safe. +1. Commit the changes to keep them safe. ```shell $ git commit -m "Subtree merged in spoon-knife" diff --git a/content/get-started/using-git/about-git.md b/content/get-started/using-git/about-git.md index 5c7431bde23c..c9a6e26f2353 100644 --- a/content/get-started/using-git/about-git.md +++ b/content/get-started/using-git/about-git.md @@ -159,7 +159,7 @@ git push There are two primary ways people collaborate on {% data variables.product.product_name %}: 1. Shared repository -2. Fork and pull +1. Fork and pull With a shared repository, individuals and teams are explicitly designated as contributors with read, write, or administrator access. This simple permission structure, combined with features like protected branches, helps teams progress quickly when they adopt {% data variables.product.product_name %}. diff --git a/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md b/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md index 31054a22a9be..3ecd8657ebce 100644 --- a/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md +++ b/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md @@ -18,21 +18,21 @@ If you create a new clone of the repository, you won't lose any of your Git hist {% data reusables.command_line.open_the_multi_os_terminal %} -2. Change the current working directory to the location where you want to create your new repository. +1. Change the current working directory to the location where you want to create your new repository. -4. Clone the repository that contains the subfolder. +1. Clone the repository that contains the subfolder. ```shell git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME ``` -4. Change the current working directory to your cloned repository. +1. Change the current working directory to your cloned repository. ```shell cd REPOSITORY-NAME ``` -5. To filter out the subfolder from the rest of the files in the repository, install [`git-filter-repo`](https://github.com/newren/git-filter-repo), then run `git filter-repo` with the following arguments. +1. To filter out the subfolder from the rest of the files in the repository, install [`git-filter-repo`](https://github.com/newren/git-filter-repo), then run `git filter-repo` with the following arguments. - `FOLDER-NAME`: The folder within your project where you'd like to create a separate repository. {% windows %} @@ -54,9 +54,9 @@ If you create a new clone of the repository, you won't lose any of your Git hist The repository should now only contain the files that were in your subfolder(s). -6. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_name %}. +1. [Create a new repository](/repositories/creating-and-managing-repositories/creating-a-new-repository) on {% data variables.product.product_name %}. -7. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. +1. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. ![Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) @@ -66,13 +66,13 @@ If you create a new clone of the repository, you won't lose any of your Git hist {% endtip %} -8. Add a new remote name with the URL you copied for your repository. For example, `origin` or `upstream` are two common choices. +1. Add a new remote name with the URL you copied for your repository. For example, `origin` or `upstream` are two common choices. ```shell git remote add origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git ``` -9. Verify that the remote URL was added with your new repository name. +1. Verify that the remote URL was added with your new repository name. ```shell $ git remote -v @@ -81,7 +81,7 @@ If you create a new clone of the repository, you won't lose any of your Git hist > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) ``` -10. Push your changes to the new repository on {% data variables.product.product_name %}. +1. Push your changes to the new repository on {% data variables.product.product_name %}. ```shell git push -u origin BRANCH-NAME diff --git a/content/get-started/using-github/github-mobile.md b/content/get-started/using-github/github-mobile.md index 5c3ce3fe426b..54f7d08a4673 100644 --- a/content/get-started/using-github/github-mobile.md +++ b/content/get-started/using-github/github-mobile.md @@ -90,5 +90,5 @@ You can submit feature requests or other feedback for {% data variables.product. If you're testing a beta release of {% data variables.product.prodname_mobile %} for iOS using TestFlight, you can leave the beta at any time. 1. On your iOS device, open the TestFlight app. -2. Under "Apps", tap **{% data variables.product.prodname_dotcom %}**. -3. At the bottom of the page, tap **Stop Testing**. +1. Under "Apps", tap **{% data variables.product.prodname_dotcom %}**. +1. At the bottom of the page, tap **Stop Testing**. diff --git a/content/get-started/working-with-subversion-on-github/support-for-subversion-clients.md b/content/get-started/working-with-subversion-on-github/support-for-subversion-clients.md index a23a88570fac..14ce243acaa7 100644 --- a/content/get-started/working-with-subversion-on-github/support-for-subversion-clients.md +++ b/content/get-started/working-with-subversion-on-github/support-for-subversion-clients.md @@ -27,7 +27,7 @@ Subversion checkouts are different: they mix the repository data in the working {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.copy-clone-url %} -3. Make an empty checkout of the repository: +1. Make an empty checkout of the repository: ```shell $ svn co --depth empty https://github.com/USER/REPO @@ -35,7 +35,7 @@ Subversion checkouts are different: they mix the repository data in the working $ cd REPO ``` -4. Get the `trunk` branch. The Subversion bridge maps trunk to the Git HEAD branch. +1. Get the `trunk` branch. The Subversion bridge maps trunk to the Git HEAD branch. ```shell $ svn up trunk @@ -45,7 +45,7 @@ Subversion checkouts are different: they mix the repository data in the working > Updated to revision 1. ``` -5. Get an empty checkout of the `branches` directory. This is where all of the non-`HEAD` branches live, and where you'll be making feature branches. +1. Get an empty checkout of the `branches` directory. This is where all of the non-`HEAD` branches live, and where you'll be making feature branches. ```shell $ svn up --depth empty branches diff --git a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index ca257bac4f8a..43a4dc99f189 100644 --- a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -69,11 +69,11 @@ Alternatively, you can drag and drop a text file from your desktop directly into {% endnote %} 1. Sign in to {% data variables.product.product_name %}. -2. Navigate to your {% data variables.gists.gist_homepage %}. -3. Optionally, in the "Gist description" field, type a description for your gist. -4. In the "Filename including extension" field, type a file name for your gist, including the file extensions. -5. In the file contents field, type the text of your gist. -6. Optionally, to create {% ifversion ghae %}an internal{% else %}a public{% endif %} gist, click {% octicon "triangle-down" aria-label="The downwards triangle icon" %}, then click **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. +1. Navigate to your {% data variables.gists.gist_homepage %}. +1. Optionally, in the "Gist description" field, type a description for your gist. +1. In the "Filename including extension" field, type a file name for your gist, including the file extensions. +1. In the file contents field, type the text of your gist. +1. Optionally, to create {% ifversion ghae %}an internal{% else %}a public{% endif %} gist, click {% octicon "triangle-down" aria-label="The downwards triangle icon" %}, then click **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. ![Screenshot of the visibility dropdown menu for a new gist. Next to a button labeled "Create secret gist", a dropdown icon is outlined in dark orange.]{% ifversion ghae %}(/assets/images/help/gist/gist-visibility-drop-down-ae.png){% else %}(/assets/images/help/gist/gist-visibility-drop-down.png){% endif %} -7. Click **Create secret Gist** or **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. +1. Click **Create secret Gist** or **Create {% ifversion ghae %}internal{% else %}public{% endif %} gist**. diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index 27c1aea4c4cd..ff3f1c631246 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -200,8 +200,8 @@ To order your list, precede each line with a number. ```markdown 1. James Madison -2. James Monroe -3. John Quincy Adams +1. James Monroe +1. John Quincy Adams ``` ![Screenshot of rendered GitHub Markdown showing a numbered list of the names of the fourth, fifth, and sixth American presidents.](/assets/images/help/writing/ordered-list-rendered.png) diff --git a/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md b/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md index 8a4784f37036..7d8f76bba5a8 100644 --- a/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md +++ b/content/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md @@ -14,7 +14,7 @@ versions: {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.saved_replies %} 1. Under "Add a saved reply", add a title for your saved reply. -2. In the "Write" field, add the content you'd like to use for the saved reply. For information on using Markdown, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." +1. In the "Write" field, add the content you'd like to use for the saved reply. For information on using Markdown, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." ![Screenshot of a {% data variables.product.prodname_dotcom %} saved reply titled "Squirrel ship" showing Markdown in the "Write" box. The text reads, "This looks great. :shipit: it!"](/assets/images/help/writing/saved-replies-settings-adding.png) 1. To review your reply, click **Preview**. ![Screenshot of a GitHub saved reply titled "Squirrel ship" showing rendered Markdown in the "Preview" box. The text reads, "This looks great. :shipit: it!"](/assets/images/help/writing/saved-replies-preview.png) diff --git a/content/get-started/writing-on-github/working-with-saved-replies/deleting-a-saved-reply.md b/content/get-started/writing-on-github/working-with-saved-replies/deleting-a-saved-reply.md index 89d91ef35581..1873b08c794b 100644 --- a/content/get-started/writing-on-github/working-with-saved-replies/deleting-a-saved-reply.md +++ b/content/get-started/writing-on-github/working-with-saved-replies/deleting-a-saved-reply.md @@ -13,5 +13,5 @@ versions: --- {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.saved_replies %} -3. Under "Saved replies", next to the saved reply you want to delete, click {% octicon "x" aria-label="The X" %}. +1. Under "Saved replies", next to the saved reply you want to delete, click {% octicon "x" aria-label="The X" %}. ![Screenshot of {% data variables.product.prodname_dotcom %} settings for "Saved replies." To the right of the saved reply "Ship squirrel," a delete button with a red X is outlined in dark orange.](/assets/images/help/writing/saved-replies-delete-existing.png) diff --git a/content/get-started/writing-on-github/working-with-saved-replies/editing-a-saved-reply.md b/content/get-started/writing-on-github/working-with-saved-replies/editing-a-saved-reply.md index fa3f01fe948d..925bb506e6f8 100644 --- a/content/get-started/writing-on-github/working-with-saved-replies/editing-a-saved-reply.md +++ b/content/get-started/writing-on-github/working-with-saved-replies/editing-a-saved-reply.md @@ -14,10 +14,10 @@ versions: --- {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.saved_replies %} -3. Under "Saved replies," next to the saved reply you want to edit, click {% octicon "pencil" aria-label="The pencil" %}. +1. Under "Saved replies," next to the saved reply you want to edit, click {% octicon "pencil" aria-label="The pencil" %}. ![Screenshot of {% data variables.product.prodname_dotcom %} settings for "Saved replies." To the right of the saved reply "Ship squirrel," an edit button with a pencil icon is outlined in dark orange.](/assets/images/help/writing/saved-replies-edit-existing.png) 1. Under "Edit saved reply," edit the title or content of the saved reply. -2. Click **Update saved reply**. +1. Click **Update saved reply**. ## Further reading diff --git a/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md b/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md index 962cc905697b..b096e5161066 100644 --- a/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md +++ b/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md @@ -13,11 +13,11 @@ versions: --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} -2. Click the desired issue or pull request. -3. To add a saved reply, above the comment field, select {% octicon "reply" aria-label="The mail reply" %}. +1. Click the desired issue or pull request. +1. To add a saved reply, above the comment field, select {% octicon "reply" aria-label="The mail reply" %}. ![Screenshot of a {% data variables.product.prodname_dotcom %} comment box. On the toolbar, a reply button with a left-facing curved arrow is outlined in dark orange.](/assets/images/help/writing/saved-replies-button.png) -4. From the list, select the saved reply you'd like to add to your comment. Optionally, edit the content of the saved reply. -5. Select **Comment** to add your comment. +1. From the list, select the saved reply you'd like to add to your comment. Optionally, edit the content of the saved reply. +1. Select **Comment** to add your comment. {% tip %} diff --git a/content/graphql/guides/forming-calls-with-graphql.md b/content/graphql/guides/forming-calls-with-graphql.md index 3247dfe62207..2808dff8b567 100644 --- a/content/graphql/guides/forming-calls-with-graphql.md +++ b/content/graphql/guides/forming-calls-with-graphql.md @@ -89,8 +89,8 @@ For a real-world example, see "[Example query](#example-query)." To form a mutation, you must specify three things: 1. _Mutation name_. The type of modification you want to perform. -2. _Input object_. The data you want to send to the server, composed of _input fields_. Pass it as an argument to the mutation name. -3. _Payload object_. The data you want to return from the server, composed of _return fields_. Pass it as the body of the mutation name. +1. _Input object_. The data you want to send to the server, composed of _input fields_. Pass it as an argument to the mutation name. +1. _Payload object_. The data you want to return from the server, composed of _return fields_. Pass it as the body of the mutation name. Mutations are structured like this: @@ -146,7 +146,7 @@ There are three steps to using variables: The object must be valid JSON. This example shows a simple `Int` variable type, but it's possible to define more complex variable types, such as input objects. You can also define multiple variables here. -2. Pass the variable to the operation as an argument: +1. Pass the variable to the operation as an argument: ```graphql query($number_of_repos:Int!){ @@ -154,7 +154,7 @@ There are three steps to using variables: The argument is a key-value pair, where the key is the _name_ starting with `$` (e.g., `$number_of_repos`), and the value is the _type_ (e.g., `Int`). Add a `!` to indicate whether the type is required. If you've defined multiple variables, include them here as multiple arguments. -3. Use the variable within the operation: +1. Use the variable within the operation: ```graphql repositories(last: $number_of_repos) { @@ -247,7 +247,7 @@ You may notice that running this query on the Octocat's {% ifversion not ghae %} Mutations often require information that you can only find out by performing a query first. This example shows two operations: 1. A query to get an issue ID. -2. A mutation to add an emoji reaction to the issue. +1. A mutation to add an emoji reaction to the issue. ```graphql query FindIssueID { diff --git a/content/graphql/guides/managing-enterprise-accounts.md b/content/graphql/guides/managing-enterprise-accounts.md index 5fa0b104b5b5..e86392b5c290 100644 --- a/content/graphql/guides/managing-enterprise-accounts.md +++ b/content/graphql/guides/managing-enterprise-accounts.md @@ -51,7 +51,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A 1. To authenticate with GraphQL, you need to generate a {% data variables.product.pat_generic %} from developer settings. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." -2. Grant admin and full control permissions to your {% data variables.product.pat_generic %} for areas of your enterprise you'd like to access. For full permission to private repositories, organizations, teams, user data, and access to enterprise billing and profile data, we recommend you select these scopes for your {% data variables.product.pat_generic %}: +1. Grant admin and full control permissions to your {% data variables.product.pat_generic %} for areas of your enterprise you'd like to access. For full permission to private repositories, organizations, teams, user data, and access to enterprise billing and profile data, we recommend you select these scopes for your {% data variables.product.pat_generic %}: - `repo` - `admin:org` - `user` @@ -63,7 +63,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A - `manage_runners:enterprise`: Access to manage GitHub Actions enterprise runners and runner-groups.{% endif %} - `read:enterprise`: Read enterprise profile data. -3. Copy your {% data variables.product.pat_generic %} and keep it in a secure place until you add it to your GraphQL client. +1. Copy your {% data variables.product.pat_generic %} and keep it in a secure place until you add it to your GraphQL client. ### 2. Choose a GraphQL client diff --git a/content/graphql/guides/using-global-node-ids.md b/content/graphql/guides/using-global-node-ids.md index 0ad4020d7b54..b42ac7954e72 100644 --- a/content/graphql/guides/using-global-node-ids.md +++ b/content/graphql/guides/using-global-node-ids.md @@ -25,8 +25,8 @@ You can access most objects in GitHub (users, issues, pull requests, etc.) using You can follow three steps to use global node IDs effectively: 1. Call a REST endpoint that returns an object's `node_id`. -2. Find the object's type in GraphQL. -3. Use the ID and type to do a direct node lookup in GraphQL. +1. Find the object's type in GraphQL. +1. Use the ID and type to do a direct node lookup in GraphQL. Let's walk through an example. diff --git a/content/graphql/guides/using-the-explorer.md b/content/graphql/guides/using-the-explorer.md index 17790650ccdd..ad68ac163428 100644 --- a/content/graphql/guides/using-the-explorer.md +++ b/content/graphql/guides/using-the-explorer.md @@ -31,15 +31,15 @@ There are many open source GraphQL client IDEs. For example, you can use Altair ### Configuring Altair 1. Get an [access token](/graphql/guides/forming-calls-with-graphql#authenticating-with-graphql). -2. Launch Altair. -3. In the left sidebar, below the Altair logo, click **Set Headers**. A new window will open. -4. In the "Header key" field, enter `Authorization`. -5. In the "Header value" field, enter `Bearer TOKEN`, replacing `TOKEN` with your token from the first step. -6. Click **Save** in the bottom right corner of the window to save your authorization header. -8. In the "GraphQL Endpoint" field, enter `{% data variables.product.graphql_url_pre %}`. -9. To load the {% data variables.product.company_short %} GraphQL schema, download the [public schema](/graphql/overview/public-schema). -10. In Altair, click on **Docs** on the top right, then the three dots and **Load Schema...** -11. Select the file public schema that you downloaded in an earlier step. +1. Launch Altair. +1. In the left sidebar, below the Altair logo, click **Set Headers**. A new window will open. +1. In the "Header key" field, enter `Authorization`. +1. In the "Header value" field, enter `Bearer TOKEN`, replacing `TOKEN` with your token from the first step. +1. Click **Save** in the bottom right corner of the window to save your authorization header. +1. In the "GraphQL Endpoint" field, enter `{% data variables.product.graphql_url_pre %}`. +1. To load the {% data variables.product.company_short %} GraphQL schema, download the [public schema](/graphql/overview/public-schema). +1. In Altair, click on **Docs** on the top right, then the three dots and **Load Schema...** +1. Select the file public schema that you downloaded in an earlier step. {% note %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md index 65b23155b4ad..10cf8f57483c 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md @@ -19,9 +19,9 @@ When you close a {% data variables.projects.projects_v1_board %}, any configured If you reopen a {% data variables.projects.projects_v1_board %}, you have the option to _sync_ automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board)" or "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards)." 1. Navigate to the list of {% data variables.projects.projects_v1_boards %} in your repository or organization, or owned by your personal account. -2. In the projects list, next to the {% data variables.projects.projects_v1_board %} you want to close, click {% octicon "kebab-horizontal" aria-label="Project menu" %}. +1. In the projects list, next to the {% data variables.projects.projects_v1_board %} you want to close, click {% octicon "kebab-horizontal" aria-label="Project menu" %}. ![Screenshot showing the projects index. The project menu icon is highlighted with an orange rectangle.](/assets/images/help/projects/project-list-action-chevron.png) -3. Click **Close**. +1. Click **Close**. ## Further reading diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md index df95ddfb7942..e0ed67844db6 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards.md @@ -31,12 +31,12 @@ allowTitleToDifferFromFilename: true {% endtip %} 1. Navigate to the {% data variables.projects.projects_v1_board %} you want to automate. -2. In the column you want to automate, click {% octicon "kebab-horizontal" aria-label="Column menu" %}. +1. In the column you want to automate, click {% octicon "kebab-horizontal" aria-label="Column menu" %}. ![Screenshot showing a column in a project. The menu icon is highlighted with an orange outline.](/assets/images/help/projects/edit-column-button.png) -3. Click **Manage automation**. -4. Using the Preset drop-down menu, select an automation preset. -5. Select the workflow automations you want to configure for the column. -6. Click **Update automation**. +1. Click **Manage automation**. +1. Using the Preset drop-down menu, select an automation preset. +1. Select the workflow automations you want to configure for the column. +1. Click **Update automation**. ## Further reading diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md index 3a6da31fcd45..7a460d923bc0 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md @@ -24,11 +24,11 @@ A {% data variables.projects.projects_v1_board %}'s automation is also enabled b 1. Navigate to the {% data variables.projects.projects_v1_board %} you want to copy. {% data reusables.project-management.click-menu %} -3. Click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Copy**. +1. Click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Copy**. ![Screenshot showing a project menu. The copy option is highlighted with an orange outline.](/assets/images/help/projects/project-board-copy-setting.png) -4. Under "Owner", use the drop-down menu and click the repository or organization where you want to copy the project board. -5. Optionally, under "Project board name", type the name of the copied {% data variables.projects.projects_v1_board %}. -6. Optionally, under "Description", type a description of the copied project board that other people will see. -7. Optionally, under "Automation settings", select whether you want to copy the configured automatic workflows. This option is enabled by default. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards)." +1. Under "Owner", use the drop-down menu and click the repository or organization where you want to copy the project board. +1. Optionally, under "Project board name", type the name of the copied {% data variables.projects.projects_v1_board %}. +1. Optionally, under "Description", type a description of the copied project board that other people will see. +1. Optionally, under "Automation settings", select whether you want to copy the configured automatic workflows. This option is enabled by default. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards)." {% data reusables.project-management.choose-visibility %} -9. Click **Copy project**. +1. Click **Copy project**. diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md index 7eb8d0791624..1151029eb7e4 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board.md @@ -93,7 +93,7 @@ You can also configure workflow automations to keep your {% data variables.proje {% data reusables.projects.classic-project-creation %} {% data reusables.repositories.navigate-to-repo %} -2. Under your repository name, click {% octicon "project" aria-hidden="true" %} **Projects**.{% ifversion projects-v2 %} +1. Under your repository name, click {% octicon "project" aria-hidden="true" %} **Projects**.{% ifversion projects-v2 %} 1. Click **Projects (classic)**{% endif %} {% data reusables.project-management.click-new-project %} {% data reusables.project-management.create-project-name-description %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md index 706e4481bd5a..4dd563353b58 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md @@ -23,8 +23,8 @@ allowTitleToDifferFromFilename: true 1. Navigate to the {% data variables.projects.projects_v1_board %} you want to delete. {% data reusables.project-management.click-menu %} {% data reusables.project-management.click-edit-sidebar-menu-project-board %} -4. Click **Delete project**. -5. To confirm that you want to delete the project board, click **OK**. +1. Click **Delete project**. +1. To confirm that you want to delete the project board, click **OK**. ## Further reading diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md index c18f26bbc085..181d5b03beb7 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/editing-a-project-board.md @@ -24,7 +24,7 @@ allowTitleToDifferFromFilename: true 1. Navigate to the {% data variables.projects.projects_v1_board %} you want to edit. {% data reusables.project-management.click-menu %} {% data reusables.project-management.click-edit-sidebar-menu-project-board %} -4. Modify the {% data variables.projects.projects_v1_board %} name and description as needed, then click **Save project**. +1. Modify the {% data variables.projects.projects_v1_board %} name and description as needed, then click **Save project**. ## Further reading diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md index 31167ad247c2..ffc5764be39f 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board.md @@ -21,10 +21,10 @@ Anyone with write permissions to a {% data variables.projects.projects_v1_board 1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to link a repository. {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} -4. In the left sidebar, click **Linked repositories**. -5. Click **Link a repository**. -6. Search for the repository you'd like to link. -7. Click **Link**. To unlink, click **Unlink**. +1. In the left sidebar, click **Linked repositories**. +1. Click **Link a repository**. +1. Search for the repository you'd like to link. +1. Click **Link**. To unlink, click **Unlink**. {% note %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md index 917442c596a3..9cf1981d984b 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md @@ -20,7 +20,7 @@ When you reopen a {% data variables.projects.projects_v1_board %}, you have the 1. Navigate to the {% data variables.projects.projects_v1_board %} you want to reopen. {% data reusables.project-management.click-menu %} -3. Choose whether to sync automation for your {% data variables.projects.projects_v1_board %} or reopen your {% data variables.projects.projects_v1_board %} without syncing. +1. Choose whether to sync automation for your {% data variables.projects.projects_v1_board %} or reopen your {% data variables.projects.projects_v1_board %} without syncing. - To reopen your {% data variables.projects.projects_v1_board %} and sync automation, click **Reopen and sync project**. - To reopen your {% data variables.projects.projects_v1_board %} without syncing automation, using the reopen drop-down menu, click **Reopen only**. Then, click **Reopen only**. diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md index 746513f3fe11..97f94fda6436 100644 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md @@ -35,9 +35,9 @@ You can put a maximum of 2,500 cards into each project column. If a column has r ## Adding issues and pull requests to a {% data variables.projects.projects_v1_board %} 1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to add issues and pull requests. -2. In your {% data variables.projects.projects_v1_board %}, click {% octicon "plus" aria-hidden="true" %} **Add cards**. +1. In your {% data variables.projects.projects_v1_board %}, click {% octicon "plus" aria-hidden="true" %} **Add cards**. ![Screenshot showing the header of a project. The "Add cards" button is highlighted with an orange outline.](/assets/images/help/projects/add-cards-button.png) -3. Search for issues and pull requests to add to your {% data variables.projects.projects_v1_board %} using search qualifiers such as `is:issue is:open`. For more information on search qualifiers you can use, see "[AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests)." +1. Search for issues and pull requests to add to your {% data variables.projects.projects_v1_board %} using search qualifiers such as `is:issue is:open`. For more information on search qualifiers you can use, see "[AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests)." {% tip %} @@ -46,7 +46,7 @@ You can put a maximum of 2,500 cards into each project column. If a column has r - If you're working on a specific feature, you can apply a label to each related issue or pull request for that feature, and then easily add cards to your {% data variables.projects.projects_v1_board %} by searching for the label name. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels)." {% endtip %} -4. From the filtered list of issues and pull requests, drag the card you'd like to add to your {% data variables.projects.projects_v1_board %} and drop it in the correct column. Alternatively, you can move cards using keyboard shortcuts. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} +1. From the filtered list of issues and pull requests, drag the card you'd like to add to your {% data variables.projects.projects_v1_board %} and drop it in the correct column. Alternatively, you can move cards using keyboard shortcuts. {% data reusables.project-management.for-more-info-project-keyboard-shortcuts %} {% tip %} @@ -60,10 +60,10 @@ You can put a maximum of 2,500 cards into each project column. If a column has r ![Screenshot showing an issue's sidebar. The "Projects" section header is highlighted with an orange outline.](/assets/images/help/projects-v2/issue-sidebar-projects.png) -2. Click the **Recent**, **Repository**, **User**, or **Organization** tab for the {% data variables.projects.projects_v1_board %} you would like to add to. -3. Type the name of the project in **Filter projects** field. -4. Select one or more {% data variables.projects.projects_v1_boards %} where you want to add the issue or pull request. -5. Click **Awaiting triage**{% octicon "triangle-down" aria-hidden="true" %}, then click the column where you want your issue or pull request. The card will move to the bottom of the {% data variables.projects.projects_v1_board %} column you select. +1. Click the **Recent**, **Repository**, **User**, or **Organization** tab for the {% data variables.projects.projects_v1_board %} you would like to add to. +1. Type the name of the project in **Filter projects** field. +1. Select one or more {% data variables.projects.projects_v1_boards %} where you want to add the issue or pull request. +1. Click **Awaiting triage**{% octicon "triangle-down" aria-hidden="true" %}, then click the column where you want your issue or pull request. The card will move to the bottom of the {% data variables.projects.projects_v1_board %} column you select. ![Screenshot showing the projects section in an issue's sidebar. The awaiting triage option is highlighted with an orange outline.](/assets/images/help/projects/sidebar-select-project-board-column-menu.png) ## Further reading diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md index e15bea631f19..0c3997d9543e 100644 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board.md @@ -29,9 +29,9 @@ When you add a URL for an issue, pull request, or another {% data variables.proj ## Adding notes to a {% data variables.projects.projects_v1_board %} 1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to add notes. -2. In the column you want to add a note to, click {% octicon "plus" aria-label="Add a note to this column" %}. +1. In the column you want to add a note to, click {% octicon "plus" aria-label="Add a note to this column" %}. ![Screenshot showing a project column. The 'add a note to this column' button is highlighted with an orange outline.](/assets/images/help/projects/add-note-button.png) -3. Type your note, then click **Add**. +1. Type your note, then click **Add**. {% tip %} @@ -53,18 +53,18 @@ When you convert a note to an issue, the issue is automatically created using th 1. Navigate to the note that you want to convert to an issue. {% data reusables.project-management.project-note-more-options %} -3. Click **Convert to issue**. -4. If the card is on an organization-wide {% data variables.projects.projects_v1_board %}, in the drop-down menu, choose the repository you want to add the issue to. -5. Optionally, edit the pre-filled issue title, and type an issue body. -6. Click **Convert to issue**. -7. The note is automatically converted to an issue. In the {% data variables.projects.projects_v1_board %}, the new issue card will be in the same location as the previous note. +1. Click **Convert to issue**. +1. If the card is on an organization-wide {% data variables.projects.projects_v1_board %}, in the drop-down menu, choose the repository you want to add the issue to. +1. Optionally, edit the pre-filled issue title, and type an issue body. +1. Click **Convert to issue**. +1. The note is automatically converted to an issue. In the {% data variables.projects.projects_v1_board %}, the new issue card will be in the same location as the previous note. ## Editing and removing a note 1. Navigate to the note that you want to edit or remove. {% data reusables.project-management.project-note-more-options %} -3. To edit the contents of the note, click **Edit note**. -4. To delete the contents of the notes, click **Delete note**. +1. To edit the contents of the note, click **Edit note**. +1. To delete the contents of the notes, click **Delete note**. ## Further reading diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md index 8a96a2bd8532..38d90227060b 100644 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/archiving-cards-on-a-project-board.md @@ -20,11 +20,11 @@ Automation in your {% data variables.projects.projects_v1_board %} does not appl 1. In a {% data variables.projects.projects_v1_board %}, find the card you want to archive, then click {% octicon "kebab-horizontal" aria-label="Card menu" %}. ![Screenshot showing a card on a project. The card menu icon is highlighted with an orange outline.](/assets/images/help/projects/select-archiving-options-project-board-card.png) -2. Click **Archive**. +1. Click **Archive**. ## Restoring cards on a {% data variables.projects.projects_v1_board %} from the sidebar {% data reusables.project-management.click-menu %} -2. Click {% octicon "kebab-horizontal" aria-label="Project menu" %}, then click **View archive**. +1. Click {% octicon "kebab-horizontal" aria-label="Project menu" %}, then click **View archive**. ![Screenshot showing the project menu. The "View archive" option is highlighted with an orange outline.](/assets/images/help/projects/select-view-archive-option-project-board-card.png) -3. Above the {% data variables.projects.projects_v1_board %} card you want to unarchive, click **Restore**. +1. Above the {% data variables.projects.projects_v1_board %} card you want to unarchive, click **Restore**. diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md index 106c887fbc69..cfd7ef1a0bb1 100644 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md @@ -31,7 +31,7 @@ You can also use the "Filter cards" search bar at the top of each {% data variab - Filter cards by repository in an organization-wide {% data variables.projects.projects_v1_board %} using `repo:ORGANIZATION/REPOSITORY` 1. Navigate to the {% data variables.projects.projects_v1_board %} that contains the cards you want to filter. -2. Above the project card columns, click into the "Filter cards" search bar and type a search query to filter the cards. +1. Above the project card columns, click into the "Filter cards" search bar and type a search query to filter the cards. {% tip %} diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md index 673a8b13e634..91bd22fbc6d4 100644 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/tracking-progress-on-your-project-board.md @@ -19,4 +19,4 @@ allowTitleToDifferFromFilename: true 1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to enable or disable project progress tracking. {% data reusables.project-management.click-menu %} {% data reusables.project-management.click-edit-sidebar-menu-project-board %} -4. Select or deselect **Track project progress**. +1. Select or deselect **Track project progress**. diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md index a4889335da06..a8e4e4f437eb 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions.md @@ -39,7 +39,7 @@ You may also want to use the **actions/add-to-project** workflow, which is maint For more information about authenticating in a {% data variables.product.prodname_actions %} workflow with a {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/creating-github-apps/guides/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow)." 1. Create a {% data variables.product.prodname_github_app %} or choose an existing {% data variables.product.prodname_github_app %} owned by your organization. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app)." -2. Give your {% data variables.product.prodname_github_app %} read and write permissions to organization projects. For this specific example, your {% data variables.product.prodname_github_app %} will also need read permissions to repository pull requests and repository issues. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/editing-a-github-apps-permissions)." +1. Give your {% data variables.product.prodname_github_app %} read and write permissions to organization projects. For this specific example, your {% data variables.product.prodname_github_app %} will also need read permissions to repository pull requests and repository issues. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/editing-a-github-apps-permissions)." {% note %} @@ -47,10 +47,10 @@ For more information about authenticating in a {% data variables.product.prodnam {% endnote %} -3. Install the {% data variables.product.prodname_github_app %} in your organization. Install it for all repositories that your project needs to access. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps#installing-your-private-github-app-on-your-repository)." -4. Store your {% data variables.product.prodname_github_app %}'s ID as a secret in your repository or organization. In the following workflow, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[AUTOTITLE](/rest/apps#get-an-app)." -5. Generate a private key for your app. Store the contents of the resulting file as a secret in your repository or organization. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following workflow, replace `APP_PEM` with the name of the secret. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)." -6. In the following workflow, replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. In order for this specific example to work, your project must also have a "Date posted" date field. +1. Install the {% data variables.product.prodname_github_app %} in your organization. Install it for all repositories that your project needs to access. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps#installing-your-private-github-app-on-your-repository)." +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret in your repository or organization. In the following workflow, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[AUTOTITLE](/rest/apps#get-an-app)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret in your repository or organization. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following workflow, replace `APP_PEM` with the name of the secret. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)." +1. In the following workflow, replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 1. In order for this specific example to work, your project must also have a "Date posted" date field. ```yaml annotate copy {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -193,8 +193,8 @@ jobs: ## Example workflow authenticating with a {% data variables.product.pat_generic %} 1. Create a {% data variables.product.pat_v1 %} with the `project` and `repo` scopes. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." -2. Save the {% data variables.product.pat_generic %} as a secret in your repository or organization. -3. In the following workflow, replace `YOUR_TOKEN` with the name of the secret. Replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. +1. Save the {% data variables.product.pat_generic %} as a secret in your repository or organization. +1. In the following workflow, replace `YOUR_TOKEN` with the name of the secret. Replace `YOUR_ORGANIZATION` with the name of your organization. For example, `octo-org`. Replace `YOUR_PROJECT_NUMBER` with your project number. To find the project number, look at the project URL. For example, `https://github.com/orgs/octo-org/projects/5` has a project number of 5. ```yaml annotate copy # This workflow runs whenever a pull request in the repository is marked as "ready for review". diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md index b118b84f08b1..d4617cdd9c90 100644 --- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md +++ b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md @@ -41,7 +41,7 @@ You can change the order of fields. ![Screenshot showing three field headers. One of the headers is highlighted with an orange outline.](/assets/images/help/projects-v2/select-field-header.png) -2. While continuing to click, drag the field to the required location. +1. While continuing to click, drag the field to the required location. ## Reordering rows @@ -51,7 +51,7 @@ You can change the order of rows. ![Screenshot showing three rows on a table layout. One of the row numbers is highlighted with an orange outline.](/assets/images/help/projects-v2/select-row-number.png) -2. While continuing to click, drag the row to the required location. +1. While continuing to click, drag the row to the required location. ## Sorting by field values diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md index b08073c1a747..c170cc3d8651 100644 --- a/content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md +++ b/content/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects.md @@ -59,8 +59,8 @@ Next, create an iteration field so you can plan and track your work over repeati {% data reusables.projects.new-field %} 1. Select **Iteration** -3. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**. -4. Click **Save**. +1. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**. +1. Click **Save**. ## Creating a field to track priority @@ -87,7 +87,7 @@ Next, group all of the items in your project by priority to make it easier to fo Now, move issues between groups to change their priority. 1. Choose an issue. -2. Drag and drop the issue into a different priority group. When you do this, the priority of the issue will change to be the priority of its new group. +1. Drag and drop the issue into a different priority group. When you do this, the priority of the issue will change to be the priority of its new group. ## Saving the priority view diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md index ae29e27a7b11..9e1b83e1a316 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md +++ b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md @@ -57,9 +57,9 @@ You can copy the URL of an issue or pull request into your clipboard and paste t If you know the issue or pull request number or if you know part of the title, you can search for an issue or pull request directly from your project. {% data reusables.projects.add-item-bottom-row %} -2. To open the list of repositories, type #. -3. Select the repository where the pull request or issue is located. You can type part of the repository name to narrow down your options. -4. Select the issue or pull request. You can type part of the title to narrow down your options. +1. To open the list of repositories, type #. +1. Select the repository where the pull request or issue is located. You can type part of the repository name to narrow down your options. +1. Select the issue or pull request. You can type part of the title to narrow down your options. ### Bulk adding issues and pull requests @@ -92,10 +92,10 @@ You can also add issues and pull requests to your project from a repository's is You can also add an issue or pull request to your project from within the issue or pull request itself. 1. Navigate to the issue or pull request that you want to add to a project. -2. In the side bar, click **Projects**. +1. In the side bar, click **Projects**. ![Screenshot showing an issue's sidebar. "Projects" is highlighted with an orange outline.](/assets/images/help/projects-v2/issue-sidebar-projects.png) -3. Select the project that you want to add the issue or pull request to. -4. Optionally, populate the custom fields. +1. Select the project that you want to add the issue or pull request to. +1. Optionally, populate the custom fields. ### Using the command palette to add an issue or pull request diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md index 254ecd877712..dbf56f8bf8ef 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md +++ b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/converting-draft-issues-to-issues.md @@ -15,8 +15,8 @@ topics: ![Screenshot of items in the table layout. The item context button is highlighted with an orange outline.](/assets/images/help/projects-v2/item-context-menu-button-table.png) -2. Select **Convert to issue**. -3. Select the repository that you want to add the issue to. +1. Select **Convert to issue**. +1. Select the repository that you want to add the issue to. ## Converting draft issues in board layout @@ -24,8 +24,8 @@ topics: ![Screenshot showing a draft issue. The item menu is highlighted with an orange outline.](/assets/images/help/projects-v2/item-context-menu-button-board.png) -2. Select **Convert to issue**. -3. Select the repository that you want to add the issue to. +1. Select **Convert to issue**. +1. Select the repository that you want to add the issue to. ## Further reading diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md index 3b5a9629ba91..49dac203d761 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md @@ -41,7 +41,7 @@ The default base role is `write`, meaning that everyone in the organization can {% data reusables.projects.project-settings %} 1. Click **Manage access**. -2. Under **Base role**, select the default role. +1. Under **Base role**, select the default role. ![Screenshot showing the "Who has access" settings. The dropdown for setting the base role is highlighted with an orange outline.](/assets/images/help/projects-v2/base-role.png) @@ -64,15 +64,15 @@ You can only invite an individual user to collaborate on your organization-level {% data reusables.projects.project-settings %} 1. Click **Manage access**. -2. Under **Invite collaborators**, search for the team or individual user that you want to invite. +1. Under **Invite collaborators**, search for the team or individual user that you want to invite. ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) -3. Select the role for the collaborator. +1. Select the role for the collaborator. - **Read**: The team or individual can view the project. - **Write**: The team or individual can view and edit the project. - **Admin**: The team or individual can view, edit, and add new collaborators to the project. -4. Click **Invite**. +1. Click **Invite**. ### Managing access of an existing collaborator on your project @@ -99,15 +99,15 @@ This only affects collaborators for your project, not for repositories in your p {% data reusables.projects.project-settings %} 1. Click **Manage access**. -2. Under **Invite collaborators**, search for the user that you want to invite. +1. Under **Invite collaborators**, search for the user that you want to invite. ![Screenshot showing searching for a collaborator.](/assets/images/help/projects-v2/access-search.png) -3. Select the role for the collaborator. +1. Select the role for the collaborator. - **Read**: The individual can view the project. - **Write**: The individual can view and edit the project. - **Admin**: The individual can view, edit, and add new collaborators to the project. -4. Click **Invite**. +1. Click **Invite**. ### Managing access of an existing collaborator on your project diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md index 3f601f31590d..1a8f0f62f98e 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields.md @@ -28,9 +28,9 @@ If your project makes use of iteration fields, you can use the roadmap layout to {% data reusables.projects.new-field %} 1. Under "Field type", select **Iteration**. -2. Optionally, if you don't want the iteration to start today, select the calendar dropdown next to "Starts on" and choose a new start date. -3. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**. -4. Click **Save**. +1. Optionally, if you don't want the iteration to start today, select the calendar dropdown next to "Starts on" and choose a new start date. +1. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**. +1. Click **Save**. Alternatively, open the project command palette by pressing {% data variables.projects.command-palette-shortcut %} and start typing "Create new field." @@ -55,7 +55,7 @@ You can edit iterations in your project settings. You can also access the settin 1. To change the date or duration of an iteration, click on the date to open the calendar. Click on the start day, then click the end day, and then click **Apply**. ![Screenshot of a single iteration's settings. The iteration date span is highlighted with an orange outline.](/assets/images/help/projects-v2/iteration-date.png) 1. Optionally, to delete an iteration, on the right of the iteration, click {% octicon "trash" aria-label="Remove item" %}. -2. Click **Save changes**. +1. Click **Save changes**. ## Inserting a break @@ -63,8 +63,8 @@ You can insert breaks into your iterations to communicate when you are taking ti {% data reusables.projects.project-settings %} 1. Click the name of the iteration field you want to adjust. -2. Hover over the dividing line above an iteration, then click **Insert break**. +1. Hover over the dividing line above an iteration, then click **Insert break**. ![Screenshot of the list of iterations for a project. On the dividing line between two iterations, a button, labeled "Insert break," is outlined in dark orange.](/assets/images/help/issues/iteration-insert-break.png) -3. Optionally, to change the duration of the break, click on the date to open the calendar. Click on the start day, then click the end day, and then click **Apply**. -4. Click **Save changes**. +1. Optionally, to change the duration of the break, click on the date to open the calendar. Click on the start day, then click the end day, and then click **Apply**. +1. Click **Save changes**. diff --git a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md index acbb4fb12798..58788de6a3bd 100644 --- a/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md +++ b/content/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts.md @@ -13,7 +13,7 @@ topics: {% data reusables.projects.insights-release-note %} {% data reusables.projects.access-insights %} -3. In the menu on the left, click **New chart**. -4. Optionally, to change the name of the new chart, click {% octicon "triangle-down" aria-label="The triangle icon" %}, type a new name, and press Return. -5. Above the chart, type filters to change the data used to build the chart. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects)." -6. To the right of the filter text box, click **Save changes**. +1. In the menu on the left, click **New chart**. +1. Optionally, to change the name of the new chart, click {% octicon "triangle-down" aria-label="The triangle icon" %}, type a new name, and press Return. +1. Above the chart, type filters to change the data used to build the chart. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects)." +1. To the right of the filter text box, click **Save changes**. diff --git a/content/issues/tracking-your-work-with-issues/closing-an-issue.md b/content/issues/tracking-your-work-with-issues/closing-an-issue.md index 0c09cb104855..ffdfba06a5c6 100644 --- a/content/issues/tracking-your-work-with-issues/closing-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/closing-an-issue.md @@ -26,7 +26,7 @@ shortTitle: Close an issue 1. Optionally, to change your reason for closing the issue, next to "Close issue," select {% octicon "triangle-down" aria-label="Select close issue reason" %}, then click a reason. ![Screenshot of the buttons at the bottom of an issue. A button, labeled with a downward triangle icon indicating a dropdown menu, is outlined in dark orange.](/assets/images/help/issues/close-issue-select-reason.png) -2. Click **Close issue**. +1. Click **Close issue**. {%- else %} 1. At the bottom of the comment box, click **Close issue**. {% endif %} diff --git a/content/issues/tracking-your-work-with-issues/deleting-an-issue.md b/content/issues/tracking-your-work-with-issues/deleting-an-issue.md index ac6b98824adf..d8d1eb6478bd 100644 --- a/content/issues/tracking-your-work-with-issues/deleting-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/deleting-an-issue.md @@ -23,10 +23,10 @@ The ability to delete issues depends on whether the repository is owned by a per Collaborators do not receive a notification when issues are deleted. When visiting the URL of a deleted issue, collaborators will see a message stating that the web page can't be found (but they can use the API to determine that it was deleted). People with admin or owner permissions in the repository will additionally see the username of the person who deleted the issue and when it was deleted. 1. Navigate to the issue you want to delete. -2. On the right side bar, under "Notifications", click **{% octicon "trash" aria-hidden="true" %} Delete issue**. +1. On the right side bar, under "Notifications", click **{% octicon "trash" aria-hidden="true" %} Delete issue**. ![Screenshot of the issue sidebar. A trash can icon and "Delete issue" are outlined in dark orange.](/assets/images/help/issues/delete-issue.png) -4. To confirm deletion, click **Delete this issue**. +1. To confirm deletion, click **Delete this issue**. ## Further reading diff --git a/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md index 35e49dc09ca7..82fe55021822 100644 --- a/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md @@ -63,7 +63,7 @@ You can filter issues and pull requests to find: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} -3. Above the list, select the **Filters** dropdown menu, then click the type of filter you're interested in. +1. Above the list, select the **Filters** dropdown menu, then click the type of filter you're interested in. ![Screenshot of the list of issues for a repository. Above the list, a dropdown menu, labeled "Filters", is outlined in dark orange.](/assets/images/help/issues/issues_filter_dropdown.png) @@ -91,7 +91,7 @@ Once you've [applied labels to an issue or pull request](/issues/using-labels-an {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.labels %} -4. In the list of labels, click a label. +1. In the list of labels, click a label. {% tip %} diff --git a/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md b/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md index 1ea648fbfa86..91209f30407e 100644 --- a/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md @@ -68,13 +68,13 @@ You can manually link up to ten issues to each pull request. The issue and pull {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %} -3. In the list of pull requests, click the pull request that you'd like to link to an issue. +1. In the list of pull requests, click the pull request that you'd like to link to an issue. {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} {% data reusables.pull_requests.click-development %} {% else %} -4. In the right sidebar, click **Linked issues**. +1. In the right sidebar, click **Linked issues**. {% endif %} -5. Click the issue you want to link to the pull request. +1. Click the issue you want to link to the pull request. {% ifversion link-existing-branches-to-issue %} diff --git a/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md b/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md index d6e33d8f4b27..66890851e4f4 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md +++ b/content/issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests.md @@ -21,12 +21,12 @@ type: how_to {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.milestones %} -4. Choose one of these options: +1. Choose one of these options: - To create a new milestone, click **New Milestone**. - To edit a milestone, next to the milestone you want to edit, click **Edit**. ![Screenshot of the list of milestones. Within the entry for the "beta release" milestone, a link, labeled "Edit," is outlined in dark orange.](/assets/images/help/repository/edit-milestone.png) -5. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. Milestones will render Markdown syntax. For more information about Markdown syntax, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." +1. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. Milestones will render Markdown syntax. For more information about Markdown syntax, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." ## Deleting milestones diff --git a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md index e19e88dd8035..e89ae789092a 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md +++ b/content/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone.md @@ -26,10 +26,10 @@ shortTitle: Filter by milestone {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} -3. Select **Milestones** to see a list of all available milestones for the repository. +1. Select **Milestones** to see a list of all available milestones for the repository. ![Screenshot of the list of issues for a repository. Above the list, a button, labeled with a signpost icon and "Milestones," is outlined in dark orange.](/assets/images/help/issues/issues_milestone_button.png) -4. Select the milestone you're interested in from the list. You can view relevant information for the milestone, including all issues and pull requests associated with it, from the milestone page. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones)." +1. Select the milestone you're interested in from the list. You can view relevant information for the milestone, including all issues and pull requests associated with it, from the milestone page. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones)." ## Further reading diff --git a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md index 4c6d311c007b..dee49d79b87f 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md @@ -66,7 +66,7 @@ Anyone with write access to a repository can create a label. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.project-management.labels %} -4. To the right of the search field, click **New label**. +1. To the right of the search field, click **New label**. {% data reusables.project-management.name-label %} {% data reusables.project-management.label-description %} {% data reusables.project-management.label-color-randomizer %} diff --git a/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md b/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md index 81e41d04fbbf..2413bbd54e9c 100644 --- a/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md +++ b/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md @@ -28,14 +28,14 @@ If you'd like to match the commits in your repository to the authors' GitHub per 1. In the upper-right corner of any page, click {% octicon "plus" aria-label="Create new..." %}, and then click **Import repository**. ![Screenshot of the top-right corner of any page on {% data variables.product.prodname_dotcom %}. A plus icon is highlighted with an orange outline.](/assets/images/help/importer/import-repository.png) -2. Under "Your old repository's clone URL", type the URL of the project you want to import. -3. Under "Owner", select the dropdown menu and click your personal account or an organization to own the repository +1. Under "Your old repository's clone URL", type the URL of the project you want to import. +1. Under "Owner", select the dropdown menu and click your personal account or an organization to own the repository 1. Under "Name", type a name for the repository on GitHub. -4. Under "Privacy", select a visibility for the repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." -5. Review the information you entered, then click **Begin import**. -6. If your old project requires credentials, type your login information for that project. If SAML SSO or 2FA are enabled for your user account on the old project, enter a {% data variables.product.pat_generic %} with repository read permissions in the "Password" field instead of your password. +1. Under "Privacy", select a visibility for the repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." +1. Review the information you entered, then click **Begin import**. +1. If your old project requires credentials, type your login information for that project. If SAML SSO or 2FA are enabled for your user account on the old project, enter a {% data variables.product.pat_generic %} with repository read permissions in the "Password" field instead of your password. 1. Click **Submit**. -7. If there are multiple projects hosted at your old project's clone URL, select the project you'd like to import, then click **Submit**. -8. If you're moving from a version control system other than Git and your project contains files larger than 100 MB, select whether to import the large files using [Git Large File Storage](/repositories/working-with-files/managing-large-files), then click **Continue**. +1. If there are multiple projects hosted at your old project's clone URL, select the project you'd like to import, then click **Submit**. +1. If you're moving from a version control system other than Git and your project contains files larger than 100 MB, select whether to import the large files using [Git Large File Storage](/repositories/working-with-files/managing-large-files), then click **Continue**. You'll receive an email when the repository has been completely imported. diff --git a/content/migrations/importing-source-code/using-github-importer/updating-commit-author-attribution-with-github-importer.md b/content/migrations/importing-source-code/using-github-importer/updating-commit-author-attribution-with-github-importer.md index ba1e01369916..4d500f368daf 100644 --- a/content/migrations/importing-source-code/using-github-importer/updating-commit-author-attribution-with-github-importer.md +++ b/content/migrations/importing-source-code/using-github-importer/updating-commit-author-attribution-with-github-importer.md @@ -16,8 +16,8 @@ GitHub Importer looks for GitHub users whose email addresses match the authors o ## Updating commit authors 1. After you've imported your repository, on the import status page, click **Match authors**. -2. Next to the author whose information you'd like to update, click **Connect**. -3. Type the email address or GitHub username of the author, then press **Enter**. +1. Next to the author whose information you'd like to update, click **Connect**. +1. Type the email address or GitHub username of the author, then press **Enter**. ## Attributing commits to a GitHub user with a public email address diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md index 5119f5a42fad..ae486ff3cd14 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md @@ -31,14 +31,14 @@ For purposes of demonstration, we'll use: {% endtip %} 1. [Create a new repository on {% data variables.product.product_name %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). You'll import your external Git repository to this new repository. -2. On the command line, make a "bare" clone of the external repository using the external clone URL. This creates a full copy of the data, but without a working directory for editing files, and ensures a clean, fresh export of all the old data. +1. On the command line, make a "bare" clone of the external repository using the external clone URL. This creates a full copy of the data, but without a working directory for editing files, and ensures a clean, fresh export of all the old data. ```shell $ git clone --bare https://external-host.com/EXTUSER/REPO.git # Makes a bare clone of the external repository in a local directory ``` -3. Push the locally cloned repository to {% data variables.product.product_name %} using the "mirror" option, which ensures that all references, such as branches and tags, are copied to the imported repository. +1. Push the locally cloned repository to {% data variables.product.product_name %} using the "mirror" option, which ensures that all references, such as branches and tags, are copied to the imported repository. ```shell $ cd REPO.git @@ -46,7 +46,7 @@ For purposes of demonstration, we'll use: # Pushes the mirror to the new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} ``` -4. Remove the temporary local repository. +1. Remove the temporary local repository. ```shell cd .. diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-from-other-version-control-systems-with-the-administrative-shell.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-from-other-version-control-systems-with-the-administrative-shell.md index d15eaab85cda..4114e70c0bd3 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-from-other-version-control-systems-with-the-administrative-shell.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-from-other-version-control-systems-with-the-administrative-shell.md @@ -19,7 +19,7 @@ permissions: Site administrators can use the administrative shell to import data ## Importing projects from Mercurial {% data reusables.enterprise_installation.ssh-into-instance %} -2. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: +1. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: ```shell $ git-import-hg-raw HG-CLONE-URL/PATH/REPO-NAME.git @@ -27,15 +27,15 @@ permissions: Site administrators can use the administrative shell to import data ``` {% data reusables.enterprise_migrations.review-the-import-csv %} -4. Rewrite the authors and branches using the CSV file: +1. Rewrite the authors and branches using the CSV file: ```shell git-import-rewrite --flavor hg --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO-NAME.git ``` -5. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). +1. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). {% data reusables.command_line.switching_directories_procedural %} -7. Push the imported repository to {% data variables.product.prodname_ghe_server %}: +1. Push the imported repository to {% data variables.product.prodname_ghe_server %}: ```shell git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE @@ -44,7 +44,7 @@ permissions: Site administrators can use the administrative shell to import data ## Importing projects from Subversion {% data reusables.enterprise_installation.ssh-into-instance %} -2. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: +1. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: ```shell $ git-import-svn-raw SVN-CLONE-URL /PATH/REPO-NAME.git @@ -52,15 +52,15 @@ permissions: Site administrators can use the administrative shell to import data ``` {% data reusables.enterprise_migrations.review-the-import-csv %} -4. Rewrite the authors and branches using the CSV file: +1. Rewrite the authors and branches using the CSV file: ```shell git-import-rewrite --flavor svn --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO-NAME.git ``` -5. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). +1. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). {% data reusables.command_line.switching_directories_procedural %} -7. Push the imported repository to {% data variables.product.prodname_ghe_server %}: +1. Push the imported repository to {% data variables.product.prodname_ghe_server %}: ```shell git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE @@ -69,7 +69,7 @@ permissions: Site administrators can use the administrative shell to import data ## Importing projects from Team Foundation Version Control {% data reusables.enterprise_installation.ssh-into-instance %} -2. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: +1. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: ```shell $ git-import-tfs-raw TEAM-FOUNDATION-CLONE-URL /PATH/REPO-NAME.git @@ -77,15 +77,15 @@ permissions: Site administrators can use the administrative shell to import data ``` {% data reusables.enterprise_migrations.review-the-import-csv %} -4. Rewrite the authors and branches using the CSV file: +1. Rewrite the authors and branches using the CSV file: ```shell git-import-rewrite --flavor tfs --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO_NAME.git ``` -5. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). +1. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). {% data reusables.command_line.switching_directories_procedural %} -7. Push the imported repository to {% data variables.product.prodname_ghe_server %}: +1. Push the imported repository to {% data variables.product.prodname_ghe_server %}: ```shell git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE diff --git a/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md b/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md index e6b68a02526c..fee2d1e7a5f7 100644 --- a/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md +++ b/content/migrations/using-ghe-migrator/exporting-migration-data-from-github-enterprise-server.md @@ -27,7 +27,7 @@ shortTitle: Export from GHES 1. Verify that you are a site administrator on the {% data variables.product.prodname_ghe_server %} source. The best way to do this is to verify that you can [SSH into the instance]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh). -2. {% data reusables.enterprise_migrations.token-generation %} on the {% data variables.product.prodname_ghe_server %} source instance. +1. {% data reusables.enterprise_migrations.token-generation %} on the {% data variables.product.prodname_ghe_server %} source instance. {% data reusables.enterprise_migrations.make-a-list %} @@ -36,30 +36,33 @@ shortTitle: Export from GHES {% data reusables.enterprise_migrations.locking-repositories %} {% data reusables.enterprise_installation.ssh-into-instance %} -2. To prepare a repository for export, use the `ghe-migrator add` command with the repository's URL: +1. To prepare a repository for export, use the `ghe-migrator add` command with the repository's URL: *If you're locking the repository, append the command with `--lock`. If you're performing a trial run, `--lock` is not needed. + ```shell $ ghe-migrator add https://HOSTNAME/USERNAME/REPO-NAME --lock ``` + * You can exclude file attachments by appending `--exclude_attachments` to the command. {% data reusables.enterprise_migrations.exclude-file-attachments %} * To prepare multiple repositories at once for export, create a text file listing each repository URL on a separate line, and run the `ghe-migrator add` command with the `-i` flag and the path to your text file. + ```shell $ ghe-migrator add -i PATH/TO/YOUR/REPOSITORY_URL.txt ``` -3. When prompted, enter your {% data variables.product.prodname_ghe_server %} username: +1. When prompted, enter your {% data variables.product.prodname_ghe_server %} username: ```shell Enter username authorized for migration: admin ``` -4. When prompted for a {% data variables.product.pat_generic %}, enter the access token you created in "[Preparing the {% data variables.product.prodname_ghe_server %} source instance](#preparing-the-github-enterprise-server-source-instance)": +1. When prompted for a {% data variables.product.pat_generic %}, enter the access token you created in "[Preparing the {% data variables.product.prodname_ghe_server %} source instance](#preparing-the-github-enterprise-server-source-instance)": ```shell Enter {% data variables.product.pat_generic %}: ************** ``` -5. When `ghe-migrator add` has finished it will print the unique "Migration GUID" that it generated to identify this export as well as a list of the resources that were added to the export. You will use the Migration GUID that it generated in subsequent `ghe-migrator add` and `ghe-migrator export` steps to tell `ghe-migrator` to continue operating on the same export. +1. When `ghe-migrator add` has finished it will print the unique "Migration GUID" that it generated to identify this export as well as a list of the resources that were added to the export. You will use the Migration GUID that it generated in subsequent `ghe-migrator add` and `ghe-migrator export` steps to tell `ghe-migrator` to continue operating on the same export. ```shell > 101 models added to export @@ -85,13 +88,13 @@ shortTitle: Export from GHES Each time you add a new repository with an existing Migration GUID it will update the existing export. If you run `ghe-migrator add` again without a Migration GUID it will start a new export and generate a new Migration GUID. **Do not re-use the Migration GUID generated during an export when you start preparing your migration for import**. -6. To add more repositories to the same export, use the `ghe-migrator add` command with the `-g` flag. You'll pass in the new repository URL and the Migration GUID from Step 5: +1. To add more repositories to the same export, use the `ghe-migrator add` command with the `-g` flag. You'll pass in the new repository URL and the Migration GUID from Step 5: ```shell ghe-migrator add https://HOSTNAME/USERNAME/OTHER-REPO-NAME -g MIGRATION-GUID --lock ``` -7. When you've finished adding repositories, generate the migration archive using the `ghe-migrator export` command with the `-g` flag and the Migration GUID from Step 5: +1. When you've finished adding repositories, generate the migration archive using the `ghe-migrator export` command with the `-g` flag and the Migration GUID from Step 5: ```shell $ ghe-migrator export -g MIGRATION-GUID @@ -100,7 +103,7 @@ shortTitle: Export from GHES - {% data reusables.enterprise_migrations.specify-staging-path %} -8. Close the connection to {% data variables.location.product_location %}: +1. Close the connection to {% data variables.location.product_location %}: ```shell $ exit @@ -108,7 +111,7 @@ shortTitle: Export from GHES > Connection to HOSTNAME closed. ``` -9. Copy the migration archive to your computer using the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command. The archive file will be named with the Migration GUID: +1. Copy the migration archive to your computer using the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command. The archive file will be named with the Migration GUID: ```shell scp -P 122 admin@HOSTNAME:/data/github/current/tmp/MIGRATION-GUID.tar.gz ~/Desktop diff --git a/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md b/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md index 0e2951d7f072..53f00fe5eff0 100644 --- a/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md +++ b/content/migrations/using-ghe-migrator/exporting-migration-data-from-githubcom.md @@ -26,7 +26,7 @@ shortTitle: Export from GitHub.com 1. Ensure that you have [owner permissions](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization) on the source organization's repositories. -2. {% data reusables.enterprise_migrations.token-generation %} on {% data variables.product.prodname_dotcom_the_website %}. +1. {% data reusables.enterprise_migrations.token-generation %} on {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise_migrations.make-a-list %} @@ -44,7 +44,7 @@ The Migrations API is currently in a preview period, which means that the endpoi 1. Notify members of your organization that you'll be performing a migration. The export can take several minutes, depending on the number of repositories being exported. The full migration including import may take several hours so we recommend doing a trial run in order to determine how long the full process will take. For more information, see "[AUTOTITLE](/migrations/using-ghe-migrator/about-ghe-migrator#types-of-migrations)." -2. Start a migration by sending a `POST` request to [the migration endpoint](/free-pro-team@latest/rest/migrations#start-an-organization-migration). You'll need: +1. Start a migration by sending a `POST` request to [the migration endpoint](/free-pro-team@latest/rest/migrations#start-an-organization-migration). You'll need: - Your access token for authentication. - A [list of the repositories](/free-pro-team@latest/rest/repos#list-organization-repositories) you want to migrate: @@ -61,7 +61,7 @@ The Migrations API is currently in a preview period, which means that the endpoi This request returns a unique `id` which represents your migration. You'll need it for subsequent calls to the Migrations API. -3. Send a `GET` request to [the migration status endpoint](/free-pro-team@latest/rest/migrations#get-an-organization-migration-status) to fetch the status of a migration. You'll need: +1. Send a `GET` request to [the migration status endpoint](/free-pro-team@latest/rest/migrations#get-an-organization-migration-status) to fetch the status of a migration. You'll need: - Your access token for authentication. - The unique `id` of the migration: @@ -77,7 +77,7 @@ The Migrations API is currently in a preview period, which means that the endpoi *`exported`, which means the migration finished successfully. * `failed`, which means the migration failed. -4. After your migration has exported, download the migration archive by sending a `GET` request to [the migration download endpoint](/free-pro-team@latest/rest/migrations#download-an-organization-migration-archive). You'll need: +1. After your migration has exported, download the migration archive by sending a `GET` request to [the migration download endpoint](/free-pro-team@latest/rest/migrations#download-an-organization-migration-archive). You'll need: - Your access token for authentication. - The unique `id` of the migration: @@ -88,7 +88,7 @@ The Migrations API is currently in a preview period, which means that the endpoi https://api.github.com/orgs/ORG_NAME/migrations/ID/archive ``` -5. The migration archive is automatically deleted after seven days. If you would prefer to delete it sooner, you can send a `DELETE` request to [the migration archive delete endpoint](/free-pro-team@latest/rest/migrations#delete-an-organization-migration-archive). You'll need: +1. The migration archive is automatically deleted after seven days. If you would prefer to delete it sooner, you can send a `DELETE` request to [the migration archive delete endpoint](/free-pro-team@latest/rest/migrations#delete-an-organization-migration-archive). You'll need: - Your access token for authentication. - The unique `id` of the migration: diff --git a/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md b/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md index 28b3c8d93d1b..bb288f2d8b22 100644 --- a/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md +++ b/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md @@ -32,7 +32,7 @@ After you prepare the data and resolve conflicts, you can apply the imported dat {% data reusables.enterprise_installation.ssh-into-target-instance %} -2. Using the `ghe-migrator import` command, start the import process. You'll need: +1. Using the `ghe-migrator import` command, start the import process. You'll need: - Your Migration GUID. For more information, see "[AUTOTITLE](/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server)." - Your {% data variables.product.pat_generic %} for authentication. The {% data variables.product.pat_generic %} that you use is only for authentication as a site administrator, and does not require any specific scope{% ifversion pat-v2 %} or permissions{% endif %}. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." diff --git a/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md b/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md index da61391c0697..14b58fdf099b 100644 --- a/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md +++ b/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md @@ -31,7 +31,7 @@ shortTitle: Prepare to migrate data {% data reusables.enterprise_installation.ssh-into-target-instance %} -3. Use the `ghe-migrator prepare` command to prepare the archive for import on the target instance and generate a new Migration GUID for you to use in subsequent steps: +1. Use the `ghe-migrator prepare` command to prepare the archive for import on the target instance and generate a new Migration GUID for you to use in subsequent steps: ```shell ghe-migrator prepare /home/admin/MIGRATION-GUID.tar.gz @@ -50,18 +50,18 @@ shortTitle: Prepare to migrate data - If no conflicts are reported, you can safely import the data by following the steps in "[AUTOTITLE](/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)". -2. If there are conflicts, using the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command, copy _conflicts.csv_ to your local computer: - +1. If there are conflicts, using the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command, copy _conflicts.csv_ to your local computer: + ```shell scp -P 122 admin@HOSTNAME:conflicts.csv ~/Desktop ``` -3. Continue to "[Resolving migration conflicts or setting up custom mappings](#resolving-migration-conflicts-or-setting-up-custom-mappings)". +1. Continue to "[Resolving migration conflicts or setting up custom mappings](#resolving-migration-conflicts-or-setting-up-custom-mappings)". ## Reviewing migration conflicts 1. Using a text editor or [CSV-compatible spreadsheet software](https://en.wikipedia.org/wiki/Comma-separated_values#Application_support), open _conflicts.csv_. -2. With guidance from the examples and reference tables below, review the _conflicts.csv_ file to ensure that the proper actions will be taken upon import. +1. With guidance from the examples and reference tables below, review the _conflicts.csv_ file to ensure that the proper actions will be taken upon import. The _conflicts.csv_ file contains a _migration map_ of conflicts and recommended actions. A migration map lists out both what data is being migrated from the source, and how the data will be applied to the target. @@ -147,10 +147,10 @@ The same process can be used to create mappings for each record that supports cu scp -P 122 ~/Desktop/conflicts.csv admin@HOSTNAME:/home/admin/ ``` -2. Re-map the migration data using the `ghe-migrator map` command, passing in the path to your modified _.csv_ file and the Migration GUID: +1. Re-map the migration data using the `ghe-migrator map` command, passing in the path to your modified _.csv_ file and the Migration GUID: ```shell ghe-migrator map -i conflicts.csv -g MIGRATION-GUID ``` -3. If the `ghe-migrator map -i conflicts.csv -g MIGRATION-GUID` command reports that conflicts still exist, run through the migration conflict resolution process again. +1. If the `ghe-migrator map -i conflicts.csv -g MIGRATION-GUID` command reports that conflicts still exist, run through the migration conflict resolution process again. diff --git a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md index c87d7f3f93c8..ec8611fe3490 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md @@ -23,9 +23,9 @@ If you choose to use the API, you'll need to write your own scripts or use an HT To migrate your repositories from {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %} with the APIs, you will: 1. Create a {% data variables.product.pat_generic %} for both the source and destination organization -2. Fetch the `ownerId` of the destination organization on {% data variables.product.prodname_ghe_cloud %} -3. Set up a migration source via {% data variables.product.prodname_dotcom_the_website %}'s GraphQL API to identify where you're migrating from -4. For each repository you want to migrate, repeat these steps. +1. Fetch the `ownerId` of the destination organization on {% data variables.product.prodname_ghe_cloud %} +1. Set up a migration source via {% data variables.product.prodname_dotcom_the_website %}'s GraphQL API to identify where you're migrating from +1. For each repository you want to migrate, repeat these steps. - Use the REST API on {% data variables.location.product_location_enterprise %} to generate migration archives for your repository - Upload your migration archives to a location where they can be accessed by {% data variables.product.prodname_dotcom_the_website %} - Start your migration using the GraphQL API for {% data variables.product.prodname_dotcom_the_website %}, passing in your archive URLs @@ -426,9 +426,9 @@ gh gei generate-script --github-source-org SOURCE \ When you migrate repositories, the {% data variables.product.prodname_gei_cli %} performs the following steps: 1. Connects to {% data variables.location.product_location_enterprise %} and generates two migration archives per repository, one for the Git source and one for the metadata -2. Uploads the migration archives to the blob storage provider of your choice -3. Starts your migration in {% data variables.product.prodname_ghe_cloud %}, using the URLs of the archives stored with your blob storage provider -4. Deletes the migration archive +1. Uploads the migration archives to the blob storage provider of your choice +1. Starts your migration in {% data variables.product.prodname_ghe_cloud %}, using the URLs of the archives stored with your blob storage provider +1. Deletes the migration archive ### Migrate multiple repositories diff --git a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-from-azure-devops-with-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-from-azure-devops-with-github-enterprise-importer.md index 8924eacd5296..f373a972e7c8 100644 --- a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-from-azure-devops-with-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-from-azure-devops-with-github-enterprise-importer.md @@ -20,8 +20,8 @@ If you're migrating from Azure DevOps (ADO), you can use this guide to plan and Enterprises who migrate from ADO to {% data variables.product.prodname_dotcom %} typically follow a multi-phase approach. 1. Migrate repositories from ADO to {% data variables.product.prodname_dotcom %}. -2. Migrate pipelines from Azure Pipelines to {% data variables.product.prodname_actions %}. -3. Migrate remaining assets, such as boards and artifacts, from ADO to {% data variables.product.prodname_dotcom %}. +1. Migrate pipelines from Azure Pipelines to {% data variables.product.prodname_actions %}. +1. Migrate remaining assets, such as boards and artifacts, from ADO to {% data variables.product.prodname_dotcom %}. This guide will guide you through completing the first phase, migrating repositories to {% data variables.product.prodname_dotcom %}, and assumes you're using the {% data variables.product.prodname_ado2gh_cli %}. diff --git a/content/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch.md b/content/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch.md index 1b837ad3d120..694b61863b42 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch.md +++ b/content/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch.md @@ -21,7 +21,7 @@ When you create a new organization from scratch, it doesn't have any repositorie {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.organizations %} {% data reusables.organizations.new-organization %} -4. Follow the prompts to create your organization. {% ifversion fpt or ghec %}For more information about the plans available for your team, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)."{% endif %} +1. Follow the prompts to create your organization. {% ifversion fpt or ghec %}For more information about the plans available for your team, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products)."{% endif %} ## Further reading diff --git a/content/organizations/collaborating-with-your-team/creating-a-team-discussion.md b/content/organizations/collaborating-with-your-team/creating-a-team-discussion.md index 05af529f5bbb..f4907a6fdce3 100644 --- a/content/organizations/collaborating-with-your-team/creating-a-team-discussion.md +++ b/content/organizations/collaborating-with-your-team/creating-a-team-discussion.md @@ -22,9 +22,9 @@ shortTitle: Create a team discussion {% data reusables.user-settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team-discussions-tab %} -6. Type a team discussion title and a comment to start a conversation. -7. Optionally, select whether you want your post to be private or public using the drop-down menu. -8. Click **Comment**. +1. Type a team discussion title and a comment to start a conversation. +1. Optionally, select whether you want your post to be private or public using the drop-down menu. +1. Click **Comment**. ## Further reading diff --git a/content/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion.md b/content/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion.md index d8df296861b6..31bf9469747b 100644 --- a/content/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion.md +++ b/content/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion.md @@ -20,10 +20,10 @@ shortTitle: Manage a team discussion {% data reusables.user-settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team-discussions-tab %} -6. Click {% octicon "kebab-horizontal" aria-label="The edit icon" %} next to the team discussion you want to edit or delete. -7. Click **Edit**. Optionally, click **Delete**. +1. Click {% octicon "kebab-horizontal" aria-label="The edit icon" %} next to the team discussion you want to edit or delete. +1. Click **Edit**. Optionally, click **Delete**. ![Screenshot showing a dropdown menu on a discussion post. The edit option is highlighted with an orange outline.](/assets/images/help/projects/edit-team-discussions-button.png) -8. Modify the team discussion title and comment as needed, and click **Update comment**. +1. Modify the team discussion title and comment as needed, and click **Update comment**. ## Further reading diff --git a/content/organizations/collaborating-with-your-team/pinning-a-team-discussion.md b/content/organizations/collaborating-with-your-team/pinning-a-team-discussion.md index d26e73080218..5909e80deb2f 100644 --- a/content/organizations/collaborating-with-your-team/pinning-a-team-discussion.md +++ b/content/organizations/collaborating-with-your-team/pinning-a-team-discussion.md @@ -19,7 +19,7 @@ topics: {% data reusables.user-settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team-discussions-tab %} -5. Click {% octicon "pin" aria-label="Pin this discussion" %} next to the team discussion you want to pin. You can also unpin a discussion by clicking the icon. +1. Click {% octicon "pin" aria-label="Pin this discussion" %} next to the team discussion you want to pin. You can also unpin a discussion by clicking the icon. ## Further reading diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md index dcbdc64445be..dff67d29affc 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md @@ -82,7 +82,7 @@ You can use security overview to find a set of repositories and enable or disabl 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -2. Under "Code security and analysis", to the right of the feature, click **Disable all** or **Enable all** to display a confirmation dialog box. {% ifversion ghes or ghec %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} +1. Under "Code security and analysis", to the right of the feature, click **Disable all** or **Enable all** to display a confirmation dialog box. {% ifversion ghes or ghec %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if you have no available {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} 1. Review the information in the dialog box. 1. Optionally, if you are enabling a feature, select **Enable by default for new {% ifversion fpt or ghec %}private {% endif %}repositories**. diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md index d37137c7f2ab..b2eab199c70b 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md @@ -48,4 +48,4 @@ Users will not be notified when you enable email restrictions. It is your respon {% data reusables.profile.org_settings %} {% data reusables.organizations.verified-domains %} {% data reusables.organizations.restrict-email-notifications %} -6. Click **Save**. +1. Click **Save**. diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md b/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md index 25ee7249ab2c..b75e33aaeb86 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/adding-an-outside-collaborator-to-a-project-board-in-your-organization.md @@ -28,6 +28,6 @@ An outside collaborator is a person who isn't explicitly a member of your organi {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} {% data reusables.project-management.collaborator-option %} -9. Under "Search by username, full name or email address", type the outside collaborator's name, username, or {% data variables.product.prodname_dotcom %} email. +1. Under "Search by username, full name or email address", type the outside collaborator's name, username, or {% data variables.product.prodname_dotcom %} email. {% data reusables.project-management.add-collaborator %} {% data reusables.project-management.collaborator-permissions %} diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md index a666b4e9e59a..e09273372550 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md @@ -35,8 +35,8 @@ By default, organization members have write access to their organization's {% da {% data reusables.project-management.select-project %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} -8. Under "Organization member permission", choose a baseline permission level for all organization members: **Read**, **Write**, **Admin**, or **None**. -9. Click **Save**. +1. Under "Organization member permission", choose a baseline permission level for all organization members: **Read**, **Write**, **Admin**, or **None**. +1. Click **Save**. ## Further reading diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md index b763a82d94a3..49fbfe0ae413 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md @@ -35,7 +35,7 @@ allowTitleToDifferFromFilename: true {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} {% data reusables.project-management.collaborator-option %} -9. Under "Search by username, full name or email address", type the collaborator's name, username, or {% data variables.product.prodname_dotcom %} email. +1. Under "Search by username, full name or email address", type the collaborator's name, username, or {% data variables.product.prodname_dotcom %} email. {% data reusables.project-management.add-collaborator %} {% data reusables.project-management.collaborator-permissions %} diff --git a/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md b/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md index 9e0f2743535b..fe398ca1560d 100644 --- a/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md +++ b/content/organizations/managing-membership-in-your-organization/can-i-create-accounts-for-people-in-my-organization.md @@ -27,5 +27,5 @@ You can also consider {% data variables.product.prodname_emus %}. {% data reusab ## Adding users to your organization 1. Provide each person instructions to [create a personal account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account). -2. Ask for the username of each person you want to give organization membership to. -3. [Invite the new personal accounts to join](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization) your organization. Use [organization roles](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization) and [repository permissions](/organizations/managing-user-access-to-your-organizations-repositories/repository-roles-for-an-organization) to limit the access of each account. +1. Ask for the username of each person you want to give organization membership to. +1. [Invite the new personal accounts to join](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization) your organization. Use [organization roles](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization) and [repository permissions](/organizations/managing-user-access-to-your-organizations-repositories/repository-roles-for-an-organization) to limit the access of each account. diff --git a/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md b/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md index 6219ef1b4880..fe6f6eb7b7a9 100644 --- a/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization.md @@ -77,9 +77,9 @@ If an organization member was removed from the organization because they did not 1. Select whether to restore that person's previous privileges in the organization or clear their previous privileges and set new access permissions, then click **Add and reinstate** or **Add and start fresh**. {% endif %} {% ifversion fpt or ghec %} -7. If you cleared the previous privileges for a former organization member, choose a role for the user, and optionally add them to some teams, then click **Send invitation**. +1. If you cleared the previous privileges for a former organization member, choose a role for the user, and optionally add them to some teams, then click **Send invitation**. {% else %} -7. If you cleared the previous privileges for a former organization member, choose a role for the user, and optionally add them to some teams, then click **Add member**. +1. If you cleared the previous privileges for a former organization member, choose a role for the user, and optionally add them to some teams, then click **Add member**. {% endif %} {% ifversion fpt or ghec %} {% data reusables.organizations.user_must_accept_invite_email %} {% data reusables.organizations.cancel_org_invite %} diff --git a/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md b/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md index a66d1a974dfe..5d3ec237914d 100644 --- a/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md +++ b/content/organizations/managing-organization-settings/allowing-people-to-delete-issues-in-your-organization.md @@ -22,5 +22,5 @@ Once enabled, organization owners and people with admin access in an organizatio {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.member-privileges %} -5. Under "Issue deletion", select **Allow members to delete issues for this organization**. -6. Click **Save**. +1. Under "Issue deletion", select **Allow members to delete issues for this organization**. +1. Click **Save**. diff --git a/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md index d8da93b66385..e7547cd81f55 100644 --- a/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md +++ b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md @@ -23,20 +23,20 @@ shortTitle: Convert organization to user {% endnote %} 1. [Sign up](/get-started/signing-up-for-github/signing-up-for-a-new-github-account) for a new account on GitHub. -2. [Have the user's role changed to an owner](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization). -3. {% data variables.product.signin_link %} to the new personal account. -4. [Transfer each organization repository](/repositories/creating-and-managing-repositories/transferring-a-repository) to the new personal account. -5. [Rename the organization](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username) to make the current username available. -6. [Rename the user](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username) to the organization's name. -7. [Delete the organization](/organizations/managing-organization-settings/deleting-an-organization-account). +1. [Have the user's role changed to an owner](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization). +1. {% data variables.product.signin_link %} to the new personal account. +1. [Transfer each organization repository](/repositories/creating-and-managing-repositories/transferring-a-repository) to the new personal account. +1. [Rename the organization](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username) to make the current username available. +1. [Rename the user](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username) to the organization's name. +1. [Delete the organization](/organizations/managing-organization-settings/deleting-an-organization-account). {% else %} 1. Sign up for a new GitHub Enterprise personal account. -2. [Have the user's role changed to an owner](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization). -3. {% data variables.product.signin_link %} to the new personal account. -4. [Transfer each organization repository](/repositories/creating-and-managing-repositories/transferring-a-repository) to the new personal account. -5. [Delete the organization](/organizations/managing-organization-settings/deleting-an-organization-account). -6. [Rename the user](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username) to the organization's name. +1. [Have the user's role changed to an owner](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization). +1. {% data variables.product.signin_link %} to the new personal account. +1. [Transfer each organization repository](/repositories/creating-and-managing-repositories/transferring-a-repository) to the new personal account. +1. [Delete the organization](/organizations/managing-organization-settings/deleting-an-organization-account). +1. [Rename the user](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username) to the organization's name. {% endif %} diff --git a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index e742be774d9b..be7cc89f0d4e 100644 --- a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -29,11 +29,11 @@ If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal {% data reusables.profile.org_member_privileges %} 1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes or ghae %}and internal {% endif %}repositories**. {%- ifversion org-owners-limit-forks-creation %} -2. Optionally, if your organization is owned by an enterprise account, select a policy for where users are allowed to fork repositories. +1. Optionally, if your organization is owned by an enterprise account, select a policy for where users are allowed to fork repositories. If repository forking policy is configured at the enterprise level, you won't be able to select a more permissive policy in your organization settings. {%- endif %} -3. Click **Save**. +1. Click **Save**. ## Further reading diff --git a/content/organizations/managing-organization-settings/transferring-organization-ownership.md b/content/organizations/managing-organization-settings/transferring-organization-ownership.md index cfacc5dee851..5453b663ca69 100644 --- a/content/organizations/managing-organization-settings/transferring-organization-ownership.md +++ b/content/organizations/managing-organization-settings/transferring-organization-ownership.md @@ -23,9 +23,9 @@ shortTitle: Transfer ownership {% endnote %}{% endif %} 1. If you're the only member with _owner_ privileges, give another organization member the owner role. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)." -2. Contact the new owner and make sure they are able to [access the organization's settings](/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings). +1. Contact the new owner and make sure they are able to [access the organization's settings](/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings). {% ifversion fpt or ghec %} -3. If you are currently responsible for paying for GitHub in your organization, you'll also need to have the new owner or a [billing manager](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization) update the organization's payment information. For more information, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)." +1. If you are currently responsible for paying for GitHub in your organization, you'll also need to have the new owner or a [billing manager](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization) update the organization's payment information. For more information, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)." {% warning %} @@ -34,4 +34,4 @@ shortTitle: Transfer ownership {% endwarning %} {% endif %} -4. [Remove yourself](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization) from the organization. +1. [Remove yourself](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization) from the organization. diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md index c4b612810b4e..6a60b6f13ea8 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md @@ -62,7 +62,7 @@ The invited person will receive an invitation email asking them to become a bill {% data reusables.organizations.billing-settings %} 1. Under "Billing management", next to "Billing managers", click **Add**. -6. Type the username or email address of the person you want to add and click **Send invitation**. +1. Type the username or email address of the person you want to add and click **Send invitation**. ## Further reading diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md index 68b028eab663..65e8b8a498e4 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md @@ -18,9 +18,9 @@ Recovery codes should not be shared or distributed. We recommend saving them wit {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -5. Under "SAML single sign-on", in the note about recovery codes, click **Save your recovery codes**. +1. Under "SAML single sign-on", in the note about recovery codes, click **Save your recovery codes**. ![Screenshot of the "SAML single sign-on" section. A link, labeled "Save your recovery codes," is highlighted with an orange outline.](/assets/images/help/saml/saml-recovery-codes.png) -6. To save your recovery codes, click **Download**, **Print**, or **Copy**. +1. To save your recovery codes, click **Download**, **Print**, or **Copy**. {% note %} @@ -28,7 +28,7 @@ Recovery codes should not be shared or distributed. We recommend saving them wit {% endnote %} -7. Once you use a recovery code to regain access to {% data variables.product.product_name %}, it cannot be reused. Access to {% data variables.product.product_name %} will only be available for 24 hours before you'll be asked to sign in using single sign-on. +1. Once you use a recovery code to regain access to {% data variables.product.product_name %}, it cannot be reused. Access to {% data variables.product.product_name %} will only be available for 24 hours before you'll be asked to sign in using single sign-on. ## Further reading diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md index 157bdb0cbad6..4d9f0e85e4dc 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md @@ -67,7 +67,7 @@ You must have a linked SAML identity. To create a linked identity, you must auth {% data reusables.identity-and-permissions.team-sync-confirm-saml %} {% data reusables.identity-and-permissions.enable-team-sync-azure %} {% data reusables.identity-and-permissions.team-sync-confirm %} -6. Review the identity provider tenant information you want to connect to your organization, then click **Approve**. +1. Review the identity provider tenant information you want to connect to your organization, then click **Approve**. ### Enabling team synchronization for Okta @@ -109,4 +109,4 @@ For help on provisioning users that have missing a missing SCIM linked identity, {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} -5. Under "Team synchronization", click **Disable team synchronization**. +1. Under "Team synchronization", click **Disable team synchronization**. diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md index 37500d8e5ef4..e33e159332ac 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md @@ -54,7 +54,7 @@ When you reinstate a former outside collaborator, you can restore: {% endwarning %} {% else %} -6. Select whether to restore the outside collaborator's previous privileges in the organization by clicking **Add and reinstate** or choose to clear their previous privileges and set new access permissions by clicking **Add and start fresh**. +1. Select whether to restore the outside collaborator's previous privileges in the organization by clicking **Add and reinstate** or choose to clear their previous privileges and set new access permissions by clicking **Add and start fresh**. {% warning %} @@ -63,12 +63,12 @@ When you reinstate a former outside collaborator, you can restore: {% endwarning %} {% endif %} {% ifversion fpt or ghec %} -7. If you cleared the previous privileges for a former outside collaborator, choose a role for the user and optionally add them to some teams, then click **Send invitation**. +1. If you cleared the previous privileges for a former outside collaborator, choose a role for the user and optionally add them to some teams, then click **Send invitation**. {% else %} -7. If you cleared the previous privileges for a former outside collaborator, choose a role for the user and optionally add them to some teams, then click **Add member**. +1. If you cleared the previous privileges for a former outside collaborator, choose a role for the user and optionally add them to some teams, then click **Add member**. {% endif %} {% ifversion fpt or ghec %} -8. The invited person will receive an email inviting them to the organization. They will need to accept the invitation before becoming an outside collaborator in the organization. {% data reusables.organizations.cancel_org_invite %} +1. The invited person will receive an email inviting them to the organization. They will need to accept the invitation before becoming an outside collaborator in the organization. {% data reusables.organizations.cancel_org_invite %} {% endif %} ## Further Reading diff --git a/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md index e3bdcab7b987..9f7789d57197 100644 --- a/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md @@ -29,6 +29,6 @@ For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-yo {% endwarning %} 1. [Create a new team](/organizations/organizing-members-into-teams/creating-a-team). -2. [Add each of the members](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) of your legacy admin team to the new team. -3. [Give the new team equivalent access](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository) to each of the repositories the legacy team could access. -4. [Delete the legacy admin team](/organizations/organizing-members-into-teams/deleting-a-team). +1. [Add each of the members](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) of your legacy admin team to the new team. +1. [Give the new team equivalent access](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository) to each of the repositories the legacy team could access. +1. [Delete the legacy admin team](/organizations/organizing-members-into-teams/deleting-a-team). diff --git a/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md index b3cc189250df..b2b0b8c44df1 100644 --- a/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md @@ -51,4 +51,4 @@ You have a few options to convert your legacy Owners team: {% data reusables.user-settings.access_org %} {% data reusables.organizations.owners-team %} {% data reusables.organizations.convert-owners-team-confirm %} -5. At the bottom of the page, review the warning and click **Delete the Owners team**. +1. At the bottom of the page, review the warning and click **Delete the Owners team**. diff --git a/content/organizations/organizing-members-into-teams/about-teams.md b/content/organizations/organizing-members-into-teams/about-teams.md index d0f05481070a..e82f7e76fb21 100644 --- a/content/organizations/organizing-members-into-teams/about-teams.md +++ b/content/organizations/organizing-members-into-teams/about-teams.md @@ -72,9 +72,9 @@ If your organization already has existing teams, you should audit each team's re At the top of the team hierarchy, you should give parent teams repository access permissions that are safe for every member of the parent team and its child teams. As you move toward the bottom of the hierarchy, you can grant child teams additional, more granular access to more sensitive repositories. 1. Remove all members from existing teams -2. Audit and adjust each team's repository access permissions and give each team a parent -3. Create any new teams you'd like to, choose a parent for each new team, and give them repository access -4. Add people directly to teams +1. Audit and adjust each team's repository access permissions and give each team a parent +1. Create any new teams you'd like to, choose a parent for each new team, and give them repository access +1. Add people directly to teams ## Further reading diff --git a/content/organizations/organizing-members-into-teams/creating-a-team.md b/content/organizations/organizing-members-into-teams/creating-a-team.md index 9968a47614fa..844f7995dcf9 100644 --- a/content/organizations/organizing-members-into-teams/creating-a-team.md +++ b/content/organizations/organizing-members-into-teams/creating-a-team.md @@ -68,7 +68,7 @@ You must be a site admin and an organization owner to create a team with LDAP sy {% data reusables.user-settings.access_org %} {% data reusables.organizations.new_team %} {% data reusables.organizations.team_name %} -6. Under "LDAP group", 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. +1. Under "LDAP group", 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. {% data reusables.organizations.team_description %} {% data reusables.organizations.team_visibility %} {% data reusables.organizations.create-team-choose-parent %} diff --git a/content/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization.md b/content/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization.md index ff24377464a9..af841c20a81e 100644 --- a/content/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization.md +++ b/content/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization.md @@ -21,5 +21,5 @@ shortTitle: Disable team discussions {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.teams_sidebar %} -5. Under "Team discussions", unselect **Enable team discussions for this organization**. -6. Click **Save**. +1. Under "Team discussions", unselect **Enable team discussions for this organization**. +1. Click **Save**. diff --git a/content/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md b/content/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md index 22f16cd1ee3c..049dbdc6bf1c 100644 --- a/content/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md +++ b/content/organizations/organizing-members-into-teams/setting-your-teams-profile-picture.md @@ -21,5 +21,5 @@ Unless you set a profile picture for a team, the team profile picture will match {% data reusables.user-settings.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. Under "Profile picture", click **Upload new picture**, then select your desired profile picture. -6. Click and drag to crop the image as needed, then click **Set new team avatar**. +1. Under "Profile picture", click **Upload new picture**, then select your desired profile picture. +1. Click and drag to crop the image as needed, then click **Set new team avatar**. diff --git a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index d1923c69ac78..1fa9dee38c2d 100644 --- a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -177,15 +177,15 @@ Once you've selected the package you're interested in sharing with codespaces in {% data reusables.package_registry.package-settings-option %} -2. Under "Manage Codespaces access", click **Add repository**. +1. Under "Manage Codespaces access", click **Add repository**. ![Screenshot of the "Manage Codespaces access" section of the package settings page. The "Add repository" button is highlighted with an orange outline.](/assets/images/help/package-registry/manage-codespaces-access-blank.png) -3. Search for the repository you want to add. +1. Search for the repository you want to add. -4. Repeat for any additional repositories you would like to allow access. +1. Repeat for any additional repositories you would like to allow access. -5. If the codespaces for a repository no longer need access to a package, you can remove access. Click **{% octicon "trash" aria-label="remove access to repository from this package" %}**. +1. If the codespaces for a repository no longer need access to a package, you can remove access. Click **{% octicon "trash" aria-label="remove access to repository from this package" %}**. ![Screenshot of the "Manage Codespaces access" section of the package settings page. The trash icon is highlighted with an orange outline.](/assets/images/help/package-registry/manage-codespaces-access-item.png) diff --git a/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md b/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md index 48df93a81543..1cf64591d02b 100644 --- a/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md +++ b/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md @@ -50,13 +50,13 @@ When you publish a package that is scoped to a personal account or an organizati For more information, see "[LABEL](https://docs.docker.com/engine/reference/builder/#label)" in the official Docker documentation and "[Pre-defined Annotation Keys](https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys)" in the `opencontainers/image-spec` repository. -2. Build your container image. This example builds an image from the Dockerfile in the current directory and assigns the image name `hello_docker`. +1. Build your container image. This example builds an image from the Dockerfile in the current directory and assigns the image name `hello_docker`. ```shell docker build -t hello_docker . ``` -3. Optionally, review the details of the Docker image you just created. +1. Optionally, review the details of the Docker image you just created. ```shell $ docker images @@ -66,7 +66,7 @@ When you publish a package that is scoped to a personal account or an organizati > alpine latest a6215f271958 5 months ago 5.29MB ``` -4. Assign a name and hosting destination to your Docker image. +1. Assign a name and hosting destination to your Docker image. ```shell docker tag IMAGE_NAME {% data reusables.package_registry.container-registry-hostname %}/NAMESPACE/NEW_IMAGE_NAME:TAG @@ -80,7 +80,7 @@ When you publish a package that is scoped to a personal account or an organizati docker tag 38f737a91f39 {% ifversion fpt or ghec %}ghcr.io{% elsif ghes > 3.4 %}{% data reusables.package_registry.container-registry-example-hostname %}{% endif %}/octocat/hello_docker:latest ``` -5. If you haven't already, authenticate to the {% data variables.product.prodname_container_registry %}. For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry)." +1. If you haven't already, authenticate to the {% data variables.product.prodname_container_registry %}. For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry)." {% raw %} ```shell @@ -89,7 +89,7 @@ When you publish a package that is scoped to a personal account or an organizati ``` {% endraw %} -6. Push your container image to the {% data variables.product.prodname_container_registry %}. +1. Push your container image to the {% data variables.product.prodname_container_registry %}. ```shell docker push {% data reusables.package_registry.container-registry-hostname %}/NAMESPACE/IMAGE-NAME:TAG diff --git a/content/packages/learn-github-packages/installing-a-package.md b/content/packages/learn-github-packages/installing-a-package.md index 2be545ac0958..5b5ec21aa0e4 100644 --- a/content/packages/learn-github-packages/installing-a-package.md +++ b/content/packages/learn-github-packages/installing-a-package.md @@ -28,6 +28,6 @@ After you find a package, you can read the package's description and installatio You can install a package from {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Authenticate to {% data variables.product.prodname_registry %} using the instructions for your package client. For more information, see "[AUTOTITLE](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)." -2. Install the package using the instructions for your package client. +1. Install the package using the instructions for your package client. For instructions specific to your package client, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry)." diff --git a/content/packages/learn-github-packages/publishing-a-package.md b/content/packages/learn-github-packages/publishing-a-package.md index 1de2f9a4d648..c236236b05fb 100644 --- a/content/packages/learn-github-packages/publishing-a-package.md +++ b/content/packages/learn-github-packages/publishing-a-package.md @@ -33,8 +33,8 @@ If a new version of a package fixes a security vulnerability, you should publish You can publish a package to {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Create or use an existing {% data variables.product.pat_v1 %} with the appropriate scopes for the task you want to accomplish. For more information, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages)." -2. Authenticate to {% data variables.product.prodname_registry %} using your {% data variables.product.pat_v1 %} and the instructions for your package client. -3. Publish the package using the instructions for your package client. +1. Authenticate to {% data variables.product.prodname_registry %} using your {% data variables.product.pat_v1 %} and the instructions for your package client. +1. Publish the package using the instructions for your package client. For instructions specific to your package client, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry)." diff --git a/content/packages/learn-github-packages/viewing-packages.md b/content/packages/learn-github-packages/viewing-packages.md index 3b07fc1b00f1..756dd56d26f3 100644 --- a/content/packages/learn-github-packages/viewing-packages.md +++ b/content/packages/learn-github-packages/viewing-packages.md @@ -50,7 +50,7 @@ You can find and view a package located in the repositories of an organization y {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} -3. Under your organization name, click {% octicon "package" aria-hidden="true" %} **Packages**. +1. Under your organization name, click {% octicon "package" aria-hidden="true" %} **Packages**. {% data reusables.package_registry.navigate-to-packages %} ## Viewing your packages diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md index c78e5f33f818..14eb5e5088a5 100644 --- a/content/packages/quickstart.md +++ b/content/packages/quickstart.md @@ -19,14 +19,14 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor ## Publishing your package 1. Create a new repository on {% data variables.product.prodname_dotcom %}, adding the `.gitignore` for Node. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)." -2. Clone the repository to your local machine. +1. Clone the repository to your local machine. ```shell git clone https://{% ifversion ghes or ghae %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git cd YOUR-REPOSITORY ``` -3. Create an `index.js` file and add a basic alert to say "Hello world!" +1. Create an `index.js` file and add a basic alert to say "Hello world!" {% raw %} ```javascript copy @@ -34,7 +34,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor ``` {% endraw %} -4. Initialize an npm package with `npm init`. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0`. This will generate a `package.json` file with information about your package. +1. Initialize an npm package with `npm init`. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0`. This will generate a `package.json` file with information about your package. {% raw %} ```shell @@ -47,7 +47,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor ``` {% endraw %} -5. Run `npm install` to generate the `package-lock.json` file, then commit and push your changes to {% data variables.product.prodname_dotcom %}. +1. Run `npm install` to generate the `package-lock.json` file, then commit and push your changes to {% data variables.product.prodname_dotcom %}. ```shell npm install @@ -56,8 +56,8 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor git push ``` -6. Create a `.github/workflows` directory. In that directory, create a file named `release-package.yml`. -7. Copy the following YAML content into the `release-package.yml` file{% ifversion ghes or ghae %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. +1. Create a `.github/workflows` directory. In that directory, create a file named `release-package.yml`. +1. Copy the following YAML content into the `release-package.yml` file{% ifversion ghes or ghae %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. ```yaml copy name: Node.js Package @@ -95,7 +95,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor NODE_AUTH_TOKEN: ${% raw %}{{secrets.GITHUB_TOKEN}}{% endraw %} ``` -8. Tell npm which scope and registry to publish packages to using one of the following methods: +1. Tell npm which scope and registry to publish packages to using one of the following methods: - Add an npm configuration file for the repository by creating a `.npmrc` file in the root directory with the contents: {% raw %} @@ -114,7 +114,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor ``` {% endraw %} -9. Commit and push your changes to {% data variables.product.prodname_dotcom %}. +1. Commit and push your changes to {% data variables.product.prodname_dotcom %}. ```shell $ git add .github/workflows/release-package.yml @@ -124,7 +124,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor $ git push ``` -10. The workflow that you created will run whenever a new release is created in your repository. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. +1. The workflow that you created will run whenever a new release is created in your repository. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. To test this out, navigate to the **Code** tab in your repository and create a new release. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md index 261daabfb4ad..a16d40e2b537 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md @@ -174,7 +174,7 @@ For more information on creating a package, see the [maven.apache.org documentat To install an Apache Maven package from {% data variables.product.prodname_registry %}, edit the _pom.xml_ file to include the package as a dependency. If you want to install packages from any repository for a specified repository owner, use a repository URL like `https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/*`. For more information on using a _pom.xml_ file in your project, see "[Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)" in the Apache Maven documentation. {% data reusables.package_registry.authenticate-step %} -2. Add the package dependencies to the `dependencies` element of your project _pom.xml_ file, replacing `com.example:test` with your package. +1. Add the package dependencies to the `dependencies` element of your project _pom.xml_ file, replacing `com.example:test` with your package. ```xml @@ -187,7 +187,7 @@ To install an Apache Maven package from {% data variables.product.prodname_regis ``` {% data reusables.package_registry.checksum-maven-plugin %} -3. Install the package. +1. Install the package. ```shell mvn install diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index d39791d9c403..963c1e53b876 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -96,13 +96,13 @@ To ensure you're always using the same image, you can specify the exact containe ``` Replace `NAMESPACE` with the name of the personal account or organization to which the image is scoped. -2. Remove image locally as needed. +1. Remove image locally as needed. ```shell docker rmi {% data reusables.package_registry.container-registry-hostname %}/NAMESPACE/IMAGE_NAME:latest ``` -3. Pull the container image with `@YOUR_SHA_VALUE` after the image name. +1. Pull the container image with `@YOUR_SHA_VALUE` after the image name. ```shell docker pull {% data reusables.package_registry.container-registry-hostname %}/NAMESPACE/IMAGE_NAME@sha256:82jf9a84u29hiasldj289498uhois8498hjs29hkuhs @@ -164,7 +164,7 @@ docker build -t hello_docker . > hello-world latest fce289e99eb9 16 months ago 1.84kB ``` -2. Tag your Docker image using the image ID and your desired image name and hosting destination. +1. Tag your Docker image using the image ID and your desired image name and hosting destination. ```shell docker tag 38f737a91f39 {% data reusables.package_registry.container-registry-hostname %}/NAMESPACE/NEW_IMAGE_NAME:latest diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index d873a560a177..d4af8919156c 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -112,7 +112,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` -2. Using the Docker image ID, tag the docker image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image,{% ifversion ghes or ghae %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and VERSION with package version at build time. +1. Using the Docker image ID, tag the docker image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image,{% ifversion ghes or ghae %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and VERSION with package version at build time. {% ifversion fpt or ghec %} ```shell @@ -137,7 +137,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen {% endif %} {% endif %} -3. If you haven't already built a docker image for the package, build the image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image, VERSION with package version at build time,{% ifversion ghes or ghae %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and PATH to the image if it isn't in the current working directory. +1. If you haven't already built a docker image for the package, build the image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image, VERSION with package version at build time,{% ifversion ghes or ghae %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and PATH to the image if it isn't in the current working directory. {% ifversion fpt or ghec %} ```shell @@ -162,7 +162,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen {% endif %} {% endif %} -4. Publish the image to {% data variables.product.prodname_registry %}. +1. Publish the image to {% data variables.product.prodname_registry %}. {% ifversion fpt or ghec %} ```shell diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md index ec014902a2a6..6e7b05424881 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -160,7 +160,7 @@ subprojects { {% data reusables.package_registry.viewing-packages %} {% data reusables.package_registry.authenticate-step %} -2. After creating your package, you can publish the package. +1. After creating your package, you can publish the package. ```shell gradle publish @@ -171,7 +171,7 @@ subprojects { To use a published package from {% data variables.product.prodname_registry %}, add the package as a dependency and add the repository to your project. For more information, see "[Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html)" in the Gradle documentation. {% data reusables.package_registry.authenticate-step %} -2. Add the package dependencies to your _build.gradle_ file (Gradle Groovy) or _build.gradle.kts_ file (Kotlin DSL) file. +1. Add the package dependencies to your _build.gradle_ file (Gradle Groovy) or _build.gradle.kts_ file (Kotlin DSL) file. Example using Gradle Groovy: @@ -189,7 +189,7 @@ To use a published package from {% data variables.product.prodname_registry %}, } ``` -3. Add the repository to your _build.gradle_ file (Gradle Groovy) or _build.gradle.kts_ file (Kotlin DSL) file. +1. Add the repository to your _build.gradle_ file (Gradle Groovy) or _build.gradle.kts_ file (Kotlin DSL) file. Example using Gradle Groovy: diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 237cc9eb1f4d..9aa4196a1a27 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -217,7 +217,7 @@ By default, you can only use npm packages hosted on your enterprise, and you wil } ``` -5. Install the package. +1. Install the package. ```shell npm install diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index bd6f05a1704c..7ba4c73f0002 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -125,13 +125,13 @@ If you don't already have a {% data variables.product.pat_generic %} to use for dotnet new console --name PROJECT_NAME ``` -2. Package the project. +1. Package the project. ```shell dotnet pack --configuration Release ``` -3. Publish the package using your {% data variables.product.pat_generic %} as the API key. Replace `PROJECT_NAME` with the name of the project, `1.0.0` with the version number of the package, and `YOUR_GITHUB_PAT` with your {% data variables.product.pat_generic %}. +1. Publish the package using your {% data variables.product.pat_generic %} as the API key. Replace `PROJECT_NAME` with the name of the project, `1.0.0` with the version number of the package, and `YOUR_GITHUB_PAT` with your {% data variables.product.pat_generic %}. ```shell dotnet nuget push "bin/Release/PROJECT_NAME.1.0.0.nupkg" --api-key YOUR_GITHUB_PAT --source "github" @@ -146,14 +146,14 @@ When publishing, {% ifversion packages-nuget-v2 %}if you are linking your packag {% data reusables.package_registry.auto-inherit-permissions-note %} {% data reusables.package_registry.authenticate-step %} -2. Create a new project. Replace `PROJECT_NAME` with the name you'd like to give the project. +1. Create a new project. Replace `PROJECT_NAME` with the name you'd like to give the project. ```shell dotnet new console --name PROJECT_NAME ``` -3. Add your project's specific information to your project's file, which ends in _.csproj_. Make sure to replace: - +1. Add your project's specific information to your project's file, which ends in _.csproj_. Make sure to replace: + - `1.0.0` with the version number of the package. - `OWNER` with the name of the personal account or organization that owns the repository to which you want to {% ifversion packages-nuget-v2 %}link your package{% else %}publish your package{% endif %}. - `REPOSITORY` with the name of the repository to which you want to connect your package.{% ifversion ghes or ghae %} @@ -176,14 +176,14 @@ When publishing, {% ifversion packages-nuget-v2 %}if you are linking your packag ``` -4. Package the project. +1. Package the project. ```shell dotnet pack --configuration Release ``` -5. Publish the package using the `key` you specified in the _nuget.config_ file. Replace `PROJECT_NAME` with the name of the project, and replace `1.0.0` with the version number of the package. - +1. Publish the package using the `key` you specified in the _nuget.config_ file. Replace `PROJECT_NAME` with the name of the project, and replace `1.0.0` with the version number of the package. + ```shell dotnet nuget push "bin/Release/PROJECT_NAME.1.0.0.nupkg" --source "github" ``` @@ -236,8 +236,8 @@ Using packages from {% data variables.product.prodname_dotcom %} in your project {% data reusables.package_registry.authenticate-step %} -2. To use a package, add `ItemGroup` and configure the `PackageReference` field in the _.csproj_ project file. Replace the `PACKAGE_NAME` value in `Include="PACKAGE_NAME"` with your package dependency, and replace the `X.X.X` value in `Version="X.X.X"` with the version of the package you want to use: - +1. To use a package, add `ItemGroup` and configure the `PackageReference` field in the _.csproj_ project file. Replace the `PACKAGE_NAME` value in `Include="PACKAGE_NAME"` with your package dependency, and replace the `X.X.X` value in `Version="X.X.X"` with the version of the package you want to use: + ``` xml @@ -259,7 +259,7 @@ Using packages from {% data variables.product.prodname_dotcom %} in your project ``` -3. Install the packages with the `restore` command. +1. Install the packages with the `restore` command. ```shell dotnet restore diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index a66a3822e8c2..b84bdffa551b 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -157,7 +157,7 @@ You can use gems from {% data variables.product.prodname_registry %} much like y end ``` -3. For Bundler versions earlier than 1.7.0, you need to add a new global `source`. For more information on using Bundler, see the [bundler.io documentation](https://bundler.io/gemfile.html). +1. For Bundler versions earlier than 1.7.0, you need to add a new global `source`. For more information on using Bundler, see the [bundler.io documentation](https://bundler.io/gemfile.html). ```ruby source "https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY_URL{% endif %}/NAMESPACE" @@ -167,11 +167,11 @@ You can use gems from {% data variables.product.prodname_registry %} much like y gem "GEM_NAME" ``` -4. Install the package: +1. Install the package: - ``` - gem install GEM_NAME --version "0.1.1" - ``` + ``` + gem install GEM_NAME --version "0.1.1" + ``` ## Further reading diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index 1517f1a40ecf..7f43749bccb6 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -45,7 +45,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +1. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." {% note %} @@ -59,7 +59,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} -6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. +1. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. ```shell $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd @@ -81,8 +81,8 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." -5. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. If you're implementing IPv6 support, we highly recommend using an `A` record in addition to your `AAAA` record, due to slow adoption of IPv6 globally. {% data reusables.pages.contact-dns-provider %} +1. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +1. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. If you're implementing IPv6 support, we highly recommend using an `A` record in addition to your `AAAA` record, due to slow adoption of IPv6 globally. {% data reusables.pages.contact-dns-provider %} - To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %} - To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}. ```shell @@ -101,7 +101,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} -6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. +1. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. - For `A` records: ```shell $ dig EXAMPLE.COM +noall +answer -t A @@ -132,7 +132,7 @@ To set up a `www` subdomain alongside the apex domain, you must first configure After you configure the apex domain, you must configure a CNAME record with your DNS provider. 1. Navigate to your DNS provider and create a `CNAME` record that points `www.example.com` to the default domain for your site: `.github.io` or `.github.io`. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} -2. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. +1. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. ```shell $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd diff --git a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md index b1590d887e93..b83b1eaf5941 100644 --- a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md @@ -37,8 +37,8 @@ To use a shorter and more memorable domain for your privately published site, yo {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -3. Under "{% data variables.product.prodname_pages %}", select the **{% data variables.product.prodname_pages %} visibility** dropdown menu, then select a visibility. -4. To see your published site, under "{% data variables.product.prodname_pages %}", click **{% octicon "link-external" aria-hidden="true" %} Visit site**. +1. Under "{% data variables.product.prodname_pages %}", select the **{% data variables.product.prodname_pages %} visibility** dropdown menu, then select a visibility. +1. To see your published site, under "{% data variables.product.prodname_pages %}", click **{% octicon "link-external" aria-hidden="true" %} Visit site**. ![Screenshot of a confirmation message for {% data variables.product.prodname_pages %} listing the site's URL. To the right of a long blue URL, a button labeled "Visit site" is outlined in dark orange.](/assets/images/help/pages/click-private-pages-url-to-preview.png) diff --git a/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md index b7bcca528b69..a262b275a4f6 100644 --- a/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site.md @@ -19,8 +19,8 @@ shortTitle: Create custom 404 page {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} {% data reusables.files.add-file %} -3. In the file name field, type `404.html` or `404.md`. -4. If you named your file `404.md`, add the following YAML front matter to the beginning of the file: +1. In the file name field, type `404.html` or `404.md`. +1. If you named your file `404.md`, add the following YAML front matter to the beginning of the file: ```yaml --- @@ -28,7 +28,7 @@ shortTitle: Create custom 404 page --- ``` -5. Below the YAML front matter, if present, add the content you want to display on your 404 page. +1. Below the YAML front matter, if present, add the content you want to display on your 404 page. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index f5ca12ecce74..200a2be51e50 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -34,7 +34,7 @@ All {% data variables.product.prodname_pages %} sites, including sites that are {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -3. Under "{% data variables.product.prodname_pages %}," select **Enforce HTTPS**. +1. Under "{% data variables.product.prodname_pages %}," select **Enforce HTTPS**. ## Troubleshooting certificate provisioning ("Certificate not yet created" error) diff --git a/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md b/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md index 5b7cc3664444..2252c04a2f87 100644 --- a/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site.md @@ -36,18 +36,18 @@ Unpublishing a site does not permanently delete the site. For information on del ## Unpublishing a project site {% data reusables.repositories.navigate-to-repo %} -2. If a `gh-pages` branch exists in the repository, delete the `gh-pages` branch. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)." -3. If the `gh-pages` branch was your publishing source, {% ifversion fpt or ghec %}skip to step 6{% else %}your site is now unpublished and you can skip the remaining steps{% endif %}. +1. If a `gh-pages` branch exists in the repository, delete the `gh-pages` branch. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)." +1. If the `gh-pages` branch was your publishing source, {% ifversion fpt or ghec %}skip to step 6{% else %}your site is now unpublished and you can skip the remaining steps{% endif %}. {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -5. Under "{% data variables.product.prodname_pages %}", use the branch dropdown menu and select **None.** +1. Under "{% data variables.product.prodname_pages %}", use the branch dropdown menu and select **None.** ![Screenshot of Pages settings in a {% data variables.product.prodname_dotcom %} repository. A menu to select a branch for a publishing source, labeled "None," is outlined in dark orange.](/assets/images/help/pages/publishing-source-drop-down.png) {% data reusables.pages.update_your_dns_settings %} ## Unpublishing a user or organization site {% data reusables.repositories.navigate-to-repo %} -2. Delete the branch that you're using as a publishing source, or delete the entire repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" and "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)." +1. Delete the branch that you're using as a publishing source, or delete the entire repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch)" and "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)." {% data reusables.pages.update_your_dns_settings %} {% endif %} diff --git a/content/pages/quickstart.md b/content/pages/quickstart.md index 37c615dcb93c..65da1a4b04a7 100644 --- a/content/pages/quickstart.md +++ b/content/pages/quickstart.md @@ -31,7 +31,7 @@ This guide will lead you through creating a user site at `username.github.io`. 1. Under "Build and deployment", under "Branch", use the branch dropdown menu and select a publishing source. ![Screenshot of Pages settings in a {% data variables.product.prodname_dotcom %} repository. A menu to select a branch for a publishing source, labeled "None," is outlined in dark orange.](/assets/images/help/pages/publishing-source-drop-down.png) 1. Optionally, open the `README.md` file of your repository. The `README.md` file is where you will write the content for your site. You can edit the file or keep the default content for now. -2. Visit `username.github.io` to view your new website. Note that it can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +1. Visit `username.github.io` to view your new website. Note that it can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. ## Changing the title and description diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 44128624a774..f3c1930b324a 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -81,7 +81,7 @@ You can configure a third-party service, such as [Travis CI](https://travis-ci.c gem `github-pages` ``` -2. Configure your site's repository for the testing service of your choice. For example, to use [Travis CI](https://travis-ci.com/), add a file named _.travis.yml_ in the root of your publishing source, with the following content: +1. Configure your site's repository for the testing service of your choice. For example, to use [Travis CI](https://travis-ci.com/), add a file named _.travis.yml_ in the root of your publishing source, with the following content: ```yaml language: ruby @@ -90,4 +90,4 @@ You can configure a third-party service, such as [Travis CI](https://travis-ci.c script: "bundle exec jekyll build" ``` -3. You may need to activate your repository with the third-party testing service. For more information, see your testing service's documentation. +1. You may need to activate your repository with the third-party testing service. For more information, see your testing service's documentation. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index fcf3302e97da..2aa5b310dc33 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -26,9 +26,9 @@ People with write permissions for a repository can add a theme to a {% data vari {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} -2. Navigate to __config.yml_. +1. Navigate to __config.yml_. {% data reusables.repositories.edit-file %} -4. Add a new line to the file for the theme name. +1. Add a new line to the file for the theme name. - To use a supported theme, type `theme: THEME-NAME`, replacing _THEME-NAME_ with the name of the theme as shown in the README of the theme's repository. For a list of supported themes, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site. For example, to select the Minima theme, type `theme: minima`. - To use any other Jekyll theme hosted on {% data variables.product.prodname_dotcom %}, type `remote_theme: THEME-NAME`, replacing THEME-NAME with the name of the theme as shown in the README of the theme's repository. {% data reusables.files.write_commit_message %} @@ -45,7 +45,7 @@ People with write permissions for a repository can add a theme to a {% data vari {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} 1. Create a new file called _/assets/css/style.scss_. -2. Add the following content to the top of the file: +1. Add the following content to the top of the file: ```scss --- @@ -54,7 +54,7 @@ People with write permissions for a repository can add a theme to a {% data vari @import "{% raw %}{{ site.theme }}{% endraw %}"; ``` -3. Add any custom CSS or Sass (including imports) you'd like immediately after the `@import` line. +1. Add any custom CSS or Sass (including imports) you'd like immediately after the `@import` line. ## Customizing your theme's HTML layout @@ -63,13 +63,13 @@ People with write permissions for a repository can add a theme to a {% data vari {% data reusables.pages.theme-customization-help %} 1. On {% data variables.product.prodname_dotcom %}, navigate to your theme's source repository. For example, the source repository for Minima is https://github.com/jekyll/minima. -2. In the __layouts_ folder, navigate to your theme's _default.html_ file. -3. Copy the contents of the file. +1. In the __layouts_ folder, navigate to your theme's _default.html_ file. +1. Copy the contents of the file. {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} -6. Create a file called __layouts/default.html_. -7. Paste the default layout content you copied earlier. -8. Customize the layout as you'd like. +1. Create a file called __layouts/default.html_. +1. Paste the default layout content you copied earlier. +1. Customize the layout as you'd like. ## Further reading diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md index a0b1356001a9..6c593daef338 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md @@ -35,8 +35,8 @@ Your theme includes default layouts, includes, and stylesheets that will automat {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} -3. In the root of your publishing source, create a new file for your page called `PAGE-NAME.md`, replacing PAGE-NAME with a meaningful filename for the page. -4. Add the following YAML frontmatter to the top of the file, replacing PAGE-TITLE with the page's title and URL-PATH with a path you want for the page's URL. For example, if the base URL of your site is `https://octocat.github.io` and your URL-PATH is `/about/contact/`, your page will be located at `https://octocat.github.io/about/contact`. +1. In the root of your publishing source, create a new file for your page called `PAGE-NAME.md`, replacing PAGE-NAME with a meaningful filename for the page. +1. Add the following YAML frontmatter to the top of the file, replacing PAGE-TITLE with the page's title and URL-PATH with a path you want for the page's URL. For example, if the base URL of your site is `https://octocat.github.io` and your URL-PATH is `/about/contact/`, your page will be located at `https://octocat.github.io/about/contact`. ```shell layout: page @@ -44,7 +44,7 @@ Your theme includes default layouts, includes, and stylesheets that will automat permalink: /URL-PATH ``` -5. Below the frontmatter, add content for your page. +1. Below the frontmatter, add content for your page. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} @@ -59,9 +59,9 @@ Your theme includes default layouts, includes, and stylesheets that will automat {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} -3. Navigate to the `_posts` directory. -4. Create a new file called `YYYY-MM-DD-NAME-OF-POST.md`, replacing YYYY-MM-DD with the date of your post and NAME-OF-POST with the name of your post. -5. Add the following YAML frontmatter to the top of the file, including the post's title enclosed in quotation marks, the date and time for the post in YYYY-MM-DD hh:mm:ss -0000 format, and as many categories as you want for your post. +1. Navigate to the `_posts` directory. +1. Create a new file called `YYYY-MM-DD-NAME-OF-POST.md`, replacing YYYY-MM-DD with the date of your post and NAME-OF-POST with the name of your post. +1. Add the following YAML frontmatter to the top of the file, including the post's title enclosed in quotation marks, the date and time for the post in YYYY-MM-DD hh:mm:ss -0000 format, and as many categories as you want for your post. ```shell layout: post @@ -70,7 +70,7 @@ Your theme includes default layouts, includes, and stylesheets that will automat categories: CATEGORY-1 CATEGORY-2 ``` -5. Below the frontmatter, add content for your post. +1. Below the frontmatter, add content for your post. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md index 2548b5831b23..dc9e6913cb4b 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md @@ -24,9 +24,9 @@ People with write permissions for a repository can set the Markdown processor fo You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with either processor, but only our GFM processor will always match the results you see on {% data variables.product.product_name %}. {% data reusables.pages.navigate-site-repo %} -2. In your repository, browse to the __config.yml_ file. +1. In your repository, browse to the __config.yml_ file. {% data reusables.repositories.edit-file %} -4. Find the line that starts with `markdown:` and change the value to `kramdown` or `GFM`. The full line should read `markdown: kramdown` or `markdown: GFM`. +1. Find the line that starts with `markdown:` and change the value to `kramdown` or `GFM`. The full line should read `markdown: kramdown` or `markdown: GFM`. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md index db5e6a6f2498..bcadafd9ae69 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md @@ -33,8 +33,8 @@ Before you can use Jekyll to test a site, you must: {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.pages.navigate-publishing-source %} -3. Run `bundle install`. -3. Run your Jekyll site locally. +1. Run `bundle install`. +1. Run your Jekyll site locally. ```shell $ bundle exec jekyll serve @@ -57,14 +57,14 @@ Before you can use Jekyll to test a site, you must: To fix the error, try running `bundle add webrick`, then re-running `bundle exec jekyll serve`. {% endnote %} -3. To preview your site, in your web browser, navigate to `http://localhost:4000`. +1. To preview your site, in your web browser, navigate to `http://localhost:4000`. ## Updating the {% data variables.product.prodname_pages %} gem Jekyll is an active open source project that is updated frequently. If the `github-pages` gem on your computer is out of date with the `github-pages` gem on the {% data variables.product.prodname_pages %} server, your site may look different when built locally than when published on {% data variables.product.product_name %}. To avoid this, regularly update the `github-pages` gem on your computer. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Update the `github-pages` gem. +1. Update the `github-pages` gem. - If you installed Bundler, run `bundle update github-pages`. - If you don't have Bundler installed, run `gem update github-pages`. diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index b072d77f5cef..664217a522a8 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -31,14 +31,14 @@ To resolve a merge conflict caused by competing line changes, you must choose wh For example, if you and another person both edited the file _styleguide.md_ on the same lines in different branches of the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navigate into the local Git repository that has the merge conflict. +1. Navigate into the local Git repository that has the merge conflict. ```shell cd REPOSITORY-NAME ``` -3. Generate a list of the files affected by the merge conflict. In this example, the file _styleguide.md_ has a merge conflict. - +1. Generate a list of the files affected by the merge conflict. In this example, the file _styleguide.md_ has a merge conflict. + ```shell $ git status > # On branch branch-b @@ -53,8 +53,8 @@ For example, if you and another person both edited the file _styleguide.md_ on t > no changes added to commit (use "git add" and/or "git commit -a") ``` -4. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. -5. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`. +1. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. +1. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`. ``` If you have questions, please @@ -71,13 +71,13 @@ For example, if you and another person both edited the file _styleguide.md_ on t If you have questions, please open an issue or ask in our IRC channel if it's more urgent. ``` -7. Add or stage your changes. +1. Add or stage your changes. ```shell git add . ``` -8. Commit your changes with a comment. +1. Commit your changes with a comment. ```shell git commit -m "Resolved merge conflict by incorporating both suggestions." @@ -92,14 +92,14 @@ To resolve a merge conflict caused by competing changes to a file, where a perso For example, if you edited a file, such as _README.md_, and another person removed the same file in another branch in the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navigate into the local Git repository that has the merge conflict. +1. Navigate into the local Git repository that has the merge conflict. ```shell cd REPOSITORY-NAME ``` -2. Generate a list of the files affected by the merge conflict. In this example, the file _README.md_ has a merge conflict. - +1. Generate a list of the files affected by the merge conflict. In this example, the file _README.md_ has a merge conflict. + ```shell $ git status > # On branch main @@ -117,8 +117,8 @@ For example, if you edited a file, such as _README.md_, and another person remov > # no changes added to commit (use "git add" and/or "git commit -a") ``` -3. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. -6. Decide if you want to keep the removed file. You may want to view the latest changes made to the removed file in your text editor. +1. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. +1. Decide if you want to keep the removed file. You may want to view the latest changes made to the removed file in your text editor. To add the removed file back to your repository: @@ -134,7 +134,7 @@ For example, if you edited a file, such as _README.md_, and another person remov > rm 'README.md' ``` -7. Commit your changes with a comment. +1. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by keeping README.md file." diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md index 2580c160232e..5aec538d67c0 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md @@ -60,7 +60,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u **Note:** Rebase and merge will always update the committer information and create new commit SHAs. For more information, see "[About pull request merges](/articles/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)." {% endnote %} -2. If prompted, type a commit message, or accept the default message. +1. If prompted, type a commit message, or accept the default message. {% data reusables.pull_requests.default-commit-message-squash-merge %} {% data reusables.files.choose-commit-email %} @@ -71,7 +71,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u {% endnote %} 1. Click **Confirm merge**, **Confirm squash and merge**, or **Confirm rebase and merge**. -2. Optionally, [delete the branch](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request). This keeps the list of branches in your repository tidy. +1. Optionally, [delete the branch](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request). This keeps the list of branches in your repository tidy. {% endwebui %} diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md index db0f7bc95a7a..bdbb39af0c39 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md @@ -32,9 +32,9 @@ For more information about using Git to manually revert individual commits, see {% endnote %} {% data reusables.repositories.sidebar-pr %} -2. In the "Pull Requests" list, click the pull request you'd like to revert. -3. Near the bottom of the pull request, click **Revert**. If the **Revert** option isn't displayed, you'll need to ask the repository administrator for write permissions. +1. In the "Pull Requests" list, click the pull request you'd like to revert. +1. Near the bottom of the pull request, click **Revert**. If the **Revert** option isn't displayed, you'll need to ask the repository administrator for write permissions. ![Screenshot of a pull request's timeline. The "Revert" button is outlined in dark orange.](/assets/images/help/pull_requests/revert-pull-request-link.png) -4. Merge the resulting pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." +1. Merge the resulting pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md index b351198f0a5f..5b64cc743f84 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md @@ -28,8 +28,8 @@ shortTitle: Change the state {% endtip %} {% data reusables.repositories.sidebar-pr %} -2. In the "Pull requests" list, click the pull request you'd like to mark as ready for review. -3. In the merge box, click **Ready for review**. +1. In the "Pull requests" list, click the pull request you'd like to mark as ready for review. +1. In the merge box, click **Ready for review**. ![Screenshot of the merge box in a pull request. The "Ready for review" button is outlined in dark orange.](/assets/images/help/pull_requests/ready-for-review-button.png) @@ -38,12 +38,12 @@ shortTitle: Change the state You can convert a pull request to a draft at any time. For example, if you accidentally opened a pull request instead of a draft, or if you've received feedback on your pull request that needs to be addressed, you can convert the pull request to a draft to indicate further changes are needed. No one can merge the pull request until you mark the pull request as ready for review again. People who are already subscribed to notifications for the pull request will not be unsubscribed when you convert the pull request to a draft. {% data reusables.repositories.sidebar-pr %} -2. In the "Pull requests" list, click the pull request you'd like to convert to a draft. -3. In the right sidebar, under "Reviewers," click **Convert to draft**. +1. In the "Pull requests" list, click the pull request you'd like to convert to a draft. +1. In the right sidebar, under "Reviewers," click **Convert to draft**. ![Screenshot of the "Reviewers" section in the right sidebar of a pull request. The "Convert to draft" link is outlined in dark orange.](/assets/images/help/pull_requests/convert-to-draft-link.png) -4. Click **Convert to draft**. +1. Click **Convert to draft**. ## Further reading diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md index 5b67df87804b..0449a8a88a62 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -37,19 +37,19 @@ Only the user who created the pull request can give you permission to push commi **Tip:** If you prefer to clone the fork using {% data variables.product.prodname_desktop %}, then see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository#cloning-a-repository-to-github-desktop)." {% endtip %} -4. Change the current working directory to the location where you want to download the cloned directory. +1. Change the current working directory to the location where you want to download the cloned directory. ```shell cd open-source-projects ``` -5. Type `git clone`, and then paste the URL you copied in Step 3. +1. Type `git clone`, and then paste the URL you copied in Step 3. ```shell git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY ``` -6. Press **Enter**. Your local clone will be created. +1. Press **Enter**. Your local clone will be created. ```shell $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY @@ -65,13 +65,13 @@ Only the user who created the pull request can give you permission to push commi **Tip:** The error message "fatal: destination path 'REPOSITORY-NAME' already exists and is not an empty directory" means that your current working directory already contains a repository with the same name. To resolve the error, you must clone the fork in a different directory. {% endtip %} -7. Navigate into your new cloned repository. +1. Navigate into your new cloned repository. ```shell cd FORK-OF-THE-REPOSITORY ``` -7. Switch branches to the compare branch of the pull request where the original changes were made. If you navigate to the original pull request, you'll see the compare branch at the top of the pull request. +1. Switch branches to the compare branch of the pull request where the original changes were made. If you navigate to the original pull request, you'll see the compare branch at the top of the pull request. In this example, the compare branch is `test-branch`: @@ -84,8 +84,8 @@ Only the user who created the pull request can give you permission to push commi **Tip:** For more information about pull request branches, including examples, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)." {% endtip %} -8. At this point, you can do anything you want with this branch. You can push new commits to it, run some local tests, or merge other branches into the branch. Make modifications as you like. -9. After you commit your changes to the head branch of the pull request you can push your changes up to the original pull request directly. In this example, the head branch is `test-branch`: +1. At this point, you can do anything you want with this branch. You can push new commits to it, run some local tests, or merge other branches into the branch. Make modifications as you like. +1. After you commit your changes to the head branch of the pull request you can push your changes up to the original pull request directly. In this example, the head branch is `test-branch`: ```shell $ git push origin test-branch diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md index c8b5c32190f1..eeace688d592 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md @@ -30,10 +30,10 @@ You can comment on a pull request, approve the changes, or request improvements {% data reusables.repositories.sidebar-pr %} {% data reusables.repositories.choose-pr-review %} {% data reusables.repositories.changed-files %} -4. Review the changes in the pull request, and optionally, comment on specific lines{% ifversion pull-request-comment-on-file %} or files{% endif %}. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#starting-a-review)." +1. Review the changes in the pull request, and optionally, comment on specific lines{% ifversion pull-request-comment-on-file %} or files{% endif %}. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#starting-a-review)." {% data reusables.repositories.review-changes %} {% data reusables.repositories.review-summary-comment %} -7. Select **Approve** to approve merging the changes proposed in the pull request. +1. Select **Approve** to approve merging the changes proposed in the pull request. {% data reusables.repositories.submit-review %} {% data reusables.repositories.request-changes-tips %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md index ca8054633787..cc0c7af569d8 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md @@ -63,27 +63,27 @@ Once a pull request is opened, {% data variables.product.product_name %} stores Anyone can work with a previously opened pull request to continue working on it, test it out, or even open a new pull request with additional changes. However, only collaborators with push access can merge pull requests. {% data reusables.repositories.sidebar-issue-pr %} -2. In the "Pull Requests" list, click the pull request you'd like to merge. -3. Find the ID number of the inactive pull request. This is the sequence of digits right after the pull request's title. +1. In the "Pull Requests" list, click the pull request you'd like to merge. +1. Find the ID number of the inactive pull request. This is the sequence of digits right after the pull request's title. ![Screenshot of the title of a pull request. The pull request's ID number is outlined in dark orange.](/assets/images/help/pull_requests/pull_request_id_number.png) {% data reusables.command_line.open_the_multi_os_terminal %} -5. Fetch the reference to the pull request based on its ID number, creating a new branch in the process. +1. Fetch the reference to the pull request based on its ID number, creating a new branch in the process. ```shell git fetch origin pull/ID/head:BRANCH_NAME ``` -6. Switch to the new branch that's based on this pull request: +1. Switch to the new branch that's based on this pull request: ```shell [main] $ git checkout BRANCH_NAME > Switched to a new branch 'BRANCH_NAME' ``` -7. At this point, you can do anything you want with this branch. You can run some local tests, or merge other branches into the branch. -8. When you're ready, you can push the new branch up: +1. At this point, you can do anything you want with this branch. You can run some local tests, or merge other branches into the branch. +1. When you're ready, you can push the new branch up: ```shell [pull-inactive-pull-request] $ git push origin BRANCH_NAME @@ -96,7 +96,7 @@ Anyone can work with a previously opened pull request to continue working on it, > * [new branch] BRANCH_NAME -> BRANCH_NAME ``` -9. [Create a new pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) with your new branch. +1. [Create a new pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) with your new branch. ## Error: Failed to push some refs diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md index 66c62c8879e4..c1902591f234 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request.md @@ -24,8 +24,8 @@ To quickly incorporate more than one suggested change into a single commit, you Each person who suggested a change included in the commit will be a co-author of the commit. The person who applies the suggested changes will be a co-author and the committer of the commit. For more information about the term committer in Git, see "[Git Basics - Viewing the Commit History](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History)" from the _Pro Git_ book site. {% data reusables.repositories.sidebar-pr %} -2. In the list of pull requests, click the pull request you'd like to apply a suggested change to. -3. Navigate to the first suggested change you'd like to apply. +1. In the list of pull requests, click the pull request you'd like to apply a suggested change to. +1. Navigate to the first suggested change you'd like to apply. - To apply the change in its own commit, click **Commit suggestion**. ![Screenshot of a review comment with a suggestion. The "Commit suggestion" option is outlined in dark orange.](/assets/images/help/pull_requests/commit-suggestion-button.png) diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index 2305b1e1225c..40d41804326c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -63,7 +63,7 @@ You can configure the {% data variables.dependency-review.action_name %} to bett ![Screenshot of the "Files changed" tab of a pull request. The button to display the rich diff, labeled with a file icon, is outlined in dark orange.](/assets/images/help/pull_requests/dependency-review-rich-diff.png) -2. Check the dependencies listed in the dependency review. +1. Check the dependencies listed in the dependency review. ![Screenshot of the vulnerability warnings in a dependency review for a pull request.](/assets/images/help/pull_requests/dependency-review-vulnerability.png) diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index 53ea147a0c0f..46cfe63fa496 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -53,19 +53,19 @@ Before you submit your review, your line comments are _pending_ and only visible You can use [{% data variables.product.prodname_github_codespaces %}](/codespaces/overview) to test, run, and review pull requests. 1. Open the pull request in a codespace, as described in "[AUTOTITLE](/codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests#opening-a-pull-request-in-codespaces)." -2. In the Activity Bar, click the **GitHub Pull Request** view. This view only appears when you open a pull request in a codespace. +1. In the Activity Bar, click the **GitHub Pull Request** view. This view only appears when you open a pull request in a codespace. ![Screenshot of the {% data variables.product.prodname_vscode_shortname %} Activity Bar. The mouse pointer is hovering over an icon displaying the tooltip "{% data variables.product.prodname_dotcom %} Pull Request."](/assets/images/help/codespaces/github-pr-view.png) -3. To review a specific file, click the **Open File** icon in the Side Bar. +1. To review a specific file, click the **Open File** icon in the Side Bar. ![Screenshot of the "{% data variables.product.prodname_dotcom %} Pull Request" side bar. A file name is highlighted with a dark orange outline.](/assets/images/help/codespaces/changes-in-files.png) -4. To add review comments, click the **+** icon next to the line number. Type your review comment and then click **Start Review**. +1. To add review comments, click the **+** icon next to the line number. Type your review comment and then click **Start Review**. ![Screenshot of a comment being added, reading "Yes, I agree, this is clearer." The "Start Review" button is shown below the comment.](/assets/images/help/codespaces/start-review.png) -5. When you are finished adding review comments, from the Side Bar you can choose to either submit the comments, approve the changes, or request changes. +1. When you are finished adding review comments, from the Side Bar you can choose to either submit the comments, approve the changes, or request changes. ![Screenshot of the side bar showing the dropdown options "Comment and Submit," "Approve and Submit," and "Request Changes and Submit."](/assets/images/help/codespaces/submit-review.png) @@ -105,7 +105,7 @@ After you've finished reviewing all the files you want in the pull request, subm {% data reusables.repositories.changed-files %} {% data reusables.repositories.review-changes %} {% data reusables.repositories.review-summary-comment %} -4. Select the type of review you'd like to leave: +1. Select the type of review you'd like to leave: - Select **Comment** to leave general feedback without explicitly approving the changes or requesting additional changes. - Select **Approve** to submit your feedback and approve merging the changes proposed in the pull request. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md index c9639198e7b0..1cd03f37e1dc 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md @@ -17,7 +17,7 @@ topics: shortTitle: Configure a remote repository --- {% data reusables.command_line.open_the_multi_os_terminal %} -2. List the current configured remote repository for your fork. +1. List the current configured remote repository for your fork. ```shell $ git remote -v @@ -25,13 +25,13 @@ shortTitle: Configure a remote repository > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) ``` -3. Specify a new remote _upstream_ repository that will be synced with the fork. - +1. Specify a new remote _upstream_ repository that will be synced with the fork. + ```shell git remote add upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git ``` -4. Verify the new upstream repository you've specified for your fork. +1. Verify the new upstream repository you've specified for your fork. ```shell $ git remote -v diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md index d3a9c93765eb..84210629dda7 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md @@ -56,8 +56,8 @@ If the changes from the upstream repository cause conflict then the {% data vari Before you can sync your fork with an upstream repository, you must configure a remote that points to the upstream repository in Git. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork)." {% data reusables.command_line.open_the_multi_os_terminal %} -2. Change the current working directory to your local project. -3. Fetch the branches and their respective commits from the upstream repository. Commits to `BRANCHNAME` will be stored in the local branch `upstream/BRANCHNAME`. +1. Change the current working directory to your local project. +1. Fetch the branches and their respective commits from the upstream repository. Commits to `BRANCHNAME` will be stored in the local branch `upstream/BRANCHNAME`. ```shell $ git fetch upstream @@ -69,14 +69,14 @@ Before you can sync your fork with an upstream repository, you must configure a > * [new branch] main -> upstream/main ``` -4. Check out your fork's local default branch - in this case, we use `main`. +1. Check out your fork's local default branch - in this case, we use `main`. ```shell $ git checkout main > Switched to branch 'main' ``` -5. Merge the changes from the upstream default branch - in this case, `upstream/main` - into your local default branch. This brings your fork's default branch into sync with the upstream repository, without losing your local changes. +1. Merge the changes from the upstream default branch - in this case, `upstream/main` - into your local default branch. This brings your fork's default branch into sync with the upstream repository, without losing your local changes. ```shell $ git merge upstream/main diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md index 458daabedfa9..6089f49bfcf7 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md @@ -34,7 +34,7 @@ You can see which branch a commit is on by looking at the labels beneath the com {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-commit-page %} {% data reusables.repositories.navigate-to-commit %} -2. To see what branch the commit is on, check the label below the commit message. +1. To see what branch the commit is on, check the label below the commit message. ![Screenshot of a commit summary. A branch icon and "main" are highlighted with an orange outline.](/assets/images/help/commits/commit-branch-indicator.png) diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md index 515abb67fe03..f31ac833a45a 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md @@ -23,8 +23,8 @@ In Git, the text of the commit message is part of the commit. Changing the commi If the commit only exists in your local repository and has not been pushed to {% data variables.location.product_location %}, you can amend the commit message with the `git commit --amend` command. 1. On the command line, navigate to the repository that contains the commit you want to amend. -2. Type `git commit --amend` and press **Enter**. -3. In your text editor, edit the commit message, and save the commit. +1. Type `git commit --amend` and press **Enter**. +1. In your text editor, edit the commit message, and save the commit. - You can add a co-author by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)." {% ifversion fpt or ghec %} - You can create commits on behalf of your organization by adding a trailer to the commit. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization)" @@ -51,7 +51,7 @@ We strongly discourage force pushing, since this changes the history of your rep **Changing the message of the most recently pushed commit** 1. Follow the [steps above](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message#commit-has-not-been-pushed-online) to amend the commit message. -2. Use the `push --force-with-lease` command to force push over the old commit. +1. Use the `push --force-with-lease` command to force push over the old commit. ```shell git push --force-with-lease origin EXAMPLE-BRANCH @@ -62,7 +62,7 @@ We strongly discourage force pushing, since this changes the history of your rep If you need to amend the message for multiple commits or an older commit, you can use interactive rebase, then force push to change the commit history. 1. On the command line, navigate to the repository that contains the commit you want to amend. -2. Use the `git rebase -i HEAD~n` command to display a list of the last `n` commits in your default text editor. +1. Use the `git rebase -i HEAD~n` command to display a list of the last `n` commits in your default text editor. ```shell # Displays a list of the last 3 commits on the current branch @@ -95,7 +95,7 @@ If you need to amend the message for multiple commits or an older commit, you ca # Note that empty commits are commented out ``` -3. Replace `pick` with `reword` before each commit message you want to change. +1. Replace `pick` with `reword` before each commit message you want to change. ```shell pick e499d89 Delete CNAME @@ -103,9 +103,9 @@ If you need to amend the message for multiple commits or an older commit, you ca reword f7fde4a Change the commit message but push the same commit. ``` -4. Save and close the commit list file. -5. In each resulting commit file, type the new commit message, save the file, and close it. -6. When you're ready to push your changes to GitHub, use the push --force command to force push over the old commit. +1. Save and close the commit list file. +1. In each resulting commit file, type the new commit message, save the file, and close it. +1. When you're ready to push your changes to GitHub, use the push --force command to force push over the old commit. ```shell git push --force origin EXAMPLE-BRANCH diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index b344fc4e39b3..e57e42ce019a 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -43,7 +43,7 @@ Organizations can use the `name@organization.com` email as a public point of con {% endtip %} -2. On the next line of the commit message, type `on-behalf-of: @org `, then a closing quotation mark. +1. On the next line of the commit message, type `on-behalf-of: @org `, then a closing quotation mark. ```shell $ git commit -m "Refactor usability tests. diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md index 2ff4bcaed232..092dda94e88d 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md @@ -54,7 +54,7 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit {% endtip %} -3. On the next line of the commit message, type `Co-authored-by: name ` with specific information for each co-author. After the co-author information, add a closing quotation mark. +1. On the next line of the commit message, type `Co-authored-by: name ` with specific information for each co-author. After the co-author information, add a closing quotation mark. If you're adding multiple co-authors, give each co-author their own line and `Co-authored-by:` commit trailer. diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md index 87c31efdd9f6..2246e015db58 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md @@ -24,7 +24,7 @@ shortTitle: Linked to wrong user If your commits are linked to another user, that means the email address in your local Git configuration settings is connected to that user's account on {% data variables.product.product_name %}. In this case, you can change the email in your local Git configuration settings{% ifversion ghae %} to the address associated with your account on {% data variables.product.product_name %} to link your future commits. Old commits will not be linked. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %} and add the new email address to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} account to link future commits to your account. 1. To change the email address in your local Git configuration, follow the steps in "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git)". If you work on multiple machines, you will need to change this setting on each one. -2. Add the email address from step 2 to your account settings by following the steps in "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)".{% endif %} +1. Add the email address from step 2 to your account settings by following the steps in "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)".{% endif %} Commits you make from this point forward will be linked to your account. @@ -35,7 +35,7 @@ If your commits are not linked to any user, the commit author's name will not be {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-commit-page %} {% data reusables.repositories.navigate-to-commit %} -2. To read a message about why the commit is not linked, hover over the blue {% octicon "question" aria-label="Question mark" %} to the right of the username. +1. To read a message about why the commit is not linked, hover over the blue {% octicon "question" aria-label="Question mark" %} to the right of the username. - **Unrecognized author (with email address)** If you see this message with an email address, the address you used to author the commit is not connected to your account on {% data variables.product.product_name %}. {% ifversion not ghae %}To link your commits, [add the email address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account).{% endif %}{% ifversion not ghae %} If the email address has a Gravatar associated with it, the Gravatar will be displayed next to the commit, rather than the default gray Octocat.{% endif %} - **Unrecognized author (no email address)** If you see this message without an email address, you used a generic email address that can't be connected to your account on {% data variables.product.product_name %}.{% ifversion not ghae %} You will need to [set your commit email address in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address), then [add the new address to your GitHub email settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to link your future commits. Old commits will not be linked.{% endif %} diff --git a/content/repositories/archiving-a-github-repository/archiving-repositories.md b/content/repositories/archiving-a-github-repository/archiving-repositories.md index b03ab3f61b25..4a48b5fdaf72 100644 --- a/content/repositories/archiving-a-github-repository/archiving-repositories.md +++ b/content/repositories/archiving-a-github-repository/archiving-repositories.md @@ -53,11 +53,11 @@ To archive all repositories in an organization at once, you can archive the enti {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under "Danger Zone", click **Archive this repository** -4. Read the warnings. -5. In the text field, type the name of the repository you want to archive. +1. Under "Danger Zone", click **Archive this repository** +1. Read the warnings. +1. In the text field, type the name of the repository you want to archive. ![Screenshot showing the "Archive repository" dialog box.](/assets/images/help/repository/archive-repository-warnings.png) -6. Click **I understand the consequences, archive this repository**. +1. Click **I understand the consequences, archive this repository**. ## Unarchiving a repository diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches.md index c4dae43e7efb..6412a98d004d 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches.md @@ -22,4 +22,4 @@ If you enable the setting to always suggest updating pull request branches in yo {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under "Pull Requests", select or unselect **Always suggest updating pull request branches**. +1. Under "Pull Requests", select or unselect **Always suggest updating pull request branches**. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md index 7448acaf91ce..d486f776b45e 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches.md @@ -18,7 +18,7 @@ Anyone with admin permissions to a repository can enable or disable the automati {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select or unselect **Automatically delete head branches**. +1. Under {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select or unselect **Automatically delete head branches**. ## Further reading diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md index a0d7dad78b64..3168cd2fed8e 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request.md @@ -24,8 +24,8 @@ You can delete a branch that is associated with a pull request if the pull reque {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %} {% data reusables.repositories.list-closed-pull-requests %} -4. In the list of pull requests, click the pull request that's associated with the branch that you want to delete. -5. Near the bottom of the pull request, click **Delete branch**. +1. In the list of pull requests, click the pull request that's associated with the branch that you want to delete. +1. Near the bottom of the pull request, click **Delete branch**. This button isn't displayed if there's currently an open pull request for this branch. @@ -36,8 +36,8 @@ You can restore the head branch of a closed pull request. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %} {% data reusables.repositories.list-closed-pull-requests %} -4. In the list of pull requests, click the pull request that's associated with the branch that you want to restore. -5. Near the bottom of the pull request, click **Restore branch**. +1. In the list of pull requests, click the pull request that's associated with the branch that you want to restore. +1. Near the bottom of the pull request, click **Restore branch**. ## Further reading diff --git a/content/repositories/creating-and-managing-repositories/cloning-a-repository.md b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md index 56f29ee4d0fc..914937e888b6 100644 --- a/content/repositories/creating-and-managing-repositories/cloning-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md @@ -73,7 +73,7 @@ gh repo clone https://github.com/PATH-TO/REPOSITORY {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.open-with-github-desktop %} -4. Follow the prompts in {% data variables.product.prodname_desktop %} to complete the clone. +1. Follow the prompts in {% data variables.product.prodname_desktop %} to complete the clone. For more information, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop)." diff --git a/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md b/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md index e5428dc4c829..2c20b2397665 100644 --- a/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-an-issues-only-repository.md @@ -17,9 +17,9 @@ topics: shortTitle: Issues-only repository --- 1. Create a **private** repository to host the source code from your project. -2. Create a second repository with the permissions you desire to host the issue tracker. -3. Add a README file to the issues repository explaining the purpose of this repository and linking to the issues section. -4. Set your collaborators or teams to give access to the repositories as you desire. +1. Create a second repository with the permissions you desire to host the issue tracker. +1. Add a README file to the issues repository explaining the purpose of this repository and linking to the issues section. +1. Set your collaborators or teams to give access to the repositories as you desire. Users with write access to both can reference and close issues back and forth across the repositories, but those without the required permissions will see references that contain a minimum of information. diff --git a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md index 43e9e027f3aa..4b3af599d3c2 100644 --- a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md @@ -29,20 +29,20 @@ Before you can push the original repository to your new copy, or _mirror_, of th ## Mirroring a repository {% data reusables.command_line.open_the_multi_os_terminal %} -2. Create a bare clone of the repository. +1. Create a bare clone of the repository. ```shell git clone --bare https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/OLD-REPOSITORY.git ``` -3. Mirror-push to the new repository. +1. Mirror-push to the new repository. ```shell cd OLD-REPOSITORY.git git push --mirror https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/NEW-REPOSITORY.git ``` -4. Remove the temporary local repository you created earlier. +1. Remove the temporary local repository you created earlier. ```shell cd .. @@ -52,37 +52,37 @@ Before you can push the original repository to your new copy, or _mirror_, of th ## Mirroring a repository that contains {% data variables.large_files.product_name_long %} objects {% data reusables.command_line.open_the_multi_os_terminal %} -2. Create a bare clone of the repository. Replace the example username with the name of the person or organization who owns the repository, and replace the example repository name with the name of the repository you'd like to duplicate. +1. Create a bare clone of the repository. Replace the example username with the name of the person or organization who owns the repository, and replace the example repository name with the name of the repository you'd like to duplicate. ```shell git clone --bare https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/OLD-REPOSITORY.git ``` -3. Navigate to the repository you just cloned. +1. Navigate to the repository you just cloned. ```shell cd OLD-REPOSITORY.git ``` -4. Pull in the repository's {% data variables.large_files.product_name_long %} objects. +1. Pull in the repository's {% data variables.large_files.product_name_long %} objects. ```shell git lfs fetch --all ``` -5. Mirror-push to the new repository. +1. Mirror-push to the new repository. ```shell git push --mirror https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/NEW-REPOSITORY.git ``` -6. Push the repository's {% data variables.large_files.product_name_long %} objects to your mirror. +1. Push the repository's {% data variables.large_files.product_name_long %} objects to your mirror. ```shell git lfs push --all https://github.com/EXAMPLE-USER/NEW-REPOSITORY.git ``` -7. Remove the temporary local repository you created earlier. +1. Remove the temporary local repository you created earlier. ```shell cd .. @@ -94,13 +94,13 @@ Before you can push the original repository to your new copy, or _mirror_, of th If you want to mirror a repository in another location, including getting updates from the original, you can clone a mirror and periodically push the changes. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Create a bare mirrored clone of the repository. +1. Create a bare mirrored clone of the repository. ```shell git clone --mirror https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/REPOSITORY-TO-MIRROR.git ``` -3. Set the push location to your mirror. +1. Set the push location to your mirror. ```shell cd REPOSITORY-TO-MIRROR @@ -109,7 +109,7 @@ If you want to mirror a repository in another location, including getting update As with a bare clone, a mirrored clone includes all remote branches and tags, but all local references will be overwritten each time you fetch, so it will always be the same as the original repository. Setting the URL for pushes simplifies pushing to your mirror. -4. To update your mirror, fetch updates and push. +1. To update your mirror, fetch updates and push. ```shell git fetch -p origin diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index 0646a463c7af..df0f5ae85a4a 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -46,13 +46,13 @@ When creating a topic: {% endnote %} {% data reusables.repositories.navigate-to-repo %} -2. In the top right corner of the page, to the right of "About", click {% octicon "gear" aria-label="Edit repository metadata" %}. +1. In the top right corner of the page, to the right of "About", click {% octicon "gear" aria-label="Edit repository metadata" %}. ![Screenshot of the top right of the main page for a repository. The "Edit repository metadata" button, shown as a gear icon, is outlined in orange.](/assets/images/help/repository/edit-repository-details-gear.png) -3. Under "Topics", start to type the topic you want to add to your repository to display a dropdown menu of any matching topics. Click the topic you want to add or continue typing to create a new topic. +1. Under "Topics", start to type the topic you want to add to your repository to display a dropdown menu of any matching topics. Click the topic you want to add or continue typing to create a new topic. ![Screenshot of the "Topics" field showing example topics: "docs" and "works-with-codespaces." A "Suggested" topic "documentation" is shown below.](/assets/images/help/repository/add-topic-form.png) -4. Optional, if there are "Suggested" topics displayed under the "Topics" field, click {% octicon "plus" aria-label="Add this topic" %} to add or {% octicon "dash" aria-label="Decline this topic" %} to decline the suggested topic. -5. After you've finished adding topics, click **Save changes**. +1. Optional, if there are "Suggested" topics displayed under the "Topics" field, click {% octicon "plus" aria-label="Add this topic" %} to add or {% octicon "dash" aria-label="Decline this topic" %} to decline the suggested topic. +1. After you've finished adding topics, click **Save changes**. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md index 0b73136d7dae..0c09a52d919a 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md @@ -28,7 +28,7 @@ Until you add an image, repository links expand to show basic information about {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under "Social preview," click **Edit** +1. Under "Social preview," click **Edit** - To add a new image, click **Upload an image...**. - To remove an image, click **Remove image** diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md index ffb489917395..c6fbfa41c03b 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues.md @@ -16,7 +16,7 @@ topics: --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under "Features," deselect **Issues**. +1. Under "Features," deselect **Issues**. If you decide to enable issues again in the future, any issues that were previously added will be available. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md index 14788593da7d..b9333fa657aa 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md @@ -20,6 +20,6 @@ When you disable {% data variables.projects.projects_v1_boards %}, you will no l {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under "Features," unselect the **Projects** checkbox. +1. Under "Features," unselect the **Projects** checkbox. After {% data variables.projects.projects_v1_boards %} are disabled, existing {% data variables.projects.projects_v1_boards %} are inaccessible at their previous URLs. If you decide to re-enable project boards, any project boards that were previously added will be available. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md index cc3f4b379d8d..412aa09bd5c0 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -44,7 +44,7 @@ You can manage a subset of security and analysis features for public repositorie {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -4. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**. +1. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**. {% endif %} ## Enabling or disabling security and analysis features{% ifversion fpt or ghec %} for private repositories{% endif %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md index 8203c37dffcf..f82bebbe91b7 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md @@ -37,9 +37,9 @@ You can filter email notifications you receive for pushes to a repository. For m {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.sidebar-notifications %} -5. In the "Address" field, type up to two email addresses, separated by whitespace, where you'd like notifications to be sent. If you'd like to send emails to more than two accounts, set one of the email addresses to a group email address. +1. In the "Address" field, type up to two email addresses, separated by whitespace, where you'd like notifications to be sent. If you'd like to send emails to more than two accounts, set one of the email addresses to a group email address. 1. If you operate your own server, you can verify the integrity of emails via the "Approved header." The "Approved header" is a token or secret that you type in this field, and that is sent with the email. If the `Approved` header of an email matches the token, you can trust that the email is from {% data variables.product.product_name %}. -7. Click **Setup notifications**. +1. Click **Setup notifications**. ## Further reading diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md index 7d405bb4be15..c3266d2d7d29 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md @@ -24,4 +24,4 @@ If you use an external LFS server (configured in your _.lfsconfig_), those LFS f {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under "Archives", select or deselect **Include {% data variables.large_files.product_name_short %} objects in archives**. +1. Under "Archives", select or deselect **Include {% data variables.large_files.product_name_short %} objects in archives**. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md index 478fe10ad539..fd41eb3a0d3e 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository.md @@ -20,7 +20,7 @@ An organization owner must allow forks of private{% ifversion ghae or ghes or gh {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. Under "Features", select **Allow forking**. +1. Under "Features", select **Allow forking**. ## Further reading diff --git a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md index daf44f14f5f3..97d7a847a866 100644 --- a/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md +++ b/content/repositories/releasing-projects-on-github/automatically-generated-release-notes.md @@ -36,8 +36,8 @@ You can also customize your automated release notes, using labels to create cust {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type `.github/release.yml`. This will create a new file called `release.yml` in the `.github` directory. -4. In the file, using the configuration options below, specify in YAML the pull request labels and authors you want to exclude from this release. You can also create new categories and list the pull request labels to be included in each of them. +1. In the file name field, type `.github/release.yml`. This will create a new file called `release.yml` in the `.github` directory. +1. In the file, using the configuration options below, specify in YAML the pull request labels and authors you want to exclude from this release. You can also create new categories and list the pull request labels to be included in each of them. ### Configuration options diff --git a/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index d0e57b7155b2..4ca4fb89a818 100644 --- a/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -56,7 +56,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da gh release create TAG ``` -2. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_release_create). For example, this command creates a prerelease with the specified title and notes. +1. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_release_create). For example, this command creates a prerelease with the specified title and notes. ```shell gh release create v1.3.2 --title "v1.3.2 (beta)" --notes "this is a beta release" --prerelease @@ -73,7 +73,7 @@ If you @mention any {% data variables.product.product_name %} users in the notes {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} {% data reusables.releases.edit-release %} -4. Edit the details for the release in the form, then click **Update release**. If you add or remove any @mentions of GitHub users in the description, those users will be added or removed from the avatar list in the **Contributors** section of the release. +1. Edit the details for the release in the form, then click **Update release**. If you add or remove any @mentions of GitHub users in the description, those users will be added or removed from the avatar list in the **Contributors** section of the release. {% endwebui %} @@ -89,10 +89,10 @@ Releases cannot currently be edited with {% data variables.product.prodname_cli {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} -3. On the right side of the page, next to the release you want to delete, click {% octicon "trash" aria-label="Delete" %}. +1. On the right side of the page, next to the release you want to delete, click {% octicon "trash" aria-label="Delete" %}. ![Screenshot of a release in the releases list. A trash icon is highlighted with an orange outline.](/assets/images/help/releases/delete-release-trash.png) -5. Click **Delete this release**. +1. Click **Delete this release**. {% endwebui %} diff --git a/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md index 9de99058bd18..cfbe005dd76f 100644 --- a/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md +++ b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md @@ -26,13 +26,13 @@ shortTitle: View releases & tags {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} -2. At the top of the Releases page, click **Releases**. +1. At the top of the Releases page, click **Releases**. ## Viewing tags {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.releases %} -2. At the top of the page, click **Tags**. +1. At the top of the page, click **Tags**. ## Further reading diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md index 26f6a7363e2d..12e010278184 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md @@ -35,7 +35,7 @@ The top graph shows commits for the entire year by week. The bottom graph shows {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Commits**. +1. In the left sidebar, click **Commits**. ![Screenshot of the left sidebar. The "Commits" tab is highlighted with a dark orange outline.](/assets/images/help/graphs/commits_tab.png) ## Visualizing additions and deletion to content in a repository @@ -52,7 +52,7 @@ The code frequency graph displays the content additions and deletions for each w {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Code frequency**. +1. In the left sidebar, click **Code frequency**. ![Screenshot of the left sidebar. The "Code frequency" tab is highlighted with a dark orange outline.](/assets/images/help/graphs/code_frequency_tab.png) {% ifversion repository-activity-view %} diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md index 20aaaa543433..992fc74c987f 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md @@ -40,7 +40,7 @@ The network graph displays the branch history of the entire repository network, {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Network**. +1. In the left sidebar, click **Network**. ![Screenshot of the left sidebar. The "Network" tab is highlighted with a dark orange outline.](/assets/images/help/graphs/network_tab.png) ## Listing the forks of a repository diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md index 327395bf37d1..75067f7f4210 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md @@ -29,9 +29,9 @@ You can also see a list of people who have contributed to the project's Python d {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Contributors**. +1. In the left sidebar, click **Contributors**. ![Screenshot of the "Contributors" tab. The tab is highlighted with a dark orange outline.](/assets/images/help/graphs/contributors_tab.png) -4. Optionally, to view contributors during a specific time period, click, then drag until the time period is selected. The contributors graph sums weekly commit numbers onto each Sunday, so your time period must include a Sunday. +1. Optionally, to view contributors during a specific time period, click, then drag until the time period is selected. The contributors graph sums weekly commit numbers onto each Sunday, so your time period must include a Sunday. ![Screenshot of a selection of a specific time period in the contributors graph. The selection is highlighted with a dark orange outline.](/assets/images/help/graphs/repo_contributors_click_drag_graph.png) ## Troubleshooting contributors diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md index d3b52a1023af..00e0a9386aa5 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md @@ -30,5 +30,5 @@ Referring sites and popular content are ordered by views and unique visitors. Fu {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Traffic**. +1. In the left sidebar, click **Traffic**. ![Screenshot of the "Traffic" tab. The tab is highlighted with a dark orange outline.](/assets/images/help/graphs/traffic_tab.png) diff --git a/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md index 7c47721e520a..245e15c0c061 100644 --- a/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md +++ b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md @@ -17,7 +17,7 @@ shortTitle: How changed files appear Use a _.gitattributes_ file to mark files that match a given "pattern" with the specified attributes. A _.gitattributes_ file uses the same rules for matching as _.gitignore_ files. For more information, see [PATTERN FORMAT](https://www.git-scm.com/docs/gitignore#_pattern_format) in the Git documentation. 1. Unless the _.gitattributes_ file already exists, create a _.gitattributes_ file in the root of the repository. -2. Use the `linguist-generated` attribute to mark or unmark paths that you would like to be ignored for the repository's language statistics and hidden by default in diffs. +1. Use the `linguist-generated` attribute to mark or unmark paths that you would like to be ignored for the repository's language statistics and hidden by default in diffs. For example, to mark `search/index.json` as a generated file, add this line to _.gitattributes_: diff --git a/content/repositories/working-with-files/managing-files/editing-files.md b/content/repositories/working-with-files/managing-files/editing-files.md index c150ff044696..1ca5d89b6bed 100644 --- a/content/repositories/working-with-files/managing-files/editing-files.md +++ b/content/repositories/working-with-files/managing-files/editing-files.md @@ -35,7 +35,7 @@ shortTitle: Edit files 1. In your repository, browse to the file you want to edit. {% data reusables.repositories.edit-file %} -3. In the text box, make any changes you need to the file. +1. In the text box, make any changes you need to the file. {% data reusables.files.preview_change %} {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} diff --git a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md index 1e1f7fc1e513..2bb2c09f7adc 100644 --- a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md +++ b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md @@ -50,7 +50,7 @@ Many files can be [moved directly on {% data variables.product.product_name %}]( 1. On your computer, move the file to a new location within the directory that was created locally on your computer when you cloned the repository. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Use `git status` to check the old and new file locations. +1. Use `git status` to check the old and new file locations. ```shell $ git status @@ -77,7 +77,7 @@ Many files can be [moved directly on {% data variables.product.product_name %}]( # {% data reusables.git.unstage-codeblock %} ``` -5. Use `git status` to check the changes staged for commit. +1. Use `git status` to check the changes staged for commit. ```shell $ git status diff --git a/content/repositories/working-with-files/managing-files/renaming-a-file.md b/content/repositories/working-with-files/managing-files/renaming-a-file.md index ba3685999e15..07a5a659d3ce 100644 --- a/content/repositories/working-with-files/managing-files/renaming-a-file.md +++ b/content/repositories/working-with-files/managing-files/renaming-a-file.md @@ -50,13 +50,13 @@ Many files can be [renamed directly on {% data variables.product.product_name %} {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.switching_directories_procedural %} -3. Rename the file, specifying the old file name and the new name you'd like to give the file. This will stage your change for commit. +1. Rename the file, specifying the old file name and the new name you'd like to give the file. This will stage your change for commit. ```shell git mv OLD-FILENAME NEW-FILENAME ``` -4. Use `git status` to check the old and new file names. +1. Use `git status` to check the old and new file names. ```shell $ git status diff --git a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md index c1838136228a..6a79c7047789 100644 --- a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md +++ b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -80,14 +80,14 @@ If the file was added with your most recent commit, and you have not pushed to { {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.switching_directories_procedural %} -3. To remove the file, enter `git rm --cached`: +1. To remove the file, enter `git rm --cached`: ```shell $ git rm --cached GIANT_FILE # Stage our giant file for removal, but leave it on disk ``` -4. Commit this change using `--amend -CHEAD`: +1. Commit this change using `--amend -CHEAD`: ```shell $ git commit --amend -CHEAD @@ -96,7 +96,7 @@ If the file was added with your most recent commit, and you have not pushed to { # to remove the file from the unpushed history as well ``` -5. Push your commits to {% data variables.location.product_location %}: +1. Push your commits to {% data variables.location.product_location %}: ```shell $ git push diff --git a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index 997b00a05171..392ac6156af5 100644 --- a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md @@ -28,8 +28,8 @@ If there are existing files in your repository that you'd like to use {% data va {% endif %} {% data reusables.command_line.open_the_multi_os_terminal %} -2. Change your current working directory to an existing repository you'd like to use with {% data variables.large_files.product_name_short %}. -3. To associate a file type in your repository with {% data variables.large_files.product_name_short %}, enter `git {% data variables.large_files.command_name %} track` followed by the name of the file extension you want to automatically upload to {% data variables.large_files.product_name_short %}. +1. Change your current working directory to an existing repository you'd like to use with {% data variables.large_files.product_name_short %}. +1. To associate a file type in your repository with {% data variables.large_files.product_name_short %}, enter `git {% data variables.large_files.command_name %} track` followed by the name of the file extension you want to automatically upload to {% data variables.large_files.product_name_short %}. For example, to associate a _.psd_ file, enter the following command: @@ -50,13 +50,13 @@ If there are existing files in your repository that you'd like to use {% data va {% endnote %} -4. Add a file to the repository matching the extension you've associated: +1. Add a file to the repository matching the extension you've associated: ```shell git add path/to/file.psd ``` -5. Commit the file and push it to {% data variables.product.product_name %}: +1. Commit the file and push it to {% data variables.product.product_name %}: ```shell git commit -m "add file.psd" diff --git a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md index e62f576216b2..89e3d2a36e17 100644 --- a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md @@ -21,9 +21,9 @@ shortTitle: Install Git LFS If you install {% data variables.large_files.product_name_short %} with Homebrew or MacPorts, skip to step six. -2. On your computer, locate and unzip the downloaded file. +1. On your computer, locate and unzip the downloaded file. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Change the current working directory into the folder you downloaded and unzipped. +1. Change the current working directory into the folder you downloaded and unzipped. ```shell cd ~/Downloads/git-lfs-1.X.X @@ -34,7 +34,7 @@ shortTitle: Install Git LFS **Note:** The file path you use after `cd` depends on your operating system, Git LFS version you downloaded, and where you saved the {% data variables.large_files.product_name_short %} download. {% endnote %} -4. To install the file, run this command: +1. To install the file, run this command: ```shell $ ./install.sh @@ -46,14 +46,14 @@ shortTitle: Install Git LFS **Note:** You may have to use `sudo ./install.sh` to install the file. {% endnote %} -5. Verify that the installation was successful: +1. Verify that the installation was successful: ```shell $ git {% data variables.large_files.command_name %} install > {% data variables.large_files.product_name_short %} initialized. ``` -6. If you don't see a message indicating that `git {% data variables.large_files.command_name %} install` was successful, please contact {% data variables.contact.contact_support %}. Be sure to include the name of your operating system. +1. If you don't see a message indicating that `git {% data variables.large_files.command_name %} install` was successful, please contact {% data variables.contact.contact_support %}. Be sure to include the name of your operating system. {% endmac %} @@ -66,17 +66,17 @@ shortTitle: Install Git LFS **Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Windows, see this [Getting started guide](https://github.com/github/git-lfs#getting-started). {% endtip %} -2. On your computer, locate the downloaded file. -3. Double click on the file called _git-lfs-windows-1.X.X.exe_, where 1.X.X is replaced with the Git LFS version you downloaded. When you open this file Windows will run a setup wizard to install {% data variables.large_files.product_name_short %}. +1. On your computer, locate the downloaded file. +1. Double click on the file called _git-lfs-windows-1.X.X.exe_, where 1.X.X is replaced with the Git LFS version you downloaded. When you open this file Windows will run a setup wizard to install {% data variables.large_files.product_name_short %}. {% data reusables.command_line.open_the_multi_os_terminal %} -5. Verify that the installation was successful: +1. Verify that the installation was successful: ```shell $ git {% data variables.large_files.command_name %} install > {% data variables.large_files.product_name_short %} initialized. ``` -6. If you don't see a message indicating that `git {% data variables.large_files.command_name %} install` was successful, please contact {% data variables.contact.contact_support %}. Be sure to include the name of your operating system. +1. If you don't see a message indicating that `git {% data variables.large_files.command_name %} install` was successful, please contact {% data variables.contact.contact_support %}. Be sure to include the name of your operating system. {% endwindows %} @@ -89,9 +89,9 @@ shortTitle: Install Git LFS **Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Linux, see this [Getting started guide](https://github.com/github/git-lfs#getting-started). {% endtip %} -2. On your computer, locate and unzip the downloaded file. +1. On your computer, locate and unzip the downloaded file. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Change the current working directory into the folder you downloaded and unzipped. +1. Change the current working directory into the folder you downloaded and unzipped. ```shell cd ~/Downloads/git-lfs-1.X.X @@ -102,7 +102,7 @@ shortTitle: Install Git LFS **Note:** The file path you use after `cd` depends on your operating system, Git LFS version you downloaded, and where you saved the {% data variables.large_files.product_name_short %} download. {% endnote %} -4. To install the file, run this command: +1. To install the file, run this command: ```shell $ ./install.sh @@ -114,14 +114,14 @@ shortTitle: Install Git LFS **Note:** You may have to use `sudo ./install.sh` to install the file. {% endnote %} -5. Verify that the installation was successful: +1. Verify that the installation was successful: ```shell $ git {% data variables.large_files.command_name %} install > {% data variables.large_files.product_name_short %} initialized. ``` -6. If you don't see a message indicating that `git {% data variables.large_files.command_name %} install` was successful, please contact {% data variables.contact.contact_support %}. Be sure to include the name of your operating system. +1. If you don't see a message indicating that `git {% data variables.large_files.command_name %} install` was successful, please contact {% data variables.contact.contact_support %}. Be sure to include the name of your operating system. {% endlinux %} diff --git a/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md index 08c2f531dd09..859c82172978 100644 --- a/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md @@ -23,7 +23,7 @@ After installing {% data variables.large_files.product_name_short %} and configu {% endtip %} 1. Remove the file from the repository's Git history using either the `filter-repo` command or BFG Repo-Cleaner. For detailed information on using these, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." -2. Configure tracking for your file and push it to {% data variables.large_files.product_name_short %}. For more information on this procedure, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)." +1. Configure tracking for your file and push it to {% data variables.large_files.product_name_short %}. For more information on this procedure, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)." ## Further reading diff --git a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md index 97ab2361cae6..6e57cdd607ec 100644 --- a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md @@ -15,20 +15,20 @@ shortTitle: Remove files ## Removing a single file 1. Remove the file from the repository's Git history using either the `filter-repo` command or BFG Repo-Cleaner. For detailed information on using these, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." -2. Navigate to your _.gitattributes_ file. +1. Navigate to your _.gitattributes_ file. {% note %} **Note:** Your _.gitattributes_ file is generally saved within your local repository. In some cases, you may have created a global _.gitattributes_ file that contains all of your {% data variables.large_files.product_name_short %} associations. {% endnote %} -3. Find and remove the associated {% data variables.large_files.product_name_short %} tracking rule within the _.gitattributes_ file. -4. Save and exit the _.gitattributes_ file. +1. Find and remove the associated {% data variables.large_files.product_name_short %} tracking rule within the _.gitattributes_ file. +1. Save and exit the _.gitattributes_ file. ## Removing all files within a {% data variables.large_files.product_name_short %} repository 1. Remove the files from the repository's Git history using either the `filter-repo` command or BFG Repo-Cleaner. For detailed information on using these, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." -2. Optionally, to uninstall {% data variables.large_files.product_name_short %} in the repository, run: +1. Optionally, to uninstall {% data variables.large_files.product_name_short %} in the repository, run: ```shell git lfs uninstall diff --git a/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md b/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md index 0f418a7cc6a6..f1788ad6589b 100644 --- a/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md +++ b/content/repositories/working-with-files/managing-large-files/resolving-git-large-file-storage-upload-failures.md @@ -17,13 +17,13 @@ The {% data variables.large_files.product_name_short %} integrity check ensures To resolve the error message, you must reinstall your local {% data variables.large_files.product_name_short %} client to ensure that the referenced {% data variables.large_files.product_name_short %} files can be properly uploaded in the future. 1. Open Terminal. -2. Reinstall {% data variables.large_files.product_name_short %}. +1. Reinstall {% data variables.large_files.product_name_short %}. ```shell git lfs install ``` -3. Push all referenced {% data variables.large_files.product_name_short %} files. +1. Push all referenced {% data variables.large_files.product_name_short %} files. ```shell git lfs push --all origin diff --git a/content/repositories/working-with-files/using-files/viewing-a-file.md b/content/repositories/working-with-files/using-files/viewing-a-file.md index b7736a53a2fe..b3f8fde37f91 100644 --- a/content/repositories/working-with-files/using-files/viewing-a-file.md +++ b/content/repositories/working-with-files/using-files/viewing-a-file.md @@ -69,7 +69,7 @@ Within the blame view, you can view the line-by-line revision history for an ent All revisions specified in the `.git-blame-ignore-revs` file, which must be in the root directory of your repository, are hidden from the blame view using Git's `git blame --ignore-revs-file` configuration setting. For more information, see [`git blame --ignore-revs-file`](https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt) in the Git documentation. 1. In the root directory of your repository, create a file named `.git-blame-ignore-revs`. -2. Add the commit hashes you want to exclude from the blame view to that file. We recommend the file to be structured as follows, including comments: +1. Add the commit hashes you want to exclude from the blame view to that file. We recommend the file to be structured as follows, including comments: ```ini # .git-blame-ignore-revs @@ -79,7 +79,7 @@ All revisions specified in the `.git-blame-ignore-revs` file, which must be in t 69d029cec8337c616552756310748c4a507bd75a ``` -3. Commit and push the changes. +1. Commit and push the changes. Now when you visit the blame view, the listed revisions will not be included in the blame. You'll see an **Ignoring revisions in .git-blame-ignore-revs** banner indicating that some commits may be hidden: diff --git a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md index effbe4110c07..403319f06eb2 100644 --- a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md +++ b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md @@ -51,5 +51,5 @@ A consuming API needs to explicitly request a pull request to create a _test_ me If you are currently using polling methods that produce outdated `merge` Git refs, then GitHub recommends using the following steps to get the latest changes from the default branch: 1. Receive the pull request webhook. -2. Call [`GET /repos/{owner}/{repo}/pulls/{pull_number}`](/rest/pulls#get-a-pull-request) to start a background job for creating the merge commit candidate. -3. Poll your repository using [`GET /repos/{owner}/{repo}/pulls/{pull_number}`](/rest/pulls#get-a-pull-request) to see if the `mergeable` attribute is `true` or `false`. You can use Git directly or [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/git#get-a-reference) for updates to `merge` Git refs only after performing the previous steps. +1. Call [`GET /repos/{owner}/{repo}/pulls/{pull_number}`](/rest/pulls#get-a-pull-request) to start a background job for creating the merge commit candidate. +1. Poll your repository using [`GET /repos/{owner}/{repo}/pulls/{pull_number}`](/rest/pulls#get-a-pull-request) to see if the `mergeable` attribute is `true` or `false`. You can use Git directly or [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/git#get-a-reference) for updates to `merge` Git refs only after performing the previous steps. diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index b8237d7ca1de..dcc6864d29e5 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -198,7 +198,7 @@ receive request bodies: {"message":"Problems parsing JSON"} -2. Sending the wrong type of JSON values will result in a `400 Bad +1. Sending the wrong type of JSON values will result in a `400 Bad Request` response. HTTP/2 400 @@ -206,7 +206,7 @@ receive request bodies: {"message":"Body should be a JSON object"} -3. Sending invalid fields will result in a `422 Unprocessable Entity` +1. Sending invalid fields will result in a `422 Unprocessable Entity` response. HTTP/2 422 diff --git a/content/search-github/github-code-search/using-github-code-search.md b/content/search-github/github-code-search/using-github-code-search.md index bbef0b6185c7..4107c3f590fc 100644 --- a/content/search-github/github-code-search/using-github-code-search.md +++ b/content/search-github/github-code-search/using-github-code-search.md @@ -35,7 +35,7 @@ For more information about the search syntax of code search, see "[AUTOTITLE](/s ![Screenshot of a search for "repo:octocat/spoon-knife". The code results are outlined in dark orange.](/assets/images/help/search/code-search-beta-search-bar-code-suggestions.png) -2. After typing your query, you can also press Enter to go to the full search results view, where you can see each match and a visual interface for applying filters. For more information, see "[Using the search results view](#using-the-search-results-view)." +1. After typing your query, you can also press Enter to go to the full search results view, where you can see each match and a visual interface for applying filters. For more information, see "[Using the search results view](#using-the-search-results-view)." ## Creating and managing saved searches diff --git a/content/search-github/searching-on-github/searching-topics.md b/content/search-github/searching-on-github/searching-topics.md index 698876e8ad59..4531293f8259 100644 --- a/content/search-github/searching-on-github/searching-topics.md +++ b/content/search-github/searching-on-github/searching-topics.md @@ -18,8 +18,8 @@ topics: You can search for topics on {% data variables.product.product_name %}, explore related topics, and see how many repositories are associated with a certain topic. 1. Navigate to https://github.com/search. -2. Type a topic keyword. -3. In the left sidebar, to narrow your search to topics, click **Topics**. +1. Type a topic keyword. +1. In the left sidebar, to narrow your search to topics, click **Topics**. {% ifversion fpt or ghec %} ![Screenshot of the repository search results page for the search term 'jekyll' with the "Topics" option in the left-hand menu outlined in dark orange.](/assets/images/help/search/topic-left-side-navigation-dotcom.png){% endif %} diff --git a/content/site-policy/content-removal-policies/dmca-takedown-policy.md b/content/site-policy/content-removal-policies/dmca-takedown-policy.md index 2c391057a2ba..c968f96de2fc 100644 --- a/content/site-policy/content-removal-policies/dmca-takedown-policy.md +++ b/content/site-policy/content-removal-policies/dmca-takedown-policy.md @@ -49,19 +49,19 @@ Here are the basic steps in the process. 1. **Copyright Owner Investigates.** A copyright owner should always conduct an initial investigation to confirm both (a) that they own the copyright to an original work and (b) that the content on GitHub is unauthorized and infringing. This includes confirming that the use is not protected as [fair use](https://www.lumendatabase.org/topics/22). A particular use may be fair if it only uses a small amount of copyrighted content, uses that content in a transformative way, uses it for educational purposes, or some combination of the above. Because code naturally lends itself to such uses, each use case is different and must be considered separately. > **Example:** An employee of Acme Web Company finds some of the company's code in a GitHub repository. Acme Web Company licenses its source code out to several trusted partners. Before sending in a take-down notice, Acme should review those licenses and its agreements to confirm that the code on GitHub is not authorized under any of them. -2. **Copyright Owner Sends A Notice.** After conducting an investigation, a copyright owner prepares and sends a [takedown notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice) to GitHub. Assuming the takedown notice is sufficiently detailed according to the statutory requirements (as explained in the [how-to guide](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice)), we will [post the notice](#d-transparency) to our [public repository](https://github.com/github/dmca) and pass the link along to the affected user. +1. **Copyright Owner Sends A Notice.** After conducting an investigation, a copyright owner prepares and sends a [takedown notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice) to GitHub. Assuming the takedown notice is sufficiently detailed according to the statutory requirements (as explained in the [how-to guide](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice)), we will [post the notice](#d-transparency) to our [public repository](https://github.com/github/dmca) and pass the link along to the affected user. -3. **GitHub Asks User to Make Changes.** If the notice alleges that the entire contents of a repository infringe, or a package infringes, we will skip to Step 6 and disable the entire repository or package expeditiously. Otherwise, because GitHub cannot disable access to specific files within a repository, we will contact the user who created the repository and give them approximately 1 business day to delete or modify the content specified in the notice. We'll notify the copyright owner if and when we give the user a chance to make changes. Because packages are immutable, if only part of a package is infringing, GitHub would need to disable the entire package, but we permit reinstatement once the infringing portion is removed. +1. **GitHub Asks User to Make Changes.** If the notice alleges that the entire contents of a repository infringe, or a package infringes, we will skip to Step 6 and disable the entire repository or package expeditiously. Otherwise, because GitHub cannot disable access to specific files within a repository, we will contact the user who created the repository and give them approximately 1 business day to delete or modify the content specified in the notice. We'll notify the copyright owner if and when we give the user a chance to make changes. Because packages are immutable, if only part of a package is infringing, GitHub would need to disable the entire package, but we permit reinstatement once the infringing portion is removed. -4. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they _must_ tell us so within the window of approximately 1 business day. If they don't, we will disable the repository (as described in Step 6). If the user notifies us that they made changes, we will verify that the changes have been made and then notify the copyright owner. +1. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they _must_ tell us so within the window of approximately 1 business day. If they don't, we will disable the repository (as described in Step 6). If the user notifies us that they made changes, we will verify that the changes have been made and then notify the copyright owner. -5. **Copyright Owner Revises or Retracts the Notice.** If the user makes changes, the copyright owner must review them and renew or revise their takedown notice if the changes are insufficient. GitHub will not take any further action unless the copyright owner contacts us to either renew the original takedown notice or submit a revised one. If the copyright owner is satisfied with the changes, they may either submit a formal retraction or else do nothing. GitHub will interpret silence longer than two weeks as an implied retraction of the takedown notice. +1. **Copyright Owner Revises or Retracts the Notice.** If the user makes changes, the copyright owner must review them and renew or revise their takedown notice if the changes are insufficient. GitHub will not take any further action unless the copyright owner contacts us to either renew the original takedown notice or submit a revised one. If the copyright owner is satisfied with the changes, they may either submit a formal retraction or else do nothing. GitHub will interpret silence longer than two weeks as an implied retraction of the takedown notice. -6. **GitHub May Disable Access to the Content.** GitHub will disable a user's content if: (i) the copyright owner has alleged copyright over the user's entire repository or package (as noted in Step 3); (ii) the user has not made any changes after being given an opportunity to do so (as noted in Step 4); or (iii) the copyright owner has renewed their takedown notice after the user had a chance to make changes. If the copyright owner chooses instead to _revise_ the notice, we will go back to Step 2 and repeat the process as if the revised notice were a new notice. +1. **GitHub May Disable Access to the Content.** GitHub will disable a user's content if: (i) the copyright owner has alleged copyright over the user's entire repository or package (as noted in Step 3); (ii) the user has not made any changes after being given an opportunity to do so (as noted in Step 4); or (iii) the copyright owner has renewed their takedown notice after the user had a chance to make changes. If the copyright owner chooses instead to _revise_ the notice, we will go back to Step 2 and repeat the process as if the revised notice were a new notice. -7. **User May Send A Counter Notice.** We encourage users who have had content disabled to consult with a lawyer about their options. If a user believes that their content was disabled as a result of a mistake or misidentification, they may send us a [counter notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice). As with the original notice, we will make sure that the counter notice is sufficiently detailed (as explained in the [how-to guide](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice)). If it is, we will [post it](#d-transparency) to our [public repository](https://github.com/github/dmca) and pass the notice back to the copyright owner by sending them the link. +1. **User May Send A Counter Notice.** We encourage users who have had content disabled to consult with a lawyer about their options. If a user believes that their content was disabled as a result of a mistake or misidentification, they may send us a [counter notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice). As with the original notice, we will make sure that the counter notice is sufficiently detailed (as explained in the [how-to guide](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice)). If it is, we will [post it](#d-transparency) to our [public repository](https://github.com/github/dmca) and pass the notice back to the copyright owner by sending them the link. -8. **Copyright Owner May File a Legal Action.** If a copyright owner wishes to keep the content disabled after receiving a counter notice, they will need to initiate a legal action seeking a court order to restrain the user from engaging in infringing activity relating to the content on GitHub. In other words, you might get sued. If the copyright owner does not give GitHub notice within 10-14 days, by sending a copy of a valid legal complaint filed in a court of competent jurisdiction, GitHub will re-enable the disabled content. +1. **Copyright Owner May File a Legal Action.** If a copyright owner wishes to keep the content disabled after receiving a counter notice, they will need to initiate a legal action seeking a court order to restrain the user from engaging in infringing activity relating to the content on GitHub. In other words, you might get sued. If the copyright owner does not give GitHub notice within 10-14 days, by sending a copy of a valid legal complaint filed in a court of competent jurisdiction, GitHub will re-enable the disabled content. ## B. What About Forks? (or What's a Fork?) @@ -77,8 +77,8 @@ The DMCA prohibits the [circumvention of technical measures](https://www.copyrig A circumvention claim must include the following details about the technical measures in place and the manner in which the accused project circumvents them. Specifically, the notice to GitHub must include detailed statements that describe: 1. What the technical measures are; -2. How they effectively control access to the copyrighted material; and -3. How the accused project is designed to circumvent their previously described technological protection measures. +1. How they effectively control access to the copyrighted material; and +1. How the accused project is designed to circumvent their previously described technological protection measures. GitHub will review circumvention claims closely, including by both technical and legal experts. In the technical review, we will seek to validate the details about the manner in which the technical protection measures operate and the way the project allegedly circumvents them. In the legal review, we will seek to ensure that the claims do not extend beyond the boundaries of the DMCA. In cases where we are unable to determine whether a claim is valid, we will err on the side of the developer, and leave the content up. If the claimant wishes to follow up with additional detail, we would start the review process again to evaluate the revised claims. diff --git a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md index b839cb34ebf3..03f4686fb3dc 100644 --- a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md +++ b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md @@ -50,19 +50,19 @@ For the purposes of this document, “private information” refers to content t 1. **Complainant Investigates.** It is up to the requesting party to conduct their own investigation and to provide us with the [details we require](#your-request-must-include) — most importantly, an explanation of how the data poses a security risk. GitHub is not in a position to search for or make initial determinations about private information on any individual's or organization's behalf. -2. **Complainant Sends a Private Information Removal Request.** After conducting an investigation, the complainant prepares and [sends a private information removal request](#sending-a-private-information-removal-request) to GitHub. If the request is not sufficiently detailed to demonstrate the security risk and for GitHub to locate the data, we will reply and ask for more information. +1. **Complainant Sends a Private Information Removal Request.** After conducting an investigation, the complainant prepares and [sends a private information removal request](#sending-a-private-information-removal-request) to GitHub. If the request is not sufficiently detailed to demonstrate the security risk and for GitHub to locate the data, we will reply and ask for more information. -3. **GitHub Asks User to Make Changes.** In most cases, we will contact the user who created the repository and give them an opportunity to delete or modify the private information specified in the request or to dispute the claim. +1. **GitHub Asks User to Make Changes.** In most cases, we will contact the user who created the repository and give them an opportunity to delete or modify the private information specified in the request or to dispute the claim. -4. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they must tell us so within the window of time they've been allowed. If they don't, we will disable the repository. If the user notifies us that they made changes, we will verify that the changes have been made and notify the complainant. +1. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they must tell us so within the window of time they've been allowed. If they don't, we will disable the repository. If the user notifies us that they made changes, we will verify that the changes have been made and notify the complainant. OR -5. **User May Dispute the Request.** If a user believes the content in question is not private information subject to this Policy, they may dispute it. If they do, we will generally leave it up to the complainant to contact the user and work things out with them directly, within reason. +1. **User May Dispute the Request.** If a user believes the content in question is not private information subject to this Policy, they may dispute it. If they do, we will generally leave it up to the complainant to contact the user and work things out with them directly, within reason. -6. **Complainant Reviews Changes.** If the user makes changes, the complainant must review them. If the changes are insufficient, the complainant must provide GitHub with details explaining why. GitHub may disable the repository or give the user an additional chance to make the changes. +1. **Complainant Reviews Changes.** If the user makes changes, the complainant must review them. If the changes are insufficient, the complainant must provide GitHub with details explaining why. GitHub may disable the repository or give the user an additional chance to make the changes. -7. **User May Request an Additional Window to Make Changes.** If the user missed their opportunity to remove the private information specified in the notice, we may allow them an additional window of approximately 1 business day, upon request, to make those changes. In that event, GitHub will notify the complainant. +1. **User May Request an Additional Window to Make Changes.** If the user missed their opportunity to remove the private information specified in the notice, we may allow them an additional window of approximately 1 business day, upon request, to make those changes. In that event, GitHub will notify the complainant. ### What About Forks? (or What's a Fork?) @@ -81,10 +81,10 @@ These guidelines are designed to make the processing of requests to remove priva ### Your Request Must Include: 1. A working, clickable link to each file containing private information. (Note that we're not able to work from search results, examples, or screenshots.) -2. Specific line numbers within each file containing the private information. -3. A brief description of how each item you've identified poses a security risk to you or your organization. ***It is important that you provide an explanation of how the data poses a security risk beyond merely stating that it does.*** -4. If you are a third party acting as an agent for an organization facing a security risk, include a statement that you have a legal right to act on behalf of that organization. -5. OPTIONAL: Let us know if your request is particularly urgent, and why. We respond to all private information removal requests as quickly as possible. However, if this request is especially time-sensitive, such as a very recent credential exposure, please explain why. +1. Specific line numbers within each file containing the private information. +1. A brief description of how each item you've identified poses a security risk to you or your organization. ***It is important that you provide an explanation of how the data poses a security risk beyond merely stating that it does.*** +1. If you are a third party acting as an agent for an organization facing a security risk, include a statement that you have a legal right to act on behalf of that organization. +1. OPTIONAL: Let us know if your request is particularly urgent, and why. We respond to all private information removal requests as quickly as possible. However, if this request is especially time-sensitive, such as a very recent credential exposure, please explain why. ## How to Submit Your Request diff --git a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md index 16aa6cecb861..3a1665cf3cd0 100644 --- a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md +++ b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md @@ -54,18 +54,18 @@ If you need additional help, there are many self-help resources online. Lumen ha 1. **Include the following statement: "I have read and understand GitHub's Guide to Filing a DMCA Counter Notice."** We won't refuse to process an otherwise complete counter notice if you don't include this statement; however, we will know that you haven't read these guidelines and may ask you to go back and do so. -2. ***Identify the content that was disabled and the location where it appeared.*** +1. ***Identify the content that was disabled and the location where it appeared.*** The disabled content should have been identified by URL in the takedown notice. You simply need to copy the URL(s) that you want to challenge. -3. **Provide your contact information.** +1. **Provide your contact information.** Include your email address, name, telephone number, and physical address. -4. ***Include the following statement: "I swear, under penalty of perjury, that I have a good-faith belief that the material was removed or disabled as a result of a mistake or misidentification of the material to be removed or disabled."*** +1. ***Include the following statement: "I swear, under penalty of perjury, that I have a good-faith belief that the material was removed or disabled as a result of a mistake or misidentification of the material to be removed or disabled."*** You may also choose to communicate the reasons why you believe there was a mistake or misidentification. If you think of your counter notice as a "note" to the complaining party, this is a chance to explain why they should not take the next step and file a lawsuit in response. This is yet another reason to work with a lawyer when submitting a counter notice. -5. ***Include the following statement: "I consent to the jurisdiction of Federal District Court for the judicial district in which my address is located (if in the United States, otherwise the Northern District of California where GitHub is located), and I will accept service of process from the person who provided the DMCA notification or an agent of such person."*** +1. ***Include the following statement: "I consent to the jurisdiction of Federal District Court for the judicial district in which my address is located (if in the United States, otherwise the Northern District of California where GitHub is located), and I will accept service of process from the person who provided the DMCA notification or an agent of such person."*** -6. **Include your physical or electronic signature.** +1. **Include your physical or electronic signature.** ## How to Submit Your Counter Notice diff --git a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md index 937b6f3ac51d..2918fc531da2 100644 --- a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md +++ b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md @@ -55,29 +55,29 @@ GitHub exercises little discretion in the process other than determining whether 1. **Include the following statement: "I have read and understand GitHub's Guide to Filing a DMCA Notice."** We won't refuse to process an otherwise complete complaint if you don't include this statement. But we'll know that you haven't read these guidelines and may ask you to go back and do so. -2. **Identify the copyrighted work you believe has been infringed.** This information is important because it helps the affected user evaluate your claim and give them the ability to compare your work to theirs. The specificity of your identification will depend on the nature of the work you believe has been infringed. If you have published your work, you might be able to just link back to a web page where it lives. If it is proprietary and not published, you might describe it and explain that it is proprietary. If you have registered it with the Copyright Office, you should include the registration number. If you are alleging that the hosted content is a direct, literal copy of your work, you can also just explain that fact. +1. **Identify the copyrighted work you believe has been infringed.** This information is important because it helps the affected user evaluate your claim and give them the ability to compare your work to theirs. The specificity of your identification will depend on the nature of the work you believe has been infringed. If you have published your work, you might be able to just link back to a web page where it lives. If it is proprietary and not published, you might describe it and explain that it is proprietary. If you have registered it with the Copyright Office, you should include the registration number. If you are alleging that the hosted content is a direct, literal copy of your work, you can also just explain that fact. -3. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. +1. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. - Please note that GitHub will _not_ automatically disable [forks](/site-policy/content-removal-policies/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. -4. **Explain what the affected user would need to do in order to remedy the infringement.** Again, specificity is important. When we pass your complaint along to the user, this will tell them what they need to do in order to avoid having the rest of their content disabled. Does the user just need to add a statement of attribution? Do they need to delete certain lines within their code, or entire files? Of course, we understand that in some cases, all of a user's content may be alleged to infringe and there's nothing they could do short of deleting it all. If that's the case, please make that clear as well. +1. **Explain what the affected user would need to do in order to remedy the infringement.** Again, specificity is important. When we pass your complaint along to the user, this will tell them what they need to do in order to avoid having the rest of their content disabled. Does the user just need to add a statement of attribution? Do they need to delete certain lines within their code, or entire files? Of course, we understand that in some cases, all of a user's content may be alleged to infringe and there's nothing they could do short of deleting it all. If that's the case, please make that clear as well. -5. **Provide your contact information.** Include your email address, name, telephone number and physical address. +1. **Provide your contact information.** Include your email address, name, telephone number and physical address. -6. **Provide contact information, if you know it, for the alleged infringer.** Usually this will be satisfied by providing the GitHub username associated with the allegedly infringing content. But there may be cases where you have additional knowledge about the alleged infringer. If so, please share that information with us. +1. **Provide contact information, if you know it, for the alleged infringer.** Usually this will be satisfied by providing the GitHub username associated with the allegedly infringing content. But there may be cases where you have additional knowledge about the alleged infringer. If so, please share that information with us. -7. **Include the following statement: "I have a good faith belief that use of the copyrighted materials described above on the infringing web pages is not authorized by the copyright owner, or its agent, or the law. I have taken fair use into consideration."** +1. **Include the following statement: "I have a good faith belief that use of the copyrighted materials described above on the infringing web pages is not authorized by the copyright owner, or its agent, or the law. I have taken fair use into consideration."** -8. **Also include the following statement: "I swear, under penalty of perjury, that the information in this notification is accurate and that I am the copyright owner, or am authorized to act on behalf of the owner, of an exclusive right that is allegedly infringed."** +1. **Also include the following statement: "I swear, under penalty of perjury, that the information in this notification is accurate and that I am the copyright owner, or am authorized to act on behalf of the owner, of an exclusive right that is allegedly infringed."** -9. **Include your physical or electronic signature.** +1. **Include your physical or electronic signature.** ## Complaints about Anti-Circumvention Technology The Copyright Act also prohibits the circumvention of technological measures that effectively control access to works protected by copyright. If you believe that content hosted on GitHub violates this prohibition, please send us a report through our {% data variables.contact.contact_dmca %}. A circumvention claim must include the following details about the technical measures in place and the manner in which the accused project circumvents them. Specifically, the notice to GitHub must include detailed statements that describe: 1. What the technical measures are; -2. How they effectively control access to the copyrighted material; and -3. How the accused project is designed to circumvent their previously described technological protection measures. +1. How they effectively control access to the copyrighted material; and +1. How the accused project is designed to circumvent their previously described technological protection measures. ## How to Submit Your Complaint diff --git a/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md b/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md index b292016d3462..d3a61ce922d0 100644 --- a/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md +++ b/content/site-policy/github-company-policies/github-gifts-and-entertainment-policy.md @@ -58,7 +58,7 @@ Keep in mind that what's an acceptable amount can vary. For example, spending $5 1. Generally speaking, for any expenses exceeding $150, you'll need approval (each time) from Legal in writing. And for any gifts you receive exceeding $150, you'll need to report that (each time) to Legal in writing. (Legal is just weighing in on the bribery question. You might still need to check with Finance for other reasons.) -2. When you submit your expense report for reimbursement, please: +1. When you submit your expense report for reimbursement, please: - Indicate the recipient and the purpose of the gift in the notes; and - Include a copy of the email approval diff --git a/content/site-policy/github-terms/github-marketplace-terms-of-service.md b/content/site-policy/github-terms/github-marketplace-terms-of-service.md index 8a75de83b486..28ee2f0e47d7 100644 --- a/content/site-policy/github-terms/github-marketplace-terms-of-service.md +++ b/content/site-policy/github-terms/github-marketplace-terms-of-service.md @@ -78,14 +78,14 @@ You agree to indemnify us, defend us, and hold us harmless from and against any 1. **Governing Law.** You agree that these Marketplace Terms and your use of the Developer Products are governed under California law and any dispute related to the Developer Products must be brought in a tribunal of competent jurisdiction located in or near San Francisco, California. -2. **Non-Assignability.** GitHub may assign or delegate these Marketplace Terms and/or the [GitHub's Privacy Statement](/site-policy/privacy-policies/github-privacy-statement), in whole or in part, to any person or entity at any time with or without your consent. You may not assign or delegate any rights or obligations under the Marketplace Terms or Privacy Statement without our prior written consent, and any unauthorized assignment and delegation by you is void. +1. **Non-Assignability.** GitHub may assign or delegate these Marketplace Terms and/or the [GitHub's Privacy Statement](/site-policy/privacy-policies/github-privacy-statement), in whole or in part, to any person or entity at any time with or without your consent. You may not assign or delegate any rights or obligations under the Marketplace Terms or Privacy Statement without our prior written consent, and any unauthorized assignment and delegation by you is void. -3. **Severability, No Waiver, and Survival.** If any part of these Marketplace Terms are held invalid or unenforceable, that portion of the Marketplace Terms will be construed to reflect the parties’ original intent. The remaining portions will remain in full force and effect. The failure of GitHub to exercise or enforce any right or provision of these Marketplace Terms shall not constitute a waiver of such right or provision. Our rights under these Marketplace Terms will survive any termination of these Marketplace Terms. +1. **Severability, No Waiver, and Survival.** If any part of these Marketplace Terms are held invalid or unenforceable, that portion of the Marketplace Terms will be construed to reflect the parties’ original intent. The remaining portions will remain in full force and effect. The failure of GitHub to exercise or enforce any right or provision of these Marketplace Terms shall not constitute a waiver of such right or provision. Our rights under these Marketplace Terms will survive any termination of these Marketplace Terms. -4. **No Modifications; Complete Agreement.** These Marketplace Terms may only be modified by a written amendment signed by an authorized representative of GitHub, or by the posting by GitHub of a revised version. These Marketplace Terms, together with [GitHub's Privacy Statement](/site-policy/privacy-policies/github-privacy-statement), represent the complete and exclusive statement of the agreement between you and us. These Marketplace Terms supersede any proposal or prior agreement oral or written, and any other communications between you and GitHub relating to the subject matter of these terms. +1. **No Modifications; Complete Agreement.** These Marketplace Terms may only be modified by a written amendment signed by an authorized representative of GitHub, or by the posting by GitHub of a revised version. These Marketplace Terms, together with [GitHub's Privacy Statement](/site-policy/privacy-policies/github-privacy-statement), represent the complete and exclusive statement of the agreement between you and us. These Marketplace Terms supersede any proposal or prior agreement oral or written, and any other communications between you and GitHub relating to the subject matter of these terms. -5. **Section Headings.** Throughout these Marketplace Terms, each section includes titles of the following terms and conditions. These section titles are not legally binding. +1. **Section Headings.** Throughout these Marketplace Terms, each section includes titles of the following terms and conditions. These section titles are not legally binding. -6. **License to GitHub Policies.** These Marketplace Terms are licensed under this [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). For details, see our [site-policy repository](https://github.com/github/site-policy#license). +1. **License to GitHub Policies.** These Marketplace Terms are licensed under this [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). For details, see our [site-policy repository](https://github.com/github/site-policy#license). -7. **Contact Us.** Questions about the Marketplace Terms? [Contact us](https://support.github.com/contact?tags=docs-policy). +1. **Contact Us.** Questions about the Marketplace Terms? [Contact us](https://support.github.com/contact?tags=docs-policy). diff --git a/content/site-policy/github-terms/github-open-source-applications-terms-and-conditions.md b/content/site-policy/github-terms/github-open-source-applications-terms-and-conditions.md index 431b6e2b6e04..48325e863abd 100644 --- a/content/site-policy/github-terms/github-open-source-applications-terms-and-conditions.md +++ b/content/site-policy/github-terms/github-open-source-applications-terms-and-conditions.md @@ -54,14 +54,14 @@ GitHub reserves the right at any time and from time to time to modify or discont 1. No Waiver. The failure of GitHub to exercise or enforce any right or provision of these Application Terms shall not constitute a waiver of such right or provision. -2. Entire Agreement. These Application Terms, together with any applicable Privacy Notices, constitutes the entire agreement between you and GitHub and governs your use of the Software, superseding any prior agreements between you and GitHub (including, but not limited to, any prior versions of the Application Terms). +1. Entire Agreement. These Application Terms, together with any applicable Privacy Notices, constitutes the entire agreement between you and GitHub and governs your use of the Software, superseding any prior agreements between you and GitHub (including, but not limited to, any prior versions of the Application Terms). -3. Governing Law. You agree that these Application Terms and your use of the Software are governed under California law and any dispute related to the Software must be brought in a tribunal of competent jurisdiction located in or near San Francisco, California. +1. Governing Law. You agree that these Application Terms and your use of the Software are governed under California law and any dispute related to the Software must be brought in a tribunal of competent jurisdiction located in or near San Francisco, California. -4. Third-Party Packages. The Software supports third-party "Packages" which may modify, add, remove, or alter the functionality of the Software. These Packages are not covered by these Application Terms and may include their own license which governs your use of that particular package. +1. Third-Party Packages. The Software supports third-party "Packages" which may modify, add, remove, or alter the functionality of the Software. These Packages are not covered by these Application Terms and may include their own license which governs your use of that particular package. -5. No Modifications; Complete Agreement. These Application Terms may only be modified by a written amendment signed by an authorized representative of GitHub, or by the posting by GitHub of a revised version. These Application Terms, together with any applicable Open Source Licenses and Notices and GitHub's Privacy Statement, represent the complete and exclusive statement of the agreement between you and us. These Application Terms supersede any proposal or prior agreement oral or written, and any other communications between you and GitHub relating to the subject matter of these terms. +1. No Modifications; Complete Agreement. These Application Terms may only be modified by a written amendment signed by an authorized representative of GitHub, or by the posting by GitHub of a revised version. These Application Terms, together with any applicable Open Source Licenses and Notices and GitHub's Privacy Statement, represent the complete and exclusive statement of the agreement between you and us. These Application Terms supersede any proposal or prior agreement oral or written, and any other communications between you and GitHub relating to the subject matter of these terms. -6. License to GitHub Policies. These Application Terms are licensed under this [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). For details, see our [site-policy repository](https://github.com/github/site-policy#license). +1. License to GitHub Policies. These Application Terms are licensed under this [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). For details, see our [site-policy repository](https://github.com/github/site-policy#license). -7. Contact Us. Questions about the Terms of Service? [Contact us](https://support.github.com/contact?tags=docs-policy). +1. Contact Us. Questions about the Terms of Service? [Contact us](https://support.github.com/contact?tags=docs-policy). diff --git a/content/site-policy/github-terms/github-registered-developer-agreement.md b/content/site-policy/github-terms/github-registered-developer-agreement.md index 3905e99cbc35..79ec028a52e2 100644 --- a/content/site-policy/github-terms/github-registered-developer-agreement.md +++ b/content/site-policy/github-terms/github-registered-developer-agreement.md @@ -17,11 +17,11 @@ This Agreement is a legal agreement between you (“you”) and GitHub, Inc. ( You need to have an account on GitHub.com in order to participate in the Program. By clicking “I Agree” at the bottom of this Agreement, you are also agreeing to be bound by the GitHub.com [Terms of Service](/site-policy/github-terms/github-terms-of-service) (the “TOS”). In the event of a direct conflict between this Agreement and theTOS, this Agreement will control; otherwise, both agreements will apply to you concurrently. -2. **Program Terms** +1. **Program Terms** We post the [Program’s benefits and guidelines](/get-started/exploring-integrations/github-developer-program) (the “Program Overview”). As you might expect, the Program Overview will change from time to time. These changes will apply to you as a participant in the Program, so we encourage you to periodically review the Program Overview to keep apprised of any changes. For a variety of reasons, we might need to change, suspend, or discontinue the Program, or some of the benefits we offer. You agree that we can do those things without liability to you, except as specified in Section 8. -3. **API License** +1. **API License** So long as you remain compliant with the TOS, this Agreement, and the Program Terms, we grant You a limited, worldwide, non-exclusive, non-transferable license during the term of this Agreement to access and use our API (as defined in the [TOS](/site-policy/github-terms/github-terms-of-service)) solely for the purpose of developing, demonstrating, testing and supporting interoperability and integrations between your products and services and our products and services. @@ -29,11 +29,11 @@ This Agreement is a legal agreement between you (“you”) and GitHub, Inc. ( We reserve the right at any time to modify or discontinue, temporarily or permanently, your access to the API (or any part of it) with or without notice. It’s your sole responsibility to ensure that your use of the API is compatible with the then-current API. Other than the rights we expressly give you in this Agreement or the TOS, We don’t grant you any rights or licenses to our API, or to any other GitHub products or services. -4. **Your Products, Services, and Integrations** +1. **Your Products, Services, and Integrations** Your products, services, and integrations (collectively, your “Products”) are your responsibility. That means that you’re solely responsible for developing, operating, and maintaining all aspects of your Products; ensuring that all materials used with or in your Products are legal in all the jurisdictions where your Products are used, and don’t promote illegal activities; obtaining any rights or licenses necessary to use and/or distribute any third-party software that you use, include, integrate, or distribute with your Products; and providing your end user customers with the same high-quality technical support for your Products when they operate in conjunction with our API or any other of our products and services as you do when they operate on their own. -5. **Marketing and Publicity** +1. **Marketing and Publicity** Marketing and publicizing your integrations with GitHub is valuable to both of us. We want to be sure that happens in the right way, so we’ve included some language here to help clarify some basic “dos” and “don’ts”. @@ -45,7 +45,7 @@ This Agreement is a legal agreement between you (“you”) and GitHub, Inc. ( Except as set forth in this Agreement and the TOS, nothing in this Agreement will be deemed to grant to one party any right, title or interest in or to the other party’s Marks. You agree not to, whether during or after the term of this Agreement: (i) challenge or assist others in challenging the GitHub Marks, or our registration or enforcement of the GitHub Marks; (ii) attempt to adopt, use, apply for, or register any trademark, service mark, logo, URL, Internet domain name, or symbol that is confusingly similar to the GitHub Marks; or (iii) make any negative, false, or disparaging statements (whether written or oral) to any third-party about us, our products, or our services. -6. **Confidentiality; Pre-Release Materials** +1. **Confidentiality; Pre-Release Materials** As a registered developer in the Program, you may get access to special information not available to the rest of the world. Due to the sensitive nature of this information, it’s important for us to make sure that you keep that information secret. @@ -57,11 +57,11 @@ This Agreement is a legal agreement between you (“you”) and GitHub, Inc. ( If We give you any pre-release software or related documentation or materials, which may include videos or other forms of content (“Pre-release Materials”), then subject to your compliance with the terms and conditions of this Agreement and the TOS, we hereby grant you a nonexclusive, nontransferable, revocable right and license to use the Pre-release Materials solely to support your testing and/or development of products or services that are designed to operate in combination with the systems or programs for which the Pre-release Materials are designed. If the Pre-release Materials are accompanied by a separate license agreement, you agree that the separate license agreement (in addition to any more restrictive provisions contained in this Agreement or the TOS) will apply. You agree not to decompile, reverse engineer, disassemble, or otherwise reduce the Pre-release Materials to a human-perceivable form, and you promise not to modify, network, rent, lease, transmit, sell, or loan the Pre-release Materials, in whole or in part. You understand that we’re under no obligation to provide any Pre-release Materials to you, to provide you with updates, enhancements, or corrections to the Pre-release Materials, or to notify you of changes that we make to our products and services, now or in the future. -7. **Fees and Payment** +1. **Fees and Payment** - There may be fees associated with participating in the Program. We’ll tell you what those fees are in the Program Terms, as we update them from time to time (the “Program Fees”). If you gave us your payment information before, you agree that we can charge the same credit card or PayPal account as part of this Agreement. Otherwise, you’ll need to give us a valid payment account, and other supporting information. Except as otherwise expressly provided in Section 8, any payments you make to us for the Program are non-refundable. You give us permission to automatically charge your payment account on the anniversary of your first payment date to cover all of the coming year’s Program Fees, unless you terminate this Agreement first according to Section 8. All fees are due in U.S. Dollars, and are exclusive of all taxes, levies, or duties imposed by taxing authorities (you’re responsible for all of those, except for taxes based on our income). + There may be fees associated with participating in the Program. We’ll tell you what those fees are in the Program Terms, as we update them from time to time (the “Program Fees”). If you gave us your payment information before, you agree that we can charge the same credit card or PayPal account as part of this Agreement. Otherwise, you’ll need to give us a valid payment account, and other supporting information. Except as otherwise expressly provided in Section 8, any payments you make to us for the Program are non-refundable. You give us permission to automatically charge your payment account on the anniversary of your first payment date to cover all of the coming year’s Program Fees, unless you terminate this Agreement first according to Section 1. All fees are due in U.S. Dollars, and are exclusive of all taxes, levies, or duties imposed by taxing authorities (you’re responsible for all of those, except for taxes based on our income). -8. **Term and Termination** +1. **Term and Termination** This Agreement begins on the date you click “Agree”, and continues for a period of one (1) year. This Agreement will automatically renew for successive one-year terms unless either party gives written notice at least thirty (30) days before the current term expires that it wants to terminate, or one of us terminates it earlier in accordance with this Section 8. @@ -69,49 +69,49 @@ This Agreement is a legal agreement between you (“you”) and GitHub, Inc. ( The rights and obligations in Sections 1, 2, 3 (second and third paragraphs), 4, 5 (second and last paragraphs), 6, 7, and 9 through 21 of this Agreement will survive the termination or expiration of this Agreement. Upon termination or expiration of this Agreement all of the rights and licenses we granted you in this Agreement will immediately cease to exist, you will return (or, at our request, destroy) all of our Confidential Information and any copies (including electronic copies) which are in your possession or control, and you will certify in writing that you’ve complied with these requirements. -9. **Warranties and Disclaimers** +1. **Warranties and Disclaimers** You warrant to us that you: (i) have the authority to execute this Agreement and to perform its obligations; (ii) will conduct business in a manner that reflects favorably at all times on GitHub’s products and services and our good name, goodwill and reputation; (iii) will make no false or misleading statements or representations regarding GitHub or our products and services; (iv) will not take on any obligation or responsibility, or make any representation, warranty, guarantee or endorsement to anyone on our behalf (including, without limitation, any of our products or services); and (v) will not state or imply that We have developed, endorsed, reviewed or otherwise approved of any of your Products. THE PROGRAM, THE API AND ANY CONFIDENTIAL INFORMATION WE GIVE YOU (INCLUDING, WITHOUT LIMITATION, THE PRE-RELEASE MATERIALS) ARE PROVIDED “AS IS”, AND WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. WE SPECIFICALLY DISCLAIM ANY AND ALL IMPLIED WARRANTIES OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. WE DO NOT WARRANT THAT ANY SERVICES OR PRODUCTS WE MAKE AVAILABLE TO YOU WILL MEET YOUR OR YOUR END USERS’ REQUIREMENTS. -10. **Indemnity** +1. **Indemnity** We’re giving you lots of useful pre-release stuff as part of the Program, and there are ways that you could use that stuff improperly that could cause us harm. With that in mind, and since we can’t control the ways that you participate in the Program, you agree that you will indemnify, defend and hold us harmless from and against any and all claims which may arise under or out of your participation in the Program; your use of the API, our Confidential Information, or any other GitHub products and services; your negligence or intentional misconduct; your Products, or any integrations you develop, design, promote or distribute using our API or any Confidential Information; any misrepresentations you make with respect to us, or our products or services; or your violation of any part of this Agreement. -11. **Limitation of Liability** +1. **Limitation of Liability** IN NO EVENT WILL WE BE LIABLE TO YOU OR TO ANY THIRD PARTY FOR ANY INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, EXEMPLARY OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOST DATA, LOST PROFITS OR COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, TORT (INCLUDING WITHOUT LIMITATION PRODUCTS LIABILITY, STRICT LIABILITY AND NEGLIGENCE), OR ANY OTHER THEORY, AND WHETHER OR NOT WE KNEW OR SHOULD HAVE KNOWN ABOUT THE POSSIBILITY OF SUCH DAMAGE. IN NO EVENT WILL OUR AGGREGATE LIABILITY TO YOU ARISING OUT OF OR RELATED TO THIS AGREEMENT FOR ANY CAUSE WHATSOEVER, AND REGARDLESS OF THE FORM OF ACTION, WHETHER IN CONTRACT OR IN TORT, EXCEED THE GREATER OF (I) AMOUNTS YOU ACTUALLY PAID US UNDER THIS AGREEMENT; OR (II) FIVE HUNDRED DOLLARS ($500). THE FOREGOING LIMITATIONS WILL APPLY NOTWITHSTANDING THE FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY STATED IN THIS AGREEMENT. -12. **Export Control** +1. **Export Control** You aren’t allowed to export or re-export any of our Confidential Information, except as authorized by United States law and the laws of the jurisdiction in which the Confidential Information was obtained. In particular, you aren’t allowed to export or re-export our Confidential Information into any U.S. embargoed countries, to anyone on the U.S. Treasury Department's list of Specially Designated Nationals, or to anyone on the U.S. Department of Commerce Denied Person's List or Entity List. By joining the Program or receiving any of our Confidential Information, you represent and warrant that you are not located in any such country or on any such list. -13. **Proprietary Rights** +1. **Proprietary Rights** You agree that GitHub and its licensors own all right, title and interest in and to the API, the Pre-release Materials, and all other GitHub products and services; all information and data relating to their configurations and combinations; and all modifications to and derivative works of any of the foregoing. You agree not to remove, alter, cover or obfuscate any copyright or other proprietary rights notices we place on or embed in the API, the Pre-release Materials, or any other GitHub products and services. -14. **Government Users** +1. **Government Users** If you are a Government entity, this Section applies to you. Certain of our Confidential Information may be considered “Commercial Items”, as that term is defined at 48 C.F.R. §2.101, consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation”, as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. GitHub, Inc. 88 Colin P. Kelly Street, San Francisco, CA 94107. -15. **Independent Development** +1. **Independent Development** Nothing in this Agreement will impair our right to develop, acquire, license, market, promote or distribute products, software or technologies that may compete with your Products. -16. **Feedback** +1. **Feedback** We’re always trying to improve, and your feedback will help us do that. If you choose to give us feedback, suggestions or recommendations for the Program or for our products or services (collectively, “Feedback”), you acknowledge and agree that we’re free to use that Feedback in any way we want, without restriction (subject to any applicable patents or copyrights, of course). -17. **Independent Contractors** +1. **Independent Contractors** The parties to this Agreement are independent contractors. Neither of us will be deemed to be an employee, agent, partner, franchisor, franchisee or legal representative of the other for any purpose and neither of us will have any right, power or authority to create any obligation or responsibility on behalf of the other. -18. **Assignment** +1. **Assignment** You aren’t allowed to assign or transfer this Agreement, or any of your rights under it, in whole or in part, by operation of law or otherwise, without our prior written consent. -19. **Governing Law and Venue** +1. **Governing Law and Venue** This Agreement will be interpreted and construed in accordance with the laws of the State of California, without regard to conflict of law principles. All disputes arising out of this Agreement will be subject to the exclusive jurisdiction of the state and federal courts located in San Francisco County, California, and each of us hereby consents to personal jurisdiction there. diff --git a/content/site-policy/github-terms/github-sponsors-additional-terms.md b/content/site-policy/github-terms/github-sponsors-additional-terms.md index ad85e75828e4..ac616259cf4a 100644 --- a/content/site-policy/github-terms/github-sponsors-additional-terms.md +++ b/content/site-policy/github-terms/github-sponsors-additional-terms.md @@ -30,7 +30,7 @@ Your participation in the GitHub Sponsors Program (the "Program") is subject to "**USD**" means United States Dollar. -## 2. Acceptable Use. +## 1. Acceptable Use. ### 2.1. GitHub Sponsors Program diff --git a/content/site-policy/github-terms/github-terms-of-service.md b/content/site-policy/github-terms/github-terms-of-service.md index 2364d1e30ef2..2e81e585e7aa 100644 --- a/content/site-policy/github-terms/github-terms-of-service.md +++ b/content/site-policy/github-terms/github-terms-of-service.md @@ -48,13 +48,13 @@ Effective date: November 16, 2020 **Short version:** _We use these basic terms throughout the agreement, and they have specific meanings. You should know what we mean when we use each of the terms. There's not going to be a test on it, but it's still useful information._ 1. An "Account" represents your legal relationship with GitHub. A “Personal Account” represents an individual User’s authorization to log in to and use the Service and serves as a User’s identity on GitHub. “Organizations” are shared workspaces that may be associated with a single entity or with one or more Users where multiple Users can collaborate across many projects at once. A Personal Account can be a member of any number of Organizations. -2. The “Agreement” refers, collectively, to all the terms, conditions, notices contained or referenced in this document (the “Terms of Service” or the "Terms") and all other operating rules, policies (including the GitHub Privacy Statement, available at [github.com/site/privacy](https://github.com/site/privacy)) and procedures that we may publish from time to time on the Website. Most of our site policies are available at [docs.github.com/categories/site-policy](/site-policy). -3. "Beta Previews" mean software, services, or features identified as alpha, beta, preview, early access, or evaluation, or words or phrases with similar meanings. -4. “Content” refers to content featured or displayed through the Website, including without limitation code, text, data, articles, images, photographs, graphics, software, applications, packages, designs, features, and other materials that are available on the Website or otherwise available through the Service. "Content" also includes Services. “User-Generated Content” is Content, written or otherwise, created or uploaded by our Users. "Your Content" is Content that you create or own. -5. “GitHub,” “We,” and “Us” refer to GitHub, Inc., as well as our affiliates, directors, subsidiaries, contractors, licensors, officers, agents, and employees. -6. The “Service” refers to the applications, software, products, and services provided by GitHub, including any Beta Previews. -7. “The User,” “You,” and “Your” refer to the individual person, company, or organization that has visited or is using the Website or Service; that accesses or uses any part of the Account; or that directs the use of the Account in the performance of its functions. A User must be at least 13 years of age. Special terms may apply for business or government Accounts (See [Section B(5): Additional Terms](#5-additional-terms)). -8. The “Website” refers to GitHub’s website located at [github.com](https://github.com/), and all content, services, and products provided by GitHub at or through the Website. It also refers to GitHub-owned subdomains of github.com, such as [education.github.com](https://education.github.com/) and [pages.github.com](https://pages.github.com/). These Terms also govern GitHub’s conference websites, such as [githubuniverse.com](https://githubuniverse.com/), and product websites, such as [electronjs.org](https://www.electronjs.org/). Occasionally, websites owned by GitHub may provide different or additional terms of service. If those additional terms conflict with this Agreement, the more specific terms apply to the relevant page or service. +1. The “Agreement” refers, collectively, to all the terms, conditions, notices contained or referenced in this document (the “Terms of Service” or the "Terms") and all other operating rules, policies (including the GitHub Privacy Statement, available at [github.com/site/privacy](https://github.com/site/privacy)) and procedures that we may publish from time to time on the Website. Most of our site policies are available at [docs.github.com/categories/site-policy](/site-policy). +1. "Beta Previews" mean software, services, or features identified as alpha, beta, preview, early access, or evaluation, or words or phrases with similar meanings. +1. “Content” refers to content featured or displayed through the Website, including without limitation code, text, data, articles, images, photographs, graphics, software, applications, packages, designs, features, and other materials that are available on the Website or otherwise available through the Service. "Content" also includes Services. “User-Generated Content” is Content, written or otherwise, created or uploaded by our Users. "Your Content" is Content that you create or own. +1. “GitHub,” “We,” and “Us” refer to GitHub, Inc., as well as our affiliates, directors, subsidiaries, contractors, licensors, officers, agents, and employees. +1. The “Service” refers to the applications, software, products, and services provided by GitHub, including any Beta Previews. +1. “The User,” “You,” and “Your” refer to the individual person, company, or organization that has visited or is using the Website or Service; that accesses or uses any part of the Account; or that directs the use of the Account in the performance of its functions. A User must be at least 13 years of age. Special terms may apply for business or government Accounts (See [Section B(5): Additional Terms](#5-additional-terms)). +1. The “Website” refers to GitHub’s website located at [github.com](https://github.com/), and all content, services, and products provided by GitHub at or through the Website. It also refers to GitHub-owned subdomains of github.com, such as [education.github.com](https://education.github.com/) and [pages.github.com](https://pages.github.com/). These Terms also govern GitHub’s conference websites, such as [githubuniverse.com](https://githubuniverse.com/), and product websites, such as [electronjs.org](https://www.electronjs.org/). Occasionally, websites owned by GitHub may provide different or additional terms of service. If those additional terms conflict with this Agreement, the more specific terms apply to the relevant page or service. ## B. Account Terms @@ -119,7 +119,7 @@ We have the right to refuse or remove any User-Generated Content that, in our so You retain ownership of and responsibility for Your Content. If you're posting anything you did not create yourself or do not own the rights to, you agree that you are responsible for any Content you post; that you will only submit Content that you have the right to post; and that you will fully comply with any third party licenses relating to Content you post. -Because you retain ownership of and responsibility for Your Content, we need you to grant us — and other GitHub Users — certain legal permissions, listed in Sections D.4 — D.7. These license grants apply to Your Content. If you upload Content that already comes with a license granting GitHub the permissions we need to run our Service, no additional license is required. You understand that you will not receive any payment for any of the rights granted in Sections D.4 — D.7. The licenses you grant to us will end when you remove Your Content from our servers, unless other Users have forked it. +Because you retain ownership of and responsibility for Your Content, we need you to grant us — and other GitHub Users — certain legal permissions, listed in Sections D.4 — D.1. These license grants apply to Your Content. If you upload Content that already comes with a license granting GitHub the permissions we need to run our Service, no additional license is required. You understand that you will not receive any payment for any of the rights granted in Sections D.4 — D.1. The licenses you grant to us will end when you remove Your Content from our servers, unless other Users have forked it. ### 4. License Grant to Us diff --git a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md index f093a2b0e173..f1f51cba795e 100644 --- a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md +++ b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md @@ -52,11 +52,11 @@ We use the Candidate Personal Information for the following purposes: GitHub will share your Candidate Personal Information with those who have a legitimate business need for it. Whenever we permit a third party to access your Candidate Personal Information, we will make sure the information is used in a manner consistent with this policy. Your Candidate Personal Information may be shared with our affiliates (such as Microsoft) and other third parties (such as vendors) for the following purposes: 1. In order to carry out the uses of Candidate Personal Information described above; -2. To enable third parties to provide products or services to us or on our behalf (such as to facilitate the application process or conduct background checks). -3. To comply with our legal obligations, regulations or contracts, or to respond to a court order, administrative or judicial process (such as subpoena, government audit or search warrant) or, in response to lawful requests by public authorities (such as national security or law enforcement); -4. As necessary to establish, exercise, or defend against potential or pending litigation; -5. Where necessary to protect GitHub, your vital interests (such as safety and security), or those of another person; or -6. With your consent (such to contact your referees). It is your responsibility to obtain consent from referees before providing their personal information to GitHub. +1. To enable third parties to provide products or services to us or on our behalf (such as to facilitate the application process or conduct background checks). +1. To comply with our legal obligations, regulations or contracts, or to respond to a court order, administrative or judicial process (such as subpoena, government audit or search warrant) or, in response to lawful requests by public authorities (such as national security or law enforcement); +1. As necessary to establish, exercise, or defend against potential or pending litigation; +1. Where necessary to protect GitHub, your vital interests (such as safety and security), or those of another person; or +1. With your consent (such to contact your referees). It is your responsibility to obtain consent from referees before providing their personal information to GitHub. ## Your rights to your Candidate Personal Information diff --git a/content/site-policy/privacy-policies/github-privacy-statement.md b/content/site-policy/privacy-policies/github-privacy-statement.md index ed345e2cfc36..ccc61b55ad81 100644 --- a/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/content/site-policy/privacy-policies/github-privacy-statement.md @@ -259,7 +259,7 @@ The table below provides additional information about how we use different types Any GitHub page that serves non-essential cookies will have a link in the page’s footer to cookie settings. You can express your preferences at any time by clicking on that linking and updating your settings. Some users will also be able to manage non-essential cookies via a cookie consent banner, including the options to accept, manage, and reject all non-essential cookies. - 2. **Generally for all websites** + 1. **Generally for all websites** You can control the cookies you encounter on the web using a variety of widely-available tools. For example: - If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track) (DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies. - Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more. diff --git a/content/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor.md b/content/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor.md index 2afa2addb571..ce8a565e719d 100644 --- a/content/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor.md +++ b/content/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor.md @@ -12,8 +12,8 @@ topics: ## Summary 1. We want you to coordinate disclosure through our bug bounty program, and don't want researchers put in fear of legal consequences because of their good faith attempts to comply with our bug bounty policy. We cannot bind any third party, so do not assume this protection extends to any third party. If in doubt, ask us before engaging in any specific action you think _might_ go outside the bounds of our policy. -2. Because both identifying and non-identifying information can put a researcher at risk, we limit what we share with third parties. We may provide non-identifying substantive information from your report to an affected third party, but only after notifying you and receiving a commitment that the third party will not pursue legal action against you. We will only share identifying information (name, email address, phone number, etc.) with a third party if you give your written permission. -3. If your security research as part of the bug bounty program violates certain restrictions in our site policies, the safe harbor terms permit a limited exemption. +1. Because both identifying and non-identifying information can put a researcher at risk, we limit what we share with third parties. We may provide non-identifying substantive information from your report to an affected third party, but only after notifying you and receiving a commitment that the third party will not pursue legal action against you. We will only share identifying information (name, email address, phone number, etc.) with a third party if you give your written permission. +1. If your security research as part of the bug bounty program violates certain restrictions in our site policies, the safe harbor terms permit a limited exemption. ## 1. Safe Harbor Terms diff --git a/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md b/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md index cf2c525d3071..4567690684e2 100644 --- a/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md +++ b/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md @@ -30,42 +30,42 @@ GitHub and You (together, the "Parties") agree that modifications to the [GitHub 1. _Government entity_ - "You" within the ToS shall mean the Government itself and shall not bind, in their individual capacity, the individual(s) who utilize the Company site or services on the Government's behalf. Company will look solely to the Government to enforce any violation or breach of the ToS by such individuals, subject to federal law. -2. _Advertisements_ - Company hereby agrees not to serve or display any third-party commercial advertisements or solicitations on any pages within the Company site displaying content created by or under the control of the Government. This exclusion shall not extend to house ads, which Company may serve on such pages in a non-intrusive manner. The foregoing obligations are contingent upon the email address designated on Your account details page ending in `.gov`, `.mil`, or `.fed.us`. +1. _Advertisements_ - Company hereby agrees not to serve or display any third-party commercial advertisements or solicitations on any pages within the Company site displaying content created by or under the control of the Government. This exclusion shall not extend to house ads, which Company may serve on such pages in a non-intrusive manner. The foregoing obligations are contingent upon the email address designated on Your account details page ending in `.gov`, `.mil`, or `.fed.us`. ## B. Your content on GitHub 1. _Access and use_ - Company acknowledges that the Government's use of the Service may energize significant citizen engagement. Language in the ToS allowing Company to terminate service, refuse or remove any Content, or close the Government's account, at any time, for any reason, is modified to reflect the Parties' agreement that Company may unilaterally modify or discontinue service, temporarily or permanently, refuse or remove any Content, and/or terminate the Government's account only for breach of the Government’s obligations under the ToS or its material failure to comply with the instructions and guidelines posted on the Service, or if Company ceases to operate the Service generally. Company will provide the Government with a reasonable opportunity to cure any breach or failure on the Government's part. -2. _No endorsement_ - Company agrees that Your seals, trademarks, logos, service marks, trade names, and the fact that You have a presence on the Company site and use its services, shall not be used by Company in such a manner as to state or imply that Company's products or services are endorsed, sponsored or recommended by You or by any other element of the federal government, or are considered by these entities to be superior to any other products or services. Except for pages whose design and content is under the control of the Government, or for links to or promotion of such pages, Company agrees not to display any government seals or logos on the Company's homepage or elsewhere on the Company Site, unless permission to do so has been granted by the Government or by other relevant federal government authority. Company may list the Government's name in a publicly available customer list so long as the name is not displayed in a more prominent fashion than that of any other third-party name. +1. _No endorsement_ - Company agrees that Your seals, trademarks, logos, service marks, trade names, and the fact that You have a presence on the Company site and use its services, shall not be used by Company in such a manner as to state or imply that Company's products or services are endorsed, sponsored or recommended by You or by any other element of the federal government, or are considered by these entities to be superior to any other products or services. Except for pages whose design and content is under the control of the Government, or for links to or promotion of such pages, Company agrees not to display any government seals or logos on the Company's homepage or elsewhere on the Company Site, unless permission to do so has been granted by the Government or by other relevant federal government authority. Company may list the Government's name in a publicly available customer list so long as the name is not displayed in a more prominent fashion than that of any other third-party name. -3. _Provision of data_ - In case of termination of service, within 30 days of such termination, upon request, Company will provide you with all user-generated content that is publicly visible through the Sites You created at Company. Data will be provided in a commonly used file or database format as Company deems appropriate. Company will not provide data if doing so would violate its privacy policy, available at [https://docs.github.com/privacy](/site-policy/privacy-policies/github-privacy-statement). +1. _Provision of data_ - In case of termination of service, within 30 days of such termination, upon request, Company will provide you with all user-generated content that is publicly visible through the Sites You created at Company. Data will be provided in a commonly used file or database format as Company deems appropriate. Company will not provide data if doing so would violate its privacy policy, available at [https://docs.github.com/privacy](/site-policy/privacy-policies/github-privacy-statement). ## C. Unpaid and paid plans 1. _No cost agreement_ - Nothing in this Amendment or ToS obligates You to expend appropriations or incur financial obligations. The Parties acknowledge and agree that none of the obligations arising from this Amendment or ToS are contingent upon the payment of fees by one party to the other. At the Company’s discretion, GitHub may offer a free account under a free usage plan, such as a Free for Open Source Plan, and in that case this Amendment will apply to the Government’s usage under the free account/plan. This Amendment also applies when the Government uses one of GitHub’s paid usage plans. -2. _Government responsibilities under paid usage plans_ - You acknowledge that while Company will provide You with service under a free plan, Company reserves the right to begin charging for that service at some point in the future. Company will provide You with at least 30 days advance notice of a change involving the charging of fees for a free service. You also understand that Company offers paid plans for a fee. The Parties understand that fee-based services are categorically different than free products, and are subject to federal procurement rules and processes. Before the Government decides to enter into a business or enterprise subscription, or any other fee-based service that this Company or alternative providers may offer now or in the future, You agree: to determine the Government has a need for those additional services for a fee; to consider the subscription's value in comparison with comparable services available elsewhere; to determine that Government funds are available for payment; to properly use the Government Purchase Card if that Card is used as the payment method; to review any then-applicable ToS for conformance to federal procurement law; and in all other respects to follow applicable federal acquisition laws, regulations and agency guidelines (including those related to payments) when initiating that separate action. +1. _Government responsibilities under paid usage plans_ - You acknowledge that while Company will provide You with service under a free plan, Company reserves the right to begin charging for that service at some point in the future. Company will provide You with at least 30 days advance notice of a change involving the charging of fees for a free service. You also understand that Company offers paid plans for a fee. The Parties understand that fee-based services are categorically different than free products, and are subject to federal procurement rules and processes. Before the Government decides to enter into a business or enterprise subscription, or any other fee-based service that this Company or alternative providers may offer now or in the future, You agree: to determine the Government has a need for those additional services for a fee; to consider the subscription's value in comparison with comparable services available elsewhere; to determine that Government funds are available for payment; to properly use the Government Purchase Card if that Card is used as the payment method; to review any then-applicable ToS for conformance to federal procurement law; and in all other respects to follow applicable federal acquisition laws, regulations and agency guidelines (including those related to payments) when initiating that separate action. -3. _No business relationship created_ - The Parties are independent entities and nothing in this Amendment or ToS creates an agency, partnership, joint venture, or employer/employee relationship. +1. _No business relationship created_ - The Parties are independent entities and nothing in this Amendment or ToS creates an agency, partnership, joint venture, or employer/employee relationship. ## D. Federal Regulations 1. _Security_ - Company will, in good faith, exercise due diligence using generally accepted commercial business practices for IT security, to ensure that systems are operated and maintained in a secure manner, and that management, operational and technical controls will be employed to ensure security of systems and data. Recognizing the changing nature of the Web, Company will continuously work with users to ensure that its products and services are operated and maintained in a secure manner. Company agrees to discuss implementing additional security controls as deemed necessary by the Government to conform to the Federal Information Security Management Act (FISMA), 44 U.S.C. 3541 et seq. -2. _Federal Records_ - Government acknowledges that use of Company's site and services may require management of Federal records. Government and user-generated content may meet the definition of Federal records as determined by the agency. If the Company holds Federal records, the Government and the Company must manage Federal records in accordance with all applicable records management laws and regulations, including but not limited to the Federal Records Act (44 U.S.C. chs. 21, 29, 31, 33), and regulations of the National Archives and Records Administration (NARA) at 36 CFR Chapter XII Subchapter B). Managing the records includes, but is not limited to, secure storage, retrievability, and proper disposition of all Federal records including transfer of permanently valuable records to NARA in a format and manner acceptable to NARA at the time of transfer. The Government is responsible for ensuring that the Company is compliant with applicable records management laws and regulations through the life and termination of the Agreement. +1. _Federal Records_ - Government acknowledges that use of Company's site and services may require management of Federal records. Government and user-generated content may meet the definition of Federal records as determined by the agency. If the Company holds Federal records, the Government and the Company must manage Federal records in accordance with all applicable records management laws and regulations, including but not limited to the Federal Records Act (44 U.S.C. chs. 21, 29, 31, 33), and regulations of the National Archives and Records Administration (NARA) at 36 CFR Chapter XII Subchapter B). Managing the records includes, but is not limited to, secure storage, retrievability, and proper disposition of all Federal records including transfer of permanently valuable records to NARA in a format and manner acceptable to NARA at the time of transfer. The Government is responsible for ensuring that the Company is compliant with applicable records management laws and regulations through the life and termination of the Agreement. ## E. General Conditions 1. _Indemnification_ - Any provisions in the ToS related to indemnification, damages, attorney’s fees, and settlement are hereby waived. Liability of the Government for any breach of the ToS or this Agreement, or any claim, demand, suit or proceeding arising from the ToS or this Agreement, shall be determined under the Federal Tort Claims Act, or other governing authority. Liability of Company for any breach of the ToS or this Agreement, or any claim, demand, suit or proceeding arising from the ToS or this Agreement, shall be determined by applicable federal or state law. -2. _Limitation of liability_ - The Parties agree that nothing in the Limitation of Liability clause or elsewhere in the ToS in any way grants Company a waiver from, release of, or limitation of liability pertaining to, any past, current or future violation of federal law. +1. _Limitation of liability_ - The Parties agree that nothing in the Limitation of Liability clause or elsewhere in the ToS in any way grants Company a waiver from, release of, or limitation of liability pertaining to, any past, current or future violation of federal law. -3. _Governing law and Forum_ - The dispute resolution provision in the ToS is hereby deleted. The ToS and this Amendment shall be governed, interpreted and enforced in accordance with applicable federal laws of the United States of America and exclusive jurisdiction shall be in the appropriate U.S. federal courts. To the extent permitted by federal law, the laws of the State of California will apply in the absence of federal law. +1. _Governing law and Forum_ - The dispute resolution provision in the ToS is hereby deleted. The ToS and this Amendment shall be governed, interpreted and enforced in accordance with applicable federal laws of the United States of America and exclusive jurisdiction shall be in the appropriate U.S. federal courts. To the extent permitted by federal law, the laws of the State of California will apply in the absence of federal law. -4. _Assignment_ - Neither party may assign its obligations under this Amendment or ToS to any third-party without prior written consent of the other; however, GitHub may, without the Government's consent, assign its obligations to an Government using the service under a free usage plan under this Amendment or ToS to an affiliate or to a successor or acquirer, as the case may be, in connection with a merger, acquisition, corporate reorganization or consolidation, or the sale of all or substantially all of GitHub's assets. +1. _Assignment_ - Neither party may assign its obligations under this Amendment or ToS to any third-party without prior written consent of the other; however, GitHub may, without the Government's consent, assign its obligations to an Government using the service under a free usage plan under this Amendment or ToS to an affiliate or to a successor or acquirer, as the case may be, in connection with a merger, acquisition, corporate reorganization or consolidation, or the sale of all or substantially all of GitHub's assets. ## F. Changes to this agreement 1. _Precedence; Further Amendment; Termination_ - This Amendment constitutes an amendment to the ToS; language in the ToS indicating it may not be modified or that it alone is the entire agreement between the Parties is waived. If there is any conflict between this Amendment and the ToS, or between this Amendment and other rules or policies on the Company site or services, this Amendment shall prevail. This Amendment may be further amended only upon written agreement executed by both Parties. The Government may close its account and terminate this agreement at any time. Company may close Government's account and terminate this agreement on 30 days written notice, but the Government shall not be entitled to a refund of any fees paid. -2. _Posting and availability of this Amendment_ - The parties agree this Amendment contains no confidential or proprietary information, and either party may release it to the public at large. +1. _Posting and availability of this Amendment_ - The parties agree this Amendment contains no confidential or proprietary information, and either party may release it to the public at large. diff --git a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md index cb130ffa021d..6d9e3b985e47 100644 --- a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md @@ -235,11 +235,11 @@ The details of the transfer and in particular the special categories of personal 1. The data subject can enforce against the data exporter this Clause, Clause 4(b) to (i), Clause 5(a) to (e), and (g) to (j), Clause 6(1) and (2), Clause 7, Clause 8(2), and Clauses 9 to 12 as third-party beneficiary. -2. The data subject can enforce against the data importer this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where the data exporter has factually disappeared or has ceased to exist in law unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law, as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity. +1. The data subject can enforce against the data importer this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where the data exporter has factually disappeared or has ceased to exist in law unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law, as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity. -3. The data subject can enforce against the subprocessor this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses. +1. The data subject can enforce against the subprocessor this Clause, Clause 5(a) to (e) and (g), Clause 6, Clause 7, Clause 8(2), and Clauses 9 to 12, in cases where both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, unless any successor entity has assumed the entire legal obligations of the data exporter by contract or by operation of law as a result of which it takes on the rights and obligations of the data exporter, in which case the data subject can enforce them against such entity. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses. -4. The parties do not object to a data subject being represented by an association or other body if the data subject so expressly wishes and if permitted by national law. +1. The parties do not object to a data subject being represented by an association or other body if the data subject so expressly wishes and if permitted by national law. #### Clause 4: Obligations of the data exporter @@ -299,11 +299,11 @@ The data importer agrees and warrants: 1. The parties agree that any data subject who has suffered damage as a result of any breach of the obligations referred to in Clause 3 or in Clause 11 by any party or subprocessor is entitled to receive compensation from the data exporter for the damage suffered. -2. If a data subject is not able to bring a claim for compensation in accordance with paragraph 1 against the data exporter, arising out of a breach by the data importer or his subprocessor of any of their obligations referred to in Clause 3 or in Clause 11, because the data exporter has factually disappeared or ceased to exist in law or has become insolvent, the data importer agrees that the data subject may issue a claim against the data importer as if it were the data exporter, unless any successor entity has assumed the entire legal obligations of the data exporter by contract of by operation of law, in which case the data subject can enforce its rights against such entity. +1. If a data subject is not able to bring a claim for compensation in accordance with paragraph 1 against the data exporter, arising out of a breach by the data importer or his subprocessor of any of their obligations referred to in Clause 3 or in Clause 11, because the data exporter has factually disappeared or ceased to exist in law or has become insolvent, the data importer agrees that the data subject may issue a claim against the data importer as if it were the data exporter, unless any successor entity has assumed the entire legal obligations of the data exporter by contract of by operation of law, in which case the data subject can enforce its rights against such entity. The data importer may not rely on a breach by a subprocessor of its obligations in order to avoid its own liabilities. -3. If a data subject is not able to bring a claim against the data exporter or the data importer referred to in paragraphs 1 and 2, arising out of a breach by the subprocessor of any of their obligations referred to in Clause 3 or in Clause 11 because both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, the subprocessor agrees that the data subject may issue a claim against the data subprocessor with regard to its own processing operations under the Clauses as if it were the data exporter or the data importer, unless any successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law, in which case the data subject can enforce its rights against such entity. The liability of the subprocessor shall be limited to its own processing operations under the Clauses. +1. If a data subject is not able to bring a claim against the data exporter or the data importer referred to in paragraphs 1 and 2, arising out of a breach by the subprocessor of any of their obligations referred to in Clause 3 or in Clause 11 because both the data exporter and the data importer have factually disappeared or ceased to exist in law or have become insolvent, the subprocessor agrees that the data subject may issue a claim against the data subprocessor with regard to its own processing operations under the Clauses as if it were the data exporter or the data importer, unless any successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law, in which case the data subject can enforce its rights against such entity. The liability of the subprocessor shall be limited to its own processing operations under the Clauses. #### Clause 7: Mediation and jurisdiction @@ -313,15 +313,15 @@ The data importer may not rely on a breach by a subprocessor of its obligations (b) to refer the dispute to the courts in the Member State in which the data exporter is established. -2. The parties agree that the choice made by the data subject will not prejudice its substantive or procedural rights to seek remedies in accordance with other provisions of national or international law. +1. The parties agree that the choice made by the data subject will not prejudice its substantive or procedural rights to seek remedies in accordance with other provisions of national or international law. #### Clause 8: Cooperation with supervisory authorities 1. The data exporter agrees to deposit a copy of this contract with the supervisory authority if it so requests or if such deposit is required under the applicable data protection law. -2. The parties agree that the supervisory authority has the right to conduct an audit of the data importer, and of any subprocessor, which has the same scope and is subject to the same conditions as would apply to an audit of the data exporter under the applicable data protection law. +1. The parties agree that the supervisory authority has the right to conduct an audit of the data importer, and of any subprocessor, which has the same scope and is subject to the same conditions as would apply to an audit of the data exporter under the applicable data protection law. -3. The data importer shall promptly inform the data exporter about the existence of legislation applicable to it or any subprocessor preventing the conduct of an audit of the data importer, or any subprocessor, pursuant to paragraph 2. In such a case the data exporter shall be entitled to take the measures foreseen in Clause 5 (b). +1. The data importer shall promptly inform the data exporter about the existence of legislation applicable to it or any subprocessor preventing the conduct of an audit of the data importer, or any subprocessor, pursuant to paragraph 1. In such a case the data exporter shall be entitled to take the measures foreseen in Clause 5 (b). #### Clause 9: Governing Law. @@ -335,17 +335,17 @@ The parties undertake not to vary or modify the Clauses. This does not preclude 1. The data importer shall not subcontract any of its processing operations performed on behalf of the data exporter under the Clauses without the prior written consent of the data exporter. Where the data importer subcontracts its obligations under the Clauses, with the consent of the data exporter, it shall do so only by way of a written agreement with the subprocessor which imposes the same obligations on the subprocessor as are imposed on the data importer under the Clauses. Where the subprocessor fails to fulfil its data protection obligations under such written agreement the data importer shall remain fully liable to the data exporter for the performance of the subprocessor's obligations under such agreement. -2. The prior written contract between the data importer and the subprocessor shall also provide for a third-party beneficiary clause as laid down in Clause 3 for cases where the data subject is not able to bring the claim for compensation referred to in paragraph 1 of Clause 6 against the data exporter or the data importer because they have factually disappeared or have ceased to exist in law or have become insolvent and no successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses. +1. The prior written contract between the data importer and the subprocessor shall also provide for a third-party beneficiary clause as laid down in Clause 3 for cases where the data subject is not able to bring the claim for compensation referred to in paragraph 1 of Clause 6 against the data exporter or the data importer because they have factually disappeared or have ceased to exist in law or have become insolvent and no successor entity has assumed the entire legal obligations of the data exporter or data importer by contract or by operation of law. Such third-party liability of the subprocessor shall be limited to its own processing operations under the Clauses. -3. The provisions relating to data protection aspects for subprocessing of the contract referred to in paragraph 1 shall be governed by the law of the Member State in which the data exporter is established. +1. The provisions relating to data protection aspects for subprocessing of the contract referred to in paragraph 1 shall be governed by the law of the Member State in which the data exporter is established. -4. The data exporter shall keep a list of subprocessing agreements concluded under the Clauses and notified by the data importer pursuant to Clause 5 (j), which shall be updated at least once a year. The list shall be available to the data exporter's data protection supervisory authority. +1. The data exporter shall keep a list of subprocessing agreements concluded under the Clauses and notified by the data importer pursuant to Clause 5 (j), which shall be updated at least once a year. The list shall be available to the data exporter's data protection supervisory authority. #### Clause 12: Obligation after the termination of personal data processing services 1. The parties agree that on the termination of the provision of data processing services, the data importer and the subprocessor shall, at the choice of the data exporter, return all the personal data transferred and the copies thereof to the data exporter or shall destroy all the personal data and certify to the data exporter that it has done so, unless legislation imposed upon the data importer prevents it from returning or destroying all or part of the personal data transferred. In that case, the data importer warrants that it will guarantee the confidentiality of the personal data transferred and will not actively process the personal data transferred anymore. -2. The data importer and the subprocessor warrant that upon request of the data exporter and/or of the supervisory authority, it will submit its data processing facilities for an audit of the measures referred to in paragraph 1. +1. The data importer and the subprocessor warrant that upon request of the data exporter and/or of the supervisory authority, it will submit its data processing facilities for an audit of the measures referred to in paragraph 1. ### Appendix 1 to the Standard Contractual Clauses @@ -384,13 +384,13 @@ Description of the technical and organizational security measures implemented by **1. Personnel.** Data importer’s personnel will not process Customer Personal Data without authorization. Personnel are obligated to maintain the confidentiality of any Customer Personal Data and this obligation continues even after their engagement ends. -**2. Data Privacy Contact.** The data privacy officer of the data importer can be reached at the following address: +**1. Data Privacy Contact.** The data privacy officer of the data importer can be reached at the following address: GitHub, Inc. Attn: Privacy 88 Colin P. Kelly Jr. Street San Francisco, CA 94107 USA -**3. Technical and Organization Measures.** The data importer has implemented and will maintain appropriate technical and organizational measures, internal controls, and information security routines intended to protect Customer Personal Data, as defined in the GitHub Security Exhibit, against accidental loss, destruction, or alteration; unauthorized disclosure or access; or unlawful destruction as follows: The technical and organizational measures, internal controls, and information security routines set forth in the GitHub Security Exhibit are hereby incorporated into this Appendix 2 by this reference and are binding on the data importer as if they were set forth in this Appendix 2 in their entirety. +**1. Technical and Organization Measures.** The data importer has implemented and will maintain appropriate technical and organizational measures, internal controls, and information security routines intended to protect Customer Personal Data, as defined in the GitHub Security Exhibit, against accidental loss, destruction, or alteration; unauthorized disclosure or access; or unlawful destruction as follows: The technical and organizational measures, internal controls, and information security routines set forth in the GitHub Security Exhibit are hereby incorporated into this Appendix 2 by this reference and are binding on the data importer as if they were set forth in this Appendix 2 in their entirety. Signature of GitHub, Inc. appears below. Signing the Standard Contractual Clauses, Appendix 1 and Appendix 2 on behalf of the data importer diff --git a/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md b/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md index 192226f31be3..de696158e83f 100644 --- a/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md @@ -143,13 +143,13 @@ The Parties will defend each other against third-party claims, as and to the ext **16.1** _Definition of Confidential Information_. For the purposes of this Agreement, "Confidential Information" means any business or technical information that either Party discloses to the other, in writing, orally, or by any other means, including disclosures like computer programs, code, algorithms, data, know-how, formulas, processes, ideas, inventions (whether patentable or not), schematics and other technical, business, financial, and product development plans, names and expertise of employees and consultants, and customer lists. For the purposes of this Agreement, except as expressly set forth in Section 2.1, the source code of the Software will be deemed to be GitHub's Confidential Information, regardless of whether it is marked as such. -**16.2** _Restrictions on Use and Disclosure._ Neither Party will use the other Party's Confidential Information, except as permitted under this Agreement. Each Party agrees to maintain in confidence and protect the other Party's Confidential Information using at least the same degree of care as it uses for its own information of a similar nature, but in all events at least a reasonable degree of care. Each Party agrees to take all reasonable precautions to prevent any unauthorized disclosure of the other Party's Confidential Information, including, without limitation, disclosing Confidential Information only to its employees, independent contractors, consultants, and legal and financial advisors (collectively, "Representatives") (i) with a need to know such information, (ii) who are parties to appropriate agreements sufficient to comply with this Section 16, and (iii) who are informed of the non-disclosure obligations imposed by this Section 16. Each Party is responsible for all acts and omissions of its Representatives. The foregoing obligations will not restrict either Party from disclosing Confidential Information of the other Party pursuant to the order or requirement of a court, administrative agency, or other governmental body, provided that the Party required to make such a disclosure gives reasonable notice to the other Party to enable them to contest such order or requirement. The restrictions set forth in this Section 16 will survive the termination or expiration of this Agreement. +**16.2** _Restrictions on Use and Disclosure._ Neither Party will use the other Party's Confidential Information, except as permitted under this Agreement. Each Party agrees to maintain in confidence and protect the other Party's Confidential Information using at least the same degree of care as it uses for its own information of a similar nature, but in all events at least a reasonable degree of care. Each Party agrees to take all reasonable precautions to prevent any unauthorized disclosure of the other Party's Confidential Information, including, without limitation, disclosing Confidential Information only to its employees, independent contractors, consultants, and legal and financial advisors (collectively, "Representatives") (i) with a need to know such information, (ii) who are parties to appropriate agreements sufficient to comply with this Section 16, and (iii) who are informed of the non-disclosure obligations imposed by this Section 1. Each Party is responsible for all acts and omissions of its Representatives. The foregoing obligations will not restrict either Party from disclosing Confidential Information of the other Party pursuant to the order or requirement of a court, administrative agency, or other governmental body, provided that the Party required to make such a disclosure gives reasonable notice to the other Party to enable them to contest such order or requirement. The restrictions set forth in this Section 16 will survive the termination or expiration of this Agreement. **16.3** _Exclusions_. The restrictions set forth in Section 16.2 will not apply with respect to any Confidential Information that: (i) was or becomes publicly known through no fault of the receiving party; (ii) was rightfully known or becomes rightfully known to the receiving party without confidential or proprietary restriction from a source other than the disclosing party who has a right to disclose it; (iii) is approved by the disclosing party for disclosure without restriction in a written document which is signed by a duly authorized officer of such disclosing party; or (iv) the receiving party independently develops without access to or use of the other Party's Confidential Information. **17. Term and Termination.** -**17.1** _Agreement_ _Term_. This Agreement starts on the Agreement Effective Date and will continue in effect until this Agreement is terminated by a Party in accordance with this Section 17. If this Agreement is terminated before the expiration or termination of a Subscription Term, then any active Order Forms will remain in force pursuant to the terms of this Agreement. +**17.1** _Agreement_ _Term_. This Agreement starts on the Agreement Effective Date and will continue in effect until this Agreement is terminated by a Party in accordance with this Section 1. If this Agreement is terminated before the expiration or termination of a Subscription Term, then any active Order Forms will remain in force pursuant to the terms of this Agreement. **17.2** _Termination for Convenience_. Either Party may terminate an Order Form, with or without cause, upon at least thirty (30) days written notice before the end of the then-current Subscription Term. diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md index 2637b1491614..2229e074cfcc 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account.md @@ -86,6 +86,6 @@ Before you can become a sponsored developer, you must enable 2FA for your accoun ## Submitting your application to {% data variables.product.prodname_dotcom %} for approval {% data reusables.sponsors.navigate-to-sponsors-dashboard %} -4. Click **Request approval**. +1. Click **Request approval**. {% data reusables.sponsors.github-review-app %} diff --git a/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md b/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md index 987df099ea2f..4262bbc34129 100644 --- a/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md +++ b/content/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal.md @@ -32,7 +32,7 @@ To benefit from Premium Support SLAs and ticket collaboration features, you must - If your team confirms that you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you can [submit a request](https://support.github.com/contact?comments=%3E+Please+provide+the+following+information+and+someone+will+be+in+touch+to+help+you+setup+your+enterprise+account.%0A%0A%23%23%23%23+Company+name+%28required%29%0A%0A%23%23%23%23+Email+address+or+GitHub+login+of+the+person+who+should+be+the+initial+owner+of+the+enterprise+account+%28required%29%0A%0A%23%23%23%23+Is+there+anything+else+we+should+know+to+help+us+identify+your+account%3F+%28optional%29%0A%3E+Attaching+a+GitHub+Enterprise+Server+diagnostics+file+here+can+help+us+identify+your+account+by+license+reference+number%0A%0A&subject=Enterprise+Account+Request&tags=new-ea) for a new one. - Then, for the best experience, follow the steps below before using the {% data variables.contact.contact_landing_page_portal %} to create tickets about the enterprise account. -2. If you're sure you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you have not been configured as a support-entitled member by an enterprise owner, or you cannot sign in with to your {% data variables.product.prodname_dotcom_the_website %} account, you can provide a copy of your license key or diagnostics file by using the [Get help with {% data variables.product.prodname_ghe_server %}](https://support.github.com/contact/enterprise-by-license) form. +1. If you're sure you do not have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, you have not been configured as a support-entitled member by an enterprise owner, or you cannot sign in with to your {% data variables.product.prodname_dotcom_the_website %} account, you can provide a copy of your license key or diagnostics file by using the [Get help with {% data variables.product.prodname_ghe_server %}](https://support.github.com/contact/enterprise-by-license) form. {% endif %} diff --git a/content/support/contacting-github-support/providing-data-to-github-support.md b/content/support/contacting-github-support/providing-data-to-github-support.md index 7d77fd1b247b..005b84b4fb0f 100644 --- a/content/support/contacting-github-support/providing-data-to-github-support.md +++ b/content/support/contacting-github-support/providing-data-to-github-support.md @@ -67,7 +67,7 @@ You can create a diagnostic file from the {% data variables.enterprise.managemen {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. Click **Download diagnostics info**. +1. Click **Download diagnostics info**. ### Creating a diagnostic file using SSH @@ -112,7 +112,7 @@ You can use these steps to create and share a support bundle if you can access t {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.type-management-console-password %} {% data reusables.enterprise_management_console.support-link %} -5. Click **Download support bundle**. +1. Click **Download support bundle**. {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} diff --git a/content/support/contacting-github-support/viewing-and-updating-support-tickets.md b/content/support/contacting-github-support/viewing-and-updating-support-tickets.md index 1061202f63e5..9135dc847262 100644 --- a/content/support/contacting-github-support/viewing-and-updating-support-tickets.md +++ b/content/support/contacting-github-support/viewing-and-updating-support-tickets.md @@ -51,7 +51,7 @@ You can only view archived tickets for an enterprise account. {% data reusables.support.view-open-tickets %} 1. Optionally, if the issue is resolved, under the text box, click **Close ticket**. -2. To respond to GitHub Support and add a new comment to the ticket, type your response in the text box. +1. To respond to GitHub Support and add a new comment to the ticket, type your response in the text box. ![Screenshot of the "Add a comment" text field, highlighted in dark orange.](/assets/images/help/support/new-comment-field.png) 1. To add your comment to the ticket, under the text box, click **Comment**. diff --git a/content/support/learning-about-github-support/github-marketplace-support.md b/content/support/learning-about-github-support/github-marketplace-support.md index 97594a267052..45332fd02f0c 100644 --- a/content/support/learning-about-github-support/github-marketplace-support.md +++ b/content/support/learning-about-github-support/github-marketplace-support.md @@ -17,9 +17,9 @@ topics: Every app in {% data variables.product.prodname_marketplace %} includes a link to contact the app's support team. {% data reusables.marketplace.visit-marketplace %} -2. Browse to your app's page. -3. In the left sidebar, under "Developer tools," click **Support**. -4. On the app's support page, follow the instructions on the app's page to contact the app's support team. +1. Browse to your app's page. +1. In the left sidebar, under "Developer tools," click **Support**. +1. On the app's support page, follow the instructions on the app's page to contact the app's support team. ## Further reading diff --git a/content/webhooks-and-events/webhooks/replacing-github-services.md b/content/webhooks-and-events/webhooks/replacing-github-services.md index 6f332df19445..824a7eff0c7c 100644 --- a/content/webhooks-and-events/webhooks/replacing-github-services.md +++ b/content/webhooks-and-events/webhooks/replacing-github-services.md @@ -52,13 +52,13 @@ To replace GitHub Services with Webhooks: 1. Identify the relevant webhook events you’ll need to subscribe to from [this list](/webhooks-and-events/webhooks/about-webhooks#events). -2. Change your configuration depending on how you currently use GitHub Services: +1. Change your configuration depending on how you currently use GitHub Services: - **GitHub Apps**: Update your app's permissions and subscribed events to configure your app to receive the relevant webhook events. - **{% data variables.product.prodname_oauth_app %}s**: Request either the `repo_hook` and/or `org_hook` scope(s) to manage the relevant events on behalf of users. - **GitHub Service providers**: Request that users manually configure a webhook with the relevant events sent to you, or take this opportunity to build an app to manage this functionality. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps)." -3. Move additional configuration from outside of GitHub. Some GitHub Services require additional, custom configuration on the configuration page within GitHub. If your service does this, you will need to move this functionality into your application or rely on GitHub or {% data variables.product.prodname_oauth_app %}s where applicable. +1. Move additional configuration from outside of GitHub. Some GitHub Services require additional, custom configuration on the configuration page within GitHub. If your service does this, you will need to move this functionality into your application or rely on GitHub or {% data variables.product.prodname_oauth_app %}s where applicable. ## Supporting {% data variables.product.prodname_ghe_server %} diff --git a/content/webhooks-and-events/webhooks/securing-your-webhooks.md b/content/webhooks-and-events/webhooks/securing-your-webhooks.md index f37372dd572f..4dfb86fdd76e 100644 --- a/content/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/content/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -27,8 +27,8 @@ To set your token on GitHub: {% data reusables.repositories.sidebar-settings %} 1. In the left sidebar, click **{% octicon "webhook" aria-hidden="true" %} Webhooks**. 1. Next to the webhook, click **Edit**. -2. In the "Secret" field, type a random string with high entropy. You can generate a string with `ruby -rsecurerandom -e 'puts SecureRandom.hex(20)'` in the terminal, for example. -3. Click **Update Webhook**. +1. In the "Secret" field, type a random string with high entropy. You can generate a string with `ruby -rsecurerandom -e 'puts SecureRandom.hex(20)'` in the terminal, for example. +1. Click **Update Webhook**. Next, set up an environment variable on your server that stores this token. Typically, this is as simple as running: diff --git a/data/reusables/accounts/create-account.md b/data/reusables/accounts/create-account.md index 782275dc29cd..df2809d03fb5 100644 --- a/data/reusables/accounts/create-account.md +++ b/data/reusables/accounts/create-account.md @@ -1,2 +1,2 @@ 1. Go to {% data variables.product.company_short %}'s [Pricing]({% data variables.product.pricing_url %}) page. -2. Read the information about the different products and subscriptions that {% data variables.product.company_short %} offers, then click the upgrade button under the subscription you'd like to choose. +1. Read the information about the different products and subscriptions that {% data variables.product.company_short %} offers, then click the upgrade button under the subscription you'd like to choose. diff --git a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md index 42263962791e..536479f3ce3f 100644 --- a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md +++ b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md @@ -16,8 +16,8 @@ In this example, `job1` must complete successfully before `job2` begins, and `jo The jobs in this example run sequentially: 1. `job1` -2. `job2` -3. `job3` +1. `job2` +1. `job3` ### Example: Not requiring successful dependent jobs diff --git a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md index 96405d5530b1..0f412965c27e 100644 --- a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -1,6 +1,6 @@ {% ifversion fpt %} 1. Navigate to the main page of the organization where your self-hosted runner is registered. -2. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. +1. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} 1. Navigate to where your runner is registered: diff --git a/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md index 5292a76b69a8..ddb7097dc5af 100644 --- a/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md +++ b/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md @@ -1,6 +1,6 @@ {% ifversion fpt %} 1. Navigate to the main page of the organization or repository where your self-hosted runner group is registered. -2. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. +1. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} 1. Navigate to where your runner is registered: @@ -8,7 +8,7 @@ - **If using an enterprise-level runner**: {% indented_data_reference reusables.enterprise-accounts.access-enterprise spaces=5 %} -2. Navigate to the {% data variables.product.prodname_actions %} settings: +1. Navigate to the {% data variables.product.prodname_actions %} settings: - **In an organization or repository**: {% indented_data_reference reusables.actions.settings-ui.settings-actions-runners spaces=5 %} diff --git a/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md b/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md index c188f5e0959b..1dea05fc6046 100644 --- a/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md +++ b/data/reusables/advanced-security/secret-scanning-push-protection-enterprise.md @@ -2,7 +2,7 @@ ![Screenshot of the "Push protection" section of the "Code security and analysis" page. Two buttons, labeled "Enable all" and "Disable all", are highlighted with a dark orange outline.](/assets/images/enterprise/security/secret-scanning-enable-push-protection-enterprise.png) -2. Optionally, click "Automatically enable for repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion secret-scanning-custom-link-on-block %} -3. Optionally, to include a custom link in the message that members will see when they attempt to push a secret, click **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. +1. Optionally, click "Automatically enable for repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion secret-scanning-custom-link-on-block %} +1. Optionally, to include a custom link in the message that members will see when they attempt to push a secret, click **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. ![Screenshot of the "Push protection" section of the "Code security and analysis" page. The "Add a resource link in the CLI and web UI when a commit is blocked" checkbox and the custom link text field are highlighted with a dark orange outline.](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} diff --git a/data/reusables/apps/optional_feature_activation.md b/data/reusables/apps/optional_feature_activation.md index f120a495d982..258442666426 100644 --- a/data/reusables/apps/optional_feature_activation.md +++ b/data/reusables/apps/optional_feature_activation.md @@ -1,2 +1,2 @@ 1. In the settings sidebar, click **Optional features**. -2. Next to the optional feature you want to enable for your app, click **Opt-in**. +1. Next to the optional feature you want to enable for your app, click **Opt-in**. diff --git a/data/reusables/billing/create-personal-account.md b/data/reusables/billing/create-personal-account.md index c324287e7341..9f206d5ef9c1 100644 --- a/data/reusables/billing/create-personal-account.md +++ b/data/reusables/billing/create-personal-account.md @@ -1,6 +1,6 @@ If you already have a personal account on {% data variables.product.prodname_dotcom %}, skip to [step 2](#step-2-create-the-organization). 1. Go to the [Join GitHub](https://github.com/join) page. -2. Complete the form, then click **Create account**. +1. Complete the form, then click **Create account**. 3. Select {% data variables.product.prodname_free_user %} for your personal account. -4. Click **Finish sign up**. +1. Click **Finish sign up**. diff --git a/data/reusables/codespaces/codespaces-policy-targets.md b/data/reusables/codespaces/codespaces-policy-targets.md index ee684ed9d133..94af9c313345 100644 --- a/data/reusables/codespaces/codespaces-policy-targets.md +++ b/data/reusables/codespaces/codespaces-policy-targets.md @@ -13,7 +13,7 @@ ![Screenshot of the settings icon (a gear symbol) to the left of a button labeled "Selected repositories."](/assets/images/help/codespaces/policy-edit.png) - 2. Select the repositories you want this policy to apply to. - 3. At the bottom of the repository list, click **Select repositories**. + 1. Select the repositories you want this policy to apply to. + 1. At the bottom of the repository list, click **Select repositories**. ![Screenshot of a list of repositories, each with a checkbox. Three repositories are selected.](/assets/images/help/codespaces/policy-select-repos.png) diff --git a/data/reusables/codespaces/publishing-template-codespaces.md b/data/reusables/codespaces/publishing-template-codespaces.md index ccac8f99457f..18c8cfe19c88 100644 --- a/data/reusables/codespaces/publishing-template-codespaces.md +++ b/data/reusables/codespaces/publishing-template-codespaces.md @@ -10,19 +10,19 @@ If you're working in a codespace, you can publish it from the {% data variables. **Note:** If you start from {% data variables.product.company_short %}'s blank template, you will not see a list of changes unless you have already initialized your directory as a Git repository. To publish codespaces created from the blank template, click **Publish to {% data variables.product.company_short %}** in the Source Control view, then skip to step 5. {% endnote %} -2. To commit your staged changes, type a commit message describing the change you've made, then click **Commit**. +1. To commit your staged changes, type a commit message describing the change you've made, then click **Commit**. ![Screenshot of the "Source control" side bar with a commit message and, below it, the "Commit" button both highlighted with a dark orange outline.](/assets/images/help/codespaces/vscode-commit-button.png) -3. Click **Publish Branch**. +1. Click **Publish Branch**. ![Screenshot of the "Source control" side bar showing the "Publish Branch" button.](/assets/images/help/codespaces/vscode-publish-branch-button.png) -4. In the "Repository Name" dropdown, type a name for your new repository, then select **Publish to {% data variables.product.company_short %} private repository** or **Publish to {% data variables.product.company_short %} public repository**. +1. In the "Repository Name" dropdown, type a name for your new repository, then select **Publish to {% data variables.product.company_short %} private repository** or **Publish to {% data variables.product.company_short %} public repository**. ![Screenshot of the repository name dropdown in VS Code. Two options are shown, for publishing to a private or a public repository.](/assets/images/help/codespaces/choose-new-repository.png) The owner of the new repository will be the {% data variables.product.prodname_dotcom %} account with which you created the codespace. -5. Optionally, in the pop-up that appears in the lower right corner of the editor, click **Open on {% data variables.product.company_short %}** to view the new repository on {% data variables.product.prodname_dotcom_the_website %}. +1. Optionally, in the pop-up that appears in the lower right corner of the editor, click **Open on {% data variables.product.company_short %}** to view the new repository on {% data variables.product.prodname_dotcom_the_website %}. ![Screenshot of a confirmation message for a successfully published repository, showing the "Open on {% data variables.product.prodname_dotcom %}" button.](/assets/images/help/codespaces/open-on-github.png) diff --git a/data/reusables/codespaces/vscode-interface-annotation.md b/data/reusables/codespaces/vscode-interface-annotation.md index 5096092f8ab7..a786af1d1834 100644 --- a/data/reusables/codespaces/vscode-interface-annotation.md +++ b/data/reusables/codespaces/vscode-interface-annotation.md @@ -1,6 +1,6 @@ The main components of the user interface are: 1. **Side bar** - By default, this area shows your project files in the Explorer. -2. **Activity bar** - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. +1. **Activity bar** - This displays the Views and provides you with a way to switch between them. You can reorder the Views by dragging and dropping them. 3. **Editor** - This is where you edit your files. You can right-click the tab for a file to access options such as locating the file in the Explorer. -4. **Panels** - This is where you can see output and debug information, as well as the default place for the integrated Terminal. -5. **Status bar** - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. +1. **Panels** - This is where you can see output and debug information, as well as the default place for the integrated Terminal. +1. **Status bar** - This area provides you with useful information about your codespace and project. For example, the branch name, configured ports, and more. diff --git a/data/reusables/command_line/change-current-directory-clone.md b/data/reusables/command_line/change-current-directory-clone.md index cb5d6fdab84d..c56b7fc7668f 100644 --- a/data/reusables/command_line/change-current-directory-clone.md +++ b/data/reusables/command_line/change-current-directory-clone.md @@ -1 +1 @@ -4. Change the current working directory to the location where you want the cloned directory. +1. Change the current working directory to the location where you want the cloned directory. diff --git a/data/reusables/command_line/git-clone-url.md b/data/reusables/command_line/git-clone-url.md index 9cb67bbe57f5..0fb8ed642a4f 100644 --- a/data/reusables/command_line/git-clone-url.md +++ b/data/reusables/command_line/git-clone-url.md @@ -1,4 +1,4 @@ -5. Type `git clone`, and then paste the URL you copied earlier. +1. Type `git clone`, and then paste the URL you copied earlier. ```shell git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY diff --git a/data/reusables/command_line/local-clone-created.md b/data/reusables/command_line/local-clone-created.md index 056fc0be1adb..855ff85ca43c 100644 --- a/data/reusables/command_line/local-clone-created.md +++ b/data/reusables/command_line/local-clone-created.md @@ -1,4 +1,4 @@ -6. Press **Enter** to create your local clone. +1. Press **Enter** to create your local clone. ```shell $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY diff --git a/data/reusables/copilot/signup-procedure-enterprise.md b/data/reusables/copilot/signup-procedure-enterprise.md index ad6c652f4290..f8f2fccf4a58 100644 --- a/data/reusables/copilot/signup-procedure-enterprise.md +++ b/data/reusables/copilot/signup-procedure-enterprise.md @@ -1,6 +1,6 @@ 1. Go to the [{% data variables.product.prodname_copilot_for_business %} sign up page](https://github.com/github-copilot/business_signup/choose_business_type). -2. To purchase {% data variables.product.prodname_copilot %} for your enterprise, select **Enable {% data variables.product.prodname_copilot %} at an enterprise level** and click **Continue**. +1. To purchase {% data variables.product.prodname_copilot %} for your enterprise, select **Enable {% data variables.product.prodname_copilot %} at an enterprise level** and click **Continue**. 3. Select the enterprise for which you want to purchase {% data variables.product.prodname_copilot %} and click **Continue**. -4. Follow the steps to confirm your payment details, then click **Save**. +1. Follow the steps to confirm your payment details, then click **Save**. If you don't have a payment method on file, you'll be prompted to add one. diff --git a/data/reusables/dependabot/click-dependabot-tab.md b/data/reusables/dependabot/click-dependabot-tab.md index d308ade88501..020b07ba3124 100644 --- a/data/reusables/dependabot/click-dependabot-tab.md +++ b/data/reusables/dependabot/click-dependabot-tab.md @@ -1 +1 @@ -4. Under "Dependency graph", click **{% data variables.product.prodname_dependabot %}**. +1. Under "Dependency graph", click **{% data variables.product.prodname_dependabot %}**. diff --git a/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md b/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md index a6108c7abfe2..208ea7042069 100644 --- a/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md +++ b/data/reusables/dependabot/enabling-disabling-dependency-graph-private-repo.md @@ -5,7 +5,7 @@ You can also enable or disable the dependency graph for all repositories owned b {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -4. Read the message about granting {% data variables.product.product_name %} read-only access to the repository data to enable the dependency graph, then next to "Dependency Graph", click **Enable**. +1. Read the message about granting {% data variables.product.product_name %} read-only access to the repository data to enable the dependency graph, then next to "Dependency Graph", click **Enable**. ![Screenshot showing how to enable the dependency graph for a repository. The "Enable" button is highlighted with a dark orange outline.](/assets/images/help/repository/dependency-graph-enable-button.png) diff --git a/data/reusables/desktop/choose-a-theme.md b/data/reusables/desktop/choose-a-theme.md index 484a1037f666..c2c7f572c261 100644 --- a/data/reusables/desktop/choose-a-theme.md +++ b/data/reusables/desktop/choose-a-theme.md @@ -12,4 +12,4 @@ {% endwindows %} -4. Click the theme you'd like to use. If you want {% data variables.product.prodname_desktop %} to always match the theme on your computer, select **System**. +1. Click the theme you'd like to use. If you want {% data variables.product.prodname_desktop %} to always match the theme on your computer, select **System**. diff --git a/data/reusables/desktop/publish-repository.md b/data/reusables/desktop/publish-repository.md index 05e55a6097f7..3c8f14cc3cf8 100644 --- a/data/reusables/desktop/publish-repository.md +++ b/data/reusables/desktop/publish-repository.md @@ -1,3 +1,3 @@ -3. In the repository bar, click **Publish repository**. +1. In the repository bar, click **Publish repository**. ![Screenshot of the repository bar. A button, labeled "Publish repository", is highlighted with an orange outline.](/assets/images/help/desktop/publish-repository.png) diff --git a/data/reusables/discussions/marking-a-comment-as-an-answer.md b/data/reusables/discussions/marking-a-comment-as-an-answer.md index 10c6e7c132b4..45c922b5b3b7 100644 --- a/data/reusables/discussions/marking-a-comment-as-an-answer.md +++ b/data/reusables/discussions/marking-a-comment-as-an-answer.md @@ -17,4 +17,4 @@ When you mark a question as an answer, {% data variables.product.product_name %} ![Screenshot of a discussion comment. A button, labeled "Mark as answer", is outlined in dark orange.](/assets/images/help/discussions/comment-mark-as-answer-button.png) -2. Optionally, to unmark a comment as the answer, click **Unmark as answer**. +1. Optionally, to unmark a comment as the answer, click **Unmark as answer**. diff --git a/data/reusables/dotcom_billing/confirm_cancel_org_plan.md b/data/reusables/dotcom_billing/confirm_cancel_org_plan.md index 622a15b5469b..d9691696c131 100644 --- a/data/reusables/dotcom_billing/confirm_cancel_org_plan.md +++ b/data/reusables/dotcom_billing/confirm_cancel_org_plan.md @@ -1 +1 @@ -7. Read the information about the features your organization will no longer have access to on your next billing date, then click **I understand. Downgrade my organization**. +1. Read the information about the features your organization will no longer have access to on your next billing date, then click **I understand. Downgrade my organization**. diff --git a/data/reusables/dotcom_billing/enter_coupon_code_on_redeem_page.md b/data/reusables/dotcom_billing/enter_coupon_code_on_redeem_page.md index ae3cacb195d8..1540bf7dc2f9 100644 --- a/data/reusables/dotcom_billing/enter_coupon_code_on_redeem_page.md +++ b/data/reusables/dotcom_billing/enter_coupon_code_on_redeem_page.md @@ -1,3 +1,3 @@ 1. Visit the [Redeem coupon](https://github.com/redeem) page. -2. Type your coupon code and click **Redeem**. -3. If you're not already signed in, you can sign in on this page, or create a new account to apply your coupon to. +1. Type your coupon code and click **Redeem**. +1. If you're not already signed in, you can sign in on this page, or create a new account to apply your coupon to. diff --git a/data/reusables/dotcom_billing/redeem_coupon.md b/data/reusables/dotcom_billing/redeem_coupon.md index e40e742a261b..a57063a8f45d 100644 --- a/data/reusables/dotcom_billing/redeem_coupon.md +++ b/data/reusables/dotcom_billing/redeem_coupon.md @@ -1 +1 @@ -5. Under "Your new plan", review the information about your plan and discount, then click **Redeem**. +1. Under "Your new plan", review the information about your plan and discount, then click **Redeem**. diff --git a/data/reusables/enterprise-accounts/access-enterprise-on-dotcom.md b/data/reusables/enterprise-accounts/access-enterprise-on-dotcom.md index e60e9819f878..022c6c3de528 100644 --- a/data/reusables/enterprise-accounts/access-enterprise-on-dotcom.md +++ b/data/reusables/enterprise-accounts/access-enterprise-on-dotcom.md @@ -2,4 +2,4 @@ 1. In the top-right corner of {% data variables.product.prodname_dotcom_the_website %}, click your profile photo, then click **Your enterprises**. -2. In the list of enterprises, click the enterprise you want to view. +1. In the list of enterprises, click the enterprise you want to view. diff --git a/data/reusables/enterprise-accounts/continue-verifying-domain.md b/data/reusables/enterprise-accounts/continue-verifying-domain.md index 79cb5da15e07..317d637de15d 100644 --- a/data/reusables/enterprise-accounts/continue-verifying-domain.md +++ b/data/reusables/enterprise-accounts/continue-verifying-domain.md @@ -1,4 +1,4 @@ -9. To the right of the domain that's pending verification, click {% octicon "kebab-horizontal" aria-label="Show more options" %}, then click **Continue verifying**. +1. To the right of the domain that's pending verification, click {% octicon "kebab-horizontal" aria-label="Show more options" %}, then click **Continue verifying**. ![Screenshot of the list of verified and approved domains for your enterprise. A dropdown menu labeled with three dots is expanded and highlighted with an orange outline, along with the "Continue verifying domain" option.](/assets/images/help/enterprises/continue-verifying-domain-enterprise.png) -10. Click **Verify**. +1. Click **Verify**. diff --git a/data/reusables/enterprise-accounts/pages-policies-save.md b/data/reusables/enterprise-accounts/pages-policies-save.md index 4fb2d1cddc51..995ce6212501 100644 --- a/data/reusables/enterprise-accounts/pages-policies-save.md +++ b/data/reusables/enterprise-accounts/pages-policies-save.md @@ -1 +1 @@ - 6. Click **Save**. + 1. Click **Save**. diff --git a/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md b/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md index 6518fc5c051f..76006b7d2477 100644 --- a/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md +++ b/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md @@ -9,6 +9,6 @@ {% endnote %} 1. Decide if you want to reclaim mannequins. -2. Plan when you'll complete reclaims. +1. Plan when you'll complete reclaims. 3. Reclaim mannequins. -4. If any of the members do not already have appropriate access to the repository via team membership, give the members access to the repository. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository)." +1. If any of the members do not already have appropriate access to the repository via team membership, give the members access to the repository. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository)." diff --git a/data/reusables/enterprise_installation/generate-replication-key-pair.md b/data/reusables/enterprise_installation/generate-replication-key-pair.md index d65035b19498..c3fd67979449 100644 --- a/data/reusables/enterprise_installation/generate-replication-key-pair.md +++ b/data/reusables/enterprise_installation/generate-replication-key-pair.md @@ -1,4 +1,4 @@ -7. To generate a key pair for replication, use the `ghe-repl-setup` command with the primary appliance's IP address and copy the public key that it returns. +1. To generate a key pair for replication, use the `ghe-repl-setup` command with the primary appliance's IP address and copy the public key that it returns. ```shell ghe-repl-setup PRIMARY_IP diff --git a/data/reusables/enterprise_installation/instance-will-restart-automatically.md b/data/reusables/enterprise_installation/instance-will-restart-automatically.md index f585eb08adf1..5ac816053898 100644 --- a/data/reusables/enterprise_installation/instance-will-restart-automatically.md +++ b/data/reusables/enterprise_installation/instance-will-restart-automatically.md @@ -1 +1 @@ -4. The instance will restart automatically. +1. The instance will restart automatically. diff --git a/data/reusables/enterprise_installation/open-vm-console-start.md b/data/reusables/enterprise_installation/open-vm-console-start.md index 7ac7398ddcce..ec818bba20b6 100644 --- a/data/reusables/enterprise_installation/open-vm-console-start.md +++ b/data/reusables/enterprise_installation/open-vm-console-start.md @@ -1,2 +1,2 @@ 1. Using your virtualization platform tools, open the virtual machine console. -2. To start your network setup, press **S**. +1. To start your network setup, press **S**. diff --git a/data/reusables/enterprise_installation/replica-steps.md b/data/reusables/enterprise_installation/replica-steps.md index ae7bcbd914bd..87c09bf51d7b 100644 --- a/data/reusables/enterprise_installation/replica-steps.md +++ b/data/reusables/enterprise_installation/replica-steps.md @@ -1,4 +1,4 @@ 3. Set an admin password that matches the password on the primary appliance and continue. -4. Click **Configure as Replica**. -5. Under "Add new SSH key", type your SSH key. -6. Click **Add key**. +1. Click **Configure as Replica**. +1. Under "Add new SSH key", type your SSH key. +1. Click **Add key**. diff --git a/data/reusables/enterprise_installation/save-settings-in-web-based-mgmt-console.md b/data/reusables/enterprise_installation/save-settings-in-web-based-mgmt-console.md index 47f614658cf1..ac5de4923572 100644 --- a/data/reusables/enterprise_installation/save-settings-in-web-based-mgmt-console.md +++ b/data/reusables/enterprise_installation/save-settings-in-web-based-mgmt-console.md @@ -1 +1 @@ -3. In the [{% data variables.enterprise.management_console %}](/admin/configuration/administering-your-instance-from-the-management-console), configure and save your desired settings. +1. In the [{% data variables.enterprise.management_console %}](/admin/configuration/administering-your-instance-from-the-management-console), configure and save your desired settings. diff --git a/data/reusables/enterprise_installation/upload-a-license-file.md b/data/reusables/enterprise_installation/upload-a-license-file.md index 02a7be692fcc..5ebfdca0a0f5 100644 --- a/data/reusables/enterprise_installation/upload-a-license-file.md +++ b/data/reusables/enterprise_installation/upload-a-license-file.md @@ -1 +1 @@ -2. At the prompt, upload your license file and set a management console password. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise)." +1. At the prompt, upload your license file and set a management console password. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise)." diff --git a/data/reusables/enterprise_installation/verify-replication-channel.md b/data/reusables/enterprise_installation/verify-replication-channel.md index 83a9e26a4f2d..ce30f28b50aa 100644 --- a/data/reusables/enterprise_installation/verify-replication-channel.md +++ b/data/reusables/enterprise_installation/verify-replication-channel.md @@ -1,5 +1,5 @@ -11. To verify the status of each datastore's replication channel, use the `ghe-repl-status` command. +1. To verify the status of each datastore's replication channel, use the `ghe-repl-status` command. - ```shell - ghe-repl-status - ``` + ```shell + ghe-repl-status + ``` diff --git a/data/reusables/files/choose_pull_request.md b/data/reusables/files/choose_pull_request.md index 0f44609362fe..84b88a1131e7 100644 --- a/data/reusables/files/choose_pull_request.md +++ b/data/reusables/files/choose_pull_request.md @@ -1,2 +1,2 @@ 1. Create a pull request for your proposed changes. -2. In the "Pull Requests" list, click the pull request you would like to merge. +1. In the "Pull Requests" list, click the pull request you would like to merge. diff --git a/data/reusables/gpg/x-509-key.md b/data/reusables/gpg/x-509-key.md index 4727f49852ec..eee6581bf311 100644 --- a/data/reusables/gpg/x-509-key.md +++ b/data/reusables/gpg/x-509-key.md @@ -7,7 +7,7 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and 1. Install [smimesign](https://github.com/github/smimesign#installation). {% data reusables.command_line.open_the_multi_os_terminal %} -3. Configure Git to use S/MIME to sign commits and tags. In Git 2.19 or later, use the `git config gpg.x509.program` and `git config gpg.format` commands: +1. Configure Git to use S/MIME to sign commits and tags. In Git 2.19 or later, use the `git config gpg.x509.program` and `git config gpg.format` commands: - To use S/MIME to sign for all repositories: ```shell @@ -38,13 +38,13 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and ``` If you're using an X.509 key that matches your committer identity, you can begin signing commits and tags. -4. If you're not using an X.509 key that matches your committer identity, list X.509 keys for which you have both a certificate and private key using the `smimesign --list-keys` command. +1. If you're not using an X.509 key that matches your committer identity, list X.509 keys for which you have both a certificate and private key using the `smimesign --list-keys` command. ```shell smimesign --list-keys ``` -5. From the list of X.509 keys, copy the certificate ID of the X.509 key you'd like to use. In this example, the certificate ID is `0ff455a2708394633e4bb2f88002e3cd80cbd76f`: +1. From the list of X.509 keys, copy the certificate ID of the X.509 key you'd like to use. In this example, the certificate ID is `0ff455a2708394633e4bb2f88002e3cd80cbd76f`: ```shell $ smimesign --list-keys @@ -57,7 +57,7 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and Emails: octocat@github.com ``` -6. To set your X.509 signing key in Git, paste the text below, substituting in the certificate ID you copied earlier. +1. To set your X.509 signing key in Git, paste the text below, substituting in the certificate ID you copied earlier. - To use your X.509 key to sign for all repositories: ```shell diff --git a/data/reusables/identity-and-permissions/team-sync-confirm-saml.md b/data/reusables/identity-and-permissions/team-sync-confirm-saml.md index 4457e53ceb9a..648080da2c07 100644 --- a/data/reusables/identity-and-permissions/team-sync-confirm-saml.md +++ b/data/reusables/identity-and-permissions/team-sync-confirm-saml.md @@ -1 +1 @@ -3. Confirm that SAML SSO is enabled for your organization. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization)." +1. Confirm that SAML SSO is enabled for your organization. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization)." diff --git a/data/reusables/identity-and-permissions/team-sync-confirm.md b/data/reusables/identity-and-permissions/team-sync-confirm.md index 1b6cc0dbea4f..5ba6541bfc90 100644 --- a/data/reusables/identity-and-permissions/team-sync-confirm.md +++ b/data/reusables/identity-and-permissions/team-sync-confirm.md @@ -1,3 +1,3 @@ -5. Confirm team synchronization. +1. Confirm team synchronization. - If you have IdP access, click **Enable team synchronization**. You'll be redirected to your identity provider's SAML SSO page and asked to select your account and review the requested permissions. - If you don't have IdP access, copy the IdP redirect link and share it with your IdP administrator to continue enabling team synchronization. diff --git a/data/reusables/large_files/downgrade_data_packs.md b/data/reusables/large_files/downgrade_data_packs.md index 3fc468829881..7be7b1aed861 100644 --- a/data/reusables/large_files/downgrade_data_packs.md +++ b/data/reusables/large_files/downgrade_data_packs.md @@ -1,4 +1,4 @@ 1. Under "Downgrade data plan", select the number of data packs you'd like to downgrade to. ![Screenshot of the "Downgrade data plan" page. A dropdown menu, labeled "1", is highlighted with an orange outline.](/assets/images/help/large_files/downgrade_number_of_data_packs.png) -2. To finish downgrading, click **Downgrade data plan**. +1. To finish downgrading, click **Downgrade data plan**. diff --git a/data/reusables/organizations/create-team-choose-parent.md b/data/reusables/organizations/create-team-choose-parent.md index d500030cb2c1..35867678d5ef 100644 --- a/data/reusables/organizations/create-team-choose-parent.md +++ b/data/reusables/organizations/create-team-choose-parent.md @@ -1 +1 @@ -6. Optionally, if you're creating a child team, under "Parent team", select the **Select a parent team** dropdown menu and click a parent team. For more information about child teams, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams#nested-teams)." +1. Optionally, if you're creating a child team, under "Parent team", select the **Select a parent team** dropdown menu and click a parent team. For more information about child teams, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams#nested-teams)." diff --git a/data/reusables/organizations/delete-ssh-ca.md b/data/reusables/organizations/delete-ssh-ca.md index a3225c0ce1a2..7948e8ed024d 100644 --- a/data/reusables/organizations/delete-ssh-ca.md +++ b/data/reusables/organizations/delete-ssh-ca.md @@ -1,2 +1,2 @@ 1. Under "SSH Certificate Authorities", to the right of the CA you want to delete, click **Delete**. -2. Read the warning, then click **I understand, please delete this CA**. +1. Read the warning, then click **I understand, please delete this CA**. diff --git a/data/reusables/organizations/member-privileges.md b/data/reusables/organizations/member-privileges.md index 85fbdfe7279c..83d1fb6c52f3 100644 --- a/data/reusables/organizations/member-privileges.md +++ b/data/reusables/organizations/member-privileges.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} 1. In the "Access" section of the sidebar, click **{% octicon "people" aria-hidden="true" %} Member privileges**. {% else %} -4. In the left sidebar, click **Member privileges**. +1. In the left sidebar, click **Member privileges**. {% endif %} diff --git a/data/reusables/package_registry/add-npmrc-to-repo-step.md b/data/reusables/package_registry/add-npmrc-to-repo-step.md index b50b379fda7b..1c03025bd665 100644 --- a/data/reusables/package_registry/add-npmrc-to-repo-step.md +++ b/data/reusables/package_registry/add-npmrc-to-repo-step.md @@ -1 +1 @@ -3. Add the _.npmrc_ file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." +1. Add the _.npmrc_ file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." diff --git a/data/reusables/package_registry/authenticate-to-container-registry-steps.md b/data/reusables/package_registry/authenticate-to-container-registry-steps.md index f326d82fe24b..2b4b4059c907 100644 --- a/data/reusables/package_registry/authenticate-to-container-registry-steps.md +++ b/data/reusables/package_registry/authenticate-to-container-registry-steps.md @@ -13,13 +13,13 @@ For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." -2. Save your {% data variables.product.pat_v1 %}. We recommend saving your token as an environment variable. +1. Save your {% data variables.product.pat_v1 %}. We recommend saving your token as an environment variable. ```shell export CR_PAT=YOUR_TOKEN ``` -3. Using the CLI for your container type, sign in to the {% data variables.product.prodname_container_registry %} service at `{% data reusables.package_registry.container-registry-hostname %}`. +1. Using the CLI for your container type, sign in to the {% data variables.product.prodname_container_registry %} service at `{% data reusables.package_registry.container-registry-hostname %}`. {% raw %} ```shell diff --git a/data/reusables/package_registry/create-npmrc-owner-step.md b/data/reusables/package_registry/create-npmrc-owner-step.md index 1acb12c06364..b2eb1e23293a 100644 --- a/data/reusables/package_registry/create-npmrc-owner-step.md +++ b/data/reusables/package_registry/create-npmrc-owner-step.md @@ -1,4 +1,4 @@ -2. In the same directory as your `package.json` file, create or edit an `.npmrc` file to include a line specifying {% data variables.product.prodname_registry %} URL and the namespace where the package is hosted. Replace `NAMESPACE` with the name of the user or organization account {% ifversion packages-npm-v2 %}to which the package will be scoped{% else %}that owns the repository containing your project{% endif %}. +1. In the same directory as your `package.json` file, create or edit an `.npmrc` file to include a line specifying {% data variables.product.prodname_registry %} URL and the namespace where the package is hosted. Replace `NAMESPACE` with the name of the user or organization account {% ifversion packages-npm-v2 %}to which the package will be scoped{% else %}that owns the repository containing your project{% endif %}. {% ifversion fpt or ghec %} diff --git a/data/reusables/package_registry/package-settings-from-org-level.md b/data/reusables/package_registry/package-settings-from-org-level.md index 234e71148c38..9e6a11146dc4 100644 --- a/data/reusables/package_registry/package-settings-from-org-level.md +++ b/data/reusables/package_registry/package-settings-from-org-level.md @@ -1,4 +1,4 @@ 1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your organization. -2. Under your organization name, click the {% octicon "package" aria-hidden="true" %} **Packages** tab. +1. Under your organization name, click the {% octicon "package" aria-hidden="true" %} **Packages** tab. ![Screenshot of @octo-org's profile page. The "Packages" tab is highlighted with an orange outline.](/assets/images/help/package-registry/org-tab-for-packages-with-overview-tab.png) diff --git a/data/reusables/package_registry/package-settings-from-user-level.md b/data/reusables/package_registry/package-settings-from-user-level.md index e30f70e2bdef..a77323ba8b32 100644 --- a/data/reusables/package_registry/package-settings-from-user-level.md +++ b/data/reusables/package_registry/package-settings-from-user-level.md @@ -1,5 +1,5 @@ 1. On {% data variables.product.prodname_dotcom %}, navigate to the main page of your personal account. -2. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. +1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. ![Screenshot of the dropdown menu under @octocat's profile picture. "Your profile" is outlined in dark orange.](/assets/images/help/profile/top-right-avatar.png) -3. On your profile page, in the header, click the {% octicon "package" aria-hidden="true" %} **Packages** tab. +1. On your profile page, in the header, click the {% octicon "package" aria-hidden="true" %} **Packages** tab. diff --git a/data/reusables/package_registry/package-settings-option.md b/data/reusables/package_registry/package-settings-option.md index dcef67641bb3..abe8e28814f3 100644 --- a/data/reusables/package_registry/package-settings-option.md +++ b/data/reusables/package_registry/package-settings-option.md @@ -1,4 +1,4 @@ 1. Search for and then click the name of the package that you want to manage. -4. On your package's landing page, on the right-hand side, click **{% octicon "gear" aria-hidden="true" %} Package settings**. +1. On your package's landing page, on the right-hand side, click **{% octicon "gear" aria-hidden="true" %} Package settings**. ![Screenshot of a package's landing page. In the lower right corner, "Package settings" is highlighted with an orange outline.](/assets/images/help/package-registry/package-settings.png) diff --git a/data/reusables/pages/recommend-bundler.md b/data/reusables/pages/recommend-bundler.md index 47519e9e1bc3..59807ed940d6 100644 --- a/data/reusables/pages/recommend-bundler.md +++ b/data/reusables/pages/recommend-bundler.md @@ -1,4 +1,4 @@ We recommend using [Bundler](http://bundler.io/) to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler: 1. Install Ruby. For more information, see "[Installing Ruby](https://www.ruby-lang.org/en/documentation/installation/)" in the Ruby documentation. - 2. Install Bundler. For more information, see "[Bundler](https://bundler.io/)." + 1. Install Bundler. For more information, see "[Bundler](https://bundler.io/)." diff --git a/data/reusables/pages/settings-verify-domain-confirm.md b/data/reusables/pages/settings-verify-domain-confirm.md index 4e48f1713d65..fe50db445447 100644 --- a/data/reusables/pages/settings-verify-domain-confirm.md +++ b/data/reusables/pages/settings-verify-domain-confirm.md @@ -2,4 +2,4 @@ ![Screenshot of {% data variables.product.prodname_pages %} settings showing verified domains. Under the horizontal kebab icon to the right, the "Continue verifying" dropdown option is outlined in dark orange.](/assets/images/help/pages/verify-continue.png) 1. To verify your domain, click **Verify**. -2. To make sure your custom domain remains verified, keep the TXT record in your domain's DNS configuration. +1. To make sure your custom domain remains verified, keep the TXT record in your domain's DNS configuration. diff --git a/data/reusables/pages/settings-verify-domain-setup.md b/data/reusables/pages/settings-verify-domain-setup.md index 69795aef1ee8..6c1d6e8548a8 100644 --- a/data/reusables/pages/settings-verify-domain-setup.md +++ b/data/reusables/pages/settings-verify-domain-setup.md @@ -1,5 +1,5 @@ 1. On the right, click **Add a domain**. -2. Under "What domain would you like to add?," enter the domain you wish to verify and select **Add domain**. +1. Under "What domain would you like to add?," enter the domain you wish to verify and select **Add domain**. ![Screenshot of a text box to add a verified domain on {% data variables.product.prodname_pages %}, filled in with "example.com." Below the text is a green button labeled "Add domain."](/assets/images/help/pages/verify-enter-domain.png) -3. Follow the instructions under "Add a DNS TXT record" to create the TXT record with your domain hosting service. +1. Follow the instructions under "Add a DNS TXT record" to create the TXT record with your domain hosting service. ![Screenshot of {% data variables.product.prodname_pages %} instructions to add a TXT record to the DNS configuration of example.com.](/assets/images/help/pages/verify-dns.png) diff --git a/data/reusables/profile/org_settings.md b/data/reusables/profile/org_settings.md index b9a53ea12729..dcbd4a1aa028 100644 --- a/data/reusables/profile/org_settings.md +++ b/data/reusables/profile/org_settings.md @@ -1 +1 @@ -2. Next to the organization, click **Settings**. +1. Next to the organization, click **Settings**. diff --git a/data/reusables/project-management/add-collaborator.md b/data/reusables/project-management/add-collaborator.md index 84ccaccc85ca..8f65836ace92 100644 --- a/data/reusables/project-management/add-collaborator.md +++ b/data/reusables/project-management/add-collaborator.md @@ -1 +1 @@ -10. In the search results, click the correct username and click **Add collaborator**. +1. In the search results, click the correct username and click **Add collaborator**. diff --git a/data/reusables/project-management/choose-template.md b/data/reusables/project-management/choose-template.md index 5f63cda0c711..6979185464e1 100644 --- a/data/reusables/project-management/choose-template.md +++ b/data/reusables/project-management/choose-template.md @@ -1 +1 @@ -5. Optionally, to add a template to your project board, use the **Template:** drop-down menu and click a template. +1. Optionally, to add a template to your project board, use the **Template:** drop-down menu and click a template. diff --git a/data/reusables/project-management/collaborator-option.md b/data/reusables/project-management/collaborator-option.md index 11e718c957c0..6db8ee359aec 100644 --- a/data/reusables/project-management/collaborator-option.md +++ b/data/reusables/project-management/collaborator-option.md @@ -1 +1 @@ -8. In the left sidebar, click **Collaborators**. +1. In the left sidebar, click **Collaborators**. diff --git a/data/reusables/project-management/collaborator-permissions.md b/data/reusables/project-management/collaborator-permissions.md index c00cc1816241..a643bf802252 100644 --- a/data/reusables/project-management/collaborator-permissions.md +++ b/data/reusables/project-management/collaborator-permissions.md @@ -1 +1 @@ -11. Optionally, next to the new collaborator's name, use the drop-down menu and click the desired permission level: **Read**, **Write**, or **Admin**. +1. Optionally, next to the new collaborator's name, use the drop-down menu and click the desired permission level: **Read**, **Write**, or **Admin**. diff --git a/data/reusables/project-management/remove-collaborator.md b/data/reusables/project-management/remove-collaborator.md index 08ba4b7ee55e..4f23cd4ddbf5 100644 --- a/data/reusables/project-management/remove-collaborator.md +++ b/data/reusables/project-management/remove-collaborator.md @@ -1 +1 @@ -4. Next to the collaborator you want to remove, click **X**. +1. Next to the collaborator you want to remove, click **X**. diff --git a/data/reusables/projects/access-insights.md b/data/reusables/projects/access-insights.md index bb401838d736..3c64de50869a 100644 --- a/data/reusables/projects/access-insights.md +++ b/data/reusables/projects/access-insights.md @@ -1,3 +1,3 @@ 1. Navigate to your project. -2. In the top-right, to access insights, click {% octicon "graph" aria-label="Navigate to insights" %}. +1. In the top-right, to access insights, click {% octicon "graph" aria-label="Navigate to insights" %}. ![Screenshot showing a projects menu buttons. The insights button is highlighted with an orange outline.](/assets/images/help/projects-v2/insights-button.png) diff --git a/data/reusables/projects/add-item-via-paste.md b/data/reusables/projects/add-item-via-paste.md index e1e787afedec..2de9e567fefe 100644 --- a/data/reusables/projects/add-item-via-paste.md +++ b/data/reusables/projects/add-item-via-paste.md @@ -1,3 +1,3 @@ {% data reusables.projects.add-item-bottom-row %} 1. Paste the URL of the issue or pull request. -3. To add the issue or pull request, press Return. +1. To add the issue or pull request, press Return. diff --git a/data/reusables/projects/project-settings.md b/data/reusables/projects/project-settings.md index f55c3443691b..e948962cb7ae 100644 --- a/data/reusables/projects/project-settings.md +++ b/data/reusables/projects/project-settings.md @@ -3,4 +3,4 @@ ![Screenshot showing a project's menu bar. The menu icon is highlighted with an orange outline.](/assets/images/help/projects-v2/open-menu.png) -2. In the menu, click {% octicon "gear" aria-hidden="true" %} **Settings** to access the project settings. +1. In the menu, click {% octicon "gear" aria-hidden="true" %} **Settings** to access the project settings. diff --git a/data/reusables/repositories/changed-repository-access-permissions.md b/data/reusables/repositories/changed-repository-access-permissions.md index f47035db1658..ed073ac6f0bc 100644 --- a/data/reusables/repositories/changed-repository-access-permissions.md +++ b/data/reusables/repositories/changed-repository-access-permissions.md @@ -1 +1 @@ -8. Read about the changed repository access permissions. +1. Read about the changed repository access permissions. diff --git a/data/reusables/repositories/click-dependency-graph.md b/data/reusables/repositories/click-dependency-graph.md index 6140b0a0af66..9d3ac4cb49f7 100644 --- a/data/reusables/repositories/click-dependency-graph.md +++ b/data/reusables/repositories/click-dependency-graph.md @@ -1,2 +1,2 @@ -3. In the left sidebar, click **Dependency graph**. +1. In the left sidebar, click **Dependency graph**. ![Screenshot of the "Dependency graph" tab. The tab is highlighted with an orange outline.](/assets/images/help/graphs/graphs-sidebar-dependency-graph.png) diff --git a/data/reusables/repositories/edited-comment-list.md b/data/reusables/repositories/edited-comment-list.md index c65795b83f1f..f0f76d2bbb2a 100644 --- a/data/reusables/repositories/edited-comment-list.md +++ b/data/reusables/repositories/edited-comment-list.md @@ -1,4 +1,4 @@ -2. At the top of the comment, click **edited** to open the edit history. +1. At the top of the comment, click **edited** to open the edit history. {% note %} @@ -6,6 +6,6 @@ {% endnote %} -3. To view the details of a specific change, select it from the list of edits. +1. To view the details of a specific change, select it from the list of edits. ![Screenshot of a {% data variables.product.prodname_dotcom %} comment showing a dropdown menu open to display previous edits of the comment.](/assets/images/help/repository/choose-comment-edit-to-expand.png) diff --git a/data/reusables/saml/recovery-code-access.md b/data/reusables/saml/recovery-code-access.md index e5e6638b3e99..afb162c91be4 100644 --- a/data/reusables/saml/recovery-code-access.md +++ b/data/reusables/saml/recovery-code-access.md @@ -1,5 +1,5 @@ 1. Under the single sign-on dialog, click **Use a recovery code**. -2. In the "Recovery Code" field, type your recovery code. -3. Click **Verify**. +1. In the "Recovery Code" field, type your recovery code. +1. Click **Verify**. After you've used a recovery code, make sure to note that the code is no longer valid. You will not be able to reuse the recovery code. diff --git a/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md b/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md index 9f33b961a9e4..63765a8f6978 100644 --- a/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md +++ b/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md @@ -1,4 +1,4 @@ -2. Choose the option that best describes why you should be able to push the secret. +1. Choose the option that best describes why you should be able to push the secret. - If the secret is only used in tests and poses no threat, click **It's used in tests**. - If the detected string is not a secret, click **It's a false positive**. - If the secret is real but you intend to fix it later, click **I'll fix it later**. diff --git a/data/reusables/server-statistics/csv-download.md b/data/reusables/server-statistics/csv-download.md index 2f2d496b2fbf..0d4972f6cb59 100644 --- a/data/reusables/server-statistics/csv-download.md +++ b/data/reusables/server-statistics/csv-download.md @@ -1 +1 @@ -4. To start your download, next to "{% data variables.product.prodname_server_statistics %}", select the **Export** dropdown menu, then choose whether you want to download a JSON or CSV file. +1. To start your download, next to "{% data variables.product.prodname_server_statistics %}", select the **Export** dropdown menu, then choose whether you want to download a JSON or CSV file. diff --git a/data/reusables/sponsors/publish-sponsor-update.md b/data/reusables/sponsors/publish-sponsor-update.md index 3a0f6c101c30..c0300df74eca 100644 --- a/data/reusables/sponsors/publish-sponsor-update.md +++ b/data/reusables/sponsors/publish-sponsor-update.md @@ -1 +1 @@ -7. Click **Publish**. +1. Click **Publish**. diff --git a/data/reusables/sponsors/retire-goal.md b/data/reusables/sponsors/retire-goal.md index 81e85d952c1b..2c4d3fbbe152 100644 --- a/data/reusables/sponsors/retire-goal.md +++ b/data/reusables/sponsors/retire-goal.md @@ -1,2 +1,2 @@ 1. At the bottom of the page, click **Retire**. -2. In the modal that appears, read the warning, then click **OK**. +1. In the modal that appears, read the warning, then click **OK**. diff --git a/data/reusables/support/submit-a-ticket.md b/data/reusables/support/submit-a-ticket.md index 58aa4d76ce90..d69627a6a48f 100644 --- a/data/reusables/support/submit-a-ticket.md +++ b/data/reusables/support/submit-a-ticket.md @@ -37,7 +37,7 @@ {% endnote %} {%- endif %} 1. Under "Subject", type a descriptive title for the issue you're having. -2. Under "How can we help", provide any additional information that will help the Support team troubleshoot the problem. You can use markdown to format your message. +1. Under "How can we help", provide any additional information that will help the Support team troubleshoot the problem. You can use markdown to format your message. Helpful information may include: - Steps to reproduce the issue diff --git a/data/reusables/user-settings/add_and_verify_email.md b/data/reusables/user-settings/add_and_verify_email.md index 2a428926c278..0353371bd654 100644 --- a/data/reusables/user-settings/add_and_verify_email.md +++ b/data/reusables/user-settings/add_and_verify_email.md @@ -1,4 +1,4 @@ {% ifversion not ghae %} 1. In "Add email address", type your email address and click **Add**.{% ifversion fpt or ghec %} -2. [Verify your email address](/get-started/signing-up-for-github/verifying-your-email-address).{% endif %} +1. [Verify your email address](/get-started/signing-up-for-github/verifying-your-email-address).{% endif %} {% endif %} diff --git a/data/reusables/user-settings/edit_marketplace_listing.md b/data/reusables/user-settings/edit_marketplace_listing.md index ceaeb570bf65..0352c5d010a8 100644 --- a/data/reusables/user-settings/edit_marketplace_listing.md +++ b/data/reusables/user-settings/edit_marketplace_listing.md @@ -1 +1 @@ -5. On the app settings landing page, scroll down to the Marketplace section and click **List in Marketplace**. If you already have a Marketplace draft listing, click **Edit Marketplace listing**. The Marketplace section is only visible if you allowed your app to be installed by any user or organization when registering the app. For more information, see the list of [Marketplace requirements](/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app). +1. On the app settings landing page, scroll down to the Marketplace section and click **List in Marketplace**. If you already have a Marketplace draft listing, click **Edit Marketplace listing**. The Marketplace section is only visible if you allowed your app to be installed by any user or organization when registering the app. For more information, see the list of [Marketplace requirements](/apps/publishing-apps-to-github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app).