Skip to content

Commit fc00ea2

Browse files
Fix alerts (#35468)
Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
1 parent 49c48e0 commit fc00ea2

File tree

68 files changed

+189
-409
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+189
-409
lines changed

content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -415,11 +415,8 @@ template:
415415
416416
You can customize the PodSpec of the listener pod and the controller will apply the configuration you specify. The following is an example pod specification.
417417
418-
{% note %}
419-
420-
It's important to not change the `listenerTemplate.spec.containers.name` value of the listener container. Otherwise, the configuration you specify will be applied to a new side-car container.
421-
422-
{% endnote %}
418+
> [!NOTE]
419+
> It's important to not change the `listenerTemplate.spec.containers.name` value of the listener container. Otherwise, the configuration you specify will be applied to a new side-car container.
423420

424421
```yaml
425422
listenerTemplate:
@@ -916,11 +913,8 @@ You can also use ARC with {% data variables.product.prodname_codeql %} to identi
916913
917914
If you're using default setup for {% data variables.product.prodname_code_scanning %}, the analysis will automatically look for a runner scale set with the installation name `code-scanning` {% ifversion code-scanning-default-setup-customize-labels %} but you can specify a custom name in the configuration, so that individual repositories can use different runner scale sets. See "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning#assigning-labels-to-runners){% endif %}.
918915
919-
{% note %}
920-
921-
The [Dependabot Action](https://github.com/github/dependabot-action) is used to run {% data variables.product.prodname_dependabot %} updates via {% data variables.product.prodname_actions %}. This action requires Docker as a dependency. For this reason, you can only use {% data variables.product.prodname_actions_runner_controller %} with {% data variables.product.prodname_dependabot %} when Docker-in-Docker (DinD) mode is enabled. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates#system-requirements-for-dependabot-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller#using-docker-in-docker-or-kubernetes-mode-for-containers)."
922-
923-
{% endnote %}
916+
> [!NOTE]
917+
> The [Dependabot Action](https://github.com/github/dependabot-action) is used to run {% data variables.product.prodname_dependabot %} updates via {% data variables.product.prodname_actions %}. This action requires Docker as a dependency. For this reason, you can only use {% data variables.product.prodname_actions_runner_controller %} with {% data variables.product.prodname_dependabot %} when Docker-in-Docker (DinD) mode is enabled. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates#system-requirements-for-dependabot-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller#using-docker-in-docker-or-kubernetes-mode-for-containers)."
924918
925919
{% endif %}
926920

content/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -305,11 +305,8 @@ jobs:
305305
echo 'publishing'
306306
```
307307

308-
{% note %}
309-
310-
{% data reusables.gated-features.environments %}
311-
312-
{% endnote %}
308+
> [!NOTE]
309+
> {% data reusables.gated-features.environments %}
313310

314311
## Available events
315312

content/admin/managing-iam/iam-configuration-reference/saml-configuration-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The following SAML attributes are available for {% data variables.product.produc
7676

7777
| Name | Required | Description |
7878
| :- | :- | :- |
79-
| `NameID` | {% octicon "check" aria-label="Required" %} | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."<br><br>{% note %}**Note:** It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} |
79+
| `NameID` | {% octicon "check" aria-label="Required" %} | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."<br><br> > [!NOTE] It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management. |
8080
| `SessionNotOnOrAfter` | {% octicon "x" aria-label="Optional" %} | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec %}your enterprise's resources{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." |
8181
| {% ifversion ghes %} |
8282
| `administrator` | {% octicon "x" aria-label="Optional" %} | When the value is `true`, {% data variables.product.product_name %} will automatically promote the user to be a {% ifversion ghes %}site administrator{% endif %}. Setting this attribute to anything but `true` will result in demotion, as long as the value is not blank. Omitting this attribute or leaving the value blank will not change the role of the user. |

content/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,8 @@ curl --request GET \
5656

5757
You can use {% data variables.product.company_short %}'s Octokit.js SDK to authenticate as an app installation. One advantage of using the SDK to authenticate is that you do not need to generate a JSON web token (JWT) yourself. Additionally, the SDK will take care of regenerating an installation access token for you so you don't need to worry about the one hour expiration.
5858

59-
{% note %}
60-
61-
You must install and import `octokit` in order to use the Octokit.js library. The following example uses import statements in accordance with ES6. For more information about different installation and import methods, see [the Octokit.js README's Usage section](https://github.com/octokit/octokit.js/#usage).
62-
63-
{% endnote %}
59+
> [!NOTE]
60+
> You must install and import `octokit` in order to use the Octokit.js library. The following example uses import statements in accordance with ES6. For more information about different installation and import methods, see [the Octokit.js README's Usage section](https://github.com/octokit/octokit.js/#usage).
6461
6562
### Using Octokit.js to authenticate with an installation ID
6663

content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/handling-new-purchases-and-free-trials.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,8 @@ shortTitle: New purchases & free trials
1919

2020
{% data reusables.marketplace.marketplace-apps-not-actions %}
2121

22-
{% warning %}
23-
24-
If you offer a {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, your app must identify users following the OAuth authorization flow. You don't need to set up a separate {% data variables.product.prodname_oauth_app %} to support this flow. See "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)" for more information.
25-
26-
{% endwarning %}
22+
> [!WARNING]
23+
> If you offer a {% data variables.product.prodname_github_app %} in {% data variables.product.prodname_marketplace %}, your app must identify users following the OAuth authorization flow. You don't need to set up a separate {% data variables.product.prodname_oauth_app %} to support this flow. See "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)" for more information.
2724
2825
## Step 1. Initial purchase and webhook event
2926

content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/testing-your-app.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,8 @@ Because you can only create draft {% data variables.product.prodname_marketplace
2929

3030
Once you have a development app with a draft listing, you can use it to test changes you make to your app while integrating with the {% data variables.product.prodname_marketplace %} API and webhooks.
3131

32-
{% warning %}
33-
34-
Do not make test purchases with an app that is live in {% data variables.product.prodname_marketplace %}.
35-
36-
{% endwarning %}
32+
> [!WARNING]
33+
> Do not make test purchases with an app that is live in {% data variables.product.prodname_marketplace %}.
3734
3835
### Simulating Marketplace purchase events
3936

content/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,8 @@ In this section, we're going to focus on the basics of authentication. Specifica
2020
we're going to create a Ruby server (using [Sinatra](http://www.sinatrarb.com/)) that implements
2121
the [web flow](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps) of an application in several different ways.
2222

23-
{% tip %}
24-
25-
You can download the complete source code for this project [from the platform-samples repo](https://github.com/github/platform-samples/tree/master/api/).
26-
27-
{% endtip %}
23+
> [!TIP]
24+
> You can download the complete source code for this project [from the platform-samples repo](https://github.com/github/platform-samples/tree/master/api/).
2825
2926
## Registering your app
3027

content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -147,15 +147,12 @@ If the command says that no identity is available, you'll need to add your key:
147147
ssh-add YOUR-KEY
148148
```
149149

150-
{% tip %}
151-
152-
On macOS, `ssh-agent` will "forget" this key, once it gets restarted during reboots. But you can import your SSH keys into Keychain using this command:
153-
154-
```shell
155-
ssh-add --apple-use-keychain YOUR-KEY
156-
```
157-
158-
{% endtip %}
150+
> [!TIP]
151+
> On macOS, `ssh-agent` will "forget" this key, once it gets restarted during reboots. But you can import your SSH keys into Keychain using this command:
152+
>
153+
> ```shell
154+
> ssh-add --apple-use-keychain YOUR-KEY
155+
> ```
159156

160157
{% data reusables.ssh.apple-use-keychain %}
161158

content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,8 @@ In rare circumstances, images that are processed through Camo might not appear o
2626

2727
{% windows %}
2828

29-
{% tip %}
30-
31-
Windows users will either need to use the Git PowerShell (which is installed alongside [{% data variables.product.prodname_desktop %}](https://desktop.github.com/)) or download [curl for Windows](http://curl.haxx.se/download.html).
32-
33-
{% endtip %}
29+
> [!TIP]
30+
> Windows users will either need to use the Git PowerShell (which is installed alongside [{% data variables.product.prodname_desktop %}](https://desktop.github.com/)) or download [curl for Windows](http://curl.haxx.se/download.html).
3431
3532
{% endwindows %}
3633

content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,8 @@ shortTitle: Update access credentials
4343
1. In the text field under **Password**, type a new password. Then, in the text field under **Confirm password**, type the password again.
4444
1. Click **Change password**. For help creating a strong password, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-strong-password)."
4545

46-
{% tip %}
47-
48-
To avoid losing your password in the future, we suggest using a secure password manager.
49-
50-
{% endtip %}
46+
> [!TIP]
47+
> To avoid losing your password in the future, we suggest using a secure password manager.
5148
5249
## Changing an existing password
5350

@@ -59,11 +56,8 @@ To avoid losing your password in the future, we suggest using a secure password
5956
1. Under "Change password", type your old password, a strong new password, and confirm your new password. For help creating a strong password, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-strong-password)."
6057
1. Click **Update password**.
6158

62-
{% tip %}
63-
64-
For greater security, enable two-factor authentication in addition to changing your password. See [About two-factor authentication](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication) for more details.
65-
66-
{% endtip %}
59+
> [!TIP]
60+
> For greater security, enable two-factor authentication in addition to changing your password. See [About two-factor authentication](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication) for more details.
6761
6862
## Updating your access tokens
6963

content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ shortTitle: Tell Git about your signing key
2222

2323
If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags.
2424

25-
If you don't have a GPG key that matches your committer identity, you need to associate an email with an existing key. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)".
25+
> [!NOTE]
26+
> If you don't have a GPG key that matches your committer identity, you need to associate an email with an existing key. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)".
2627
2728
If you have multiple GPG keys, you need to tell Git which one to use.
2829

@@ -60,11 +61,8 @@ If you have multiple GPG keys, you need to tell Git which one to use.
6061

6162
If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags.
6263

63-
{% note %}
64-
65-
If you don't have a GPG key that matches your committer identity, you need to associate an email with an existing key. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)".
66-
67-
{% endnote %}
64+
> [!NOTE]
65+
> If you don't have a GPG key that matches your committer identity, you need to associate an email with an existing key. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)".
6866
6967
If you have multiple GPG keys, you need to tell Git which one to use.
7068

@@ -81,11 +79,8 @@ If you have multiple GPG keys, you need to tell Git which one to use.
8179

8280
If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags.
8381

84-
{% note %}
85-
86-
If you don't have a GPG key that matches your committer identity, you need to associate an email with an existing key. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)".
87-
88-
{% endnote %}
82+
> [!NOTE]
83+
> If you don't have a GPG key that matches your committer identity, you need to associate an email with an existing key. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key)".
8984
9085
If you have multiple GPG keys, you need to tell Git which one to use.
9186

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ topics:
1212
- SSH
1313
shortTitle: Use SSH over HTTPS port
1414
---
15-
{% tip %}
1615

17-
**{% data variables.product.prodname_ghe_server %} users:** Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported.
18-
19-
{% endtip %}
16+
> [!WARNING]
17+
> **{% data variables.product.prodname_ghe_server %} users:** Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported.
2018
2119
To test if SSH over the HTTPS port is possible, run this SSH command:
2220

content/billing/managing-billing-for-your-products/managing-billing-for-github-packages/about-billing-for-github-packages.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,8 @@ shortTitle: About billing
3030

3131
{% data reusables.package_registry.packages-spending-limit-brief %} For more information, see "[About spending limits](#about-spending-limits)."
3232

33-
{% note %}
34-
35-
**Billing update for container image storage:** The period of free use for container image storage and bandwidth for the {% data variables.product.prodname_container_registry %} has been extended. If you are using {% data variables.product.prodname_container_registry %} you'll be informed at least one month in advance of billing commencing and you'll be given an estimate of how much you should expect to pay. For more information about the {% data variables.product.prodname_container_registry %}, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)."
36-
37-
{% endnote %}
33+
> [!NOTE]
34+
> **Billing update for container image storage:** The period of free use for container image storage and bandwidth for the {% data variables.product.prodname_container_registry %} has been extended. If you are using {% data variables.product.prodname_container_registry %} you'll be informed at least one month in advance of billing commencing and you'll be given an estimate of how much you should expect to pay. For more information about the {% data variables.product.prodname_container_registry %}, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)."
3835
3936
If you are an organization owner{% ifversion ghec %} or enterprise owner{% endif %}, you can connect an Azure Subscription ID to your organization {% ifversion ghec %}or enterprise{% endif %} account to enable and pay for {% data variables.product.prodname_registry %} usage beyond the amounts including with your account. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription)."
4037

content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,5 @@ If you prefer to have guidance throughout the rollout process, {% data variables
4444

4545
Speak with your sales representative for more information about all the {% data variables.product.prodname_professional_services %} options available. For more information, contact {% data variables.contact.contact_enterprise_sales %}.
4646

47-
{% note %}
48-
49-
For the first article in this series, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals)."
50-
51-
{% endnote %}
47+
> [!NOTE]
48+
> For the first article in this series, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals)."

content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,8 @@ topics:
99
shortTitle: 1. Align on strategy
1010
---
1111

12-
{% note %}
13-
14-
This article is part of a series on adopting {% data variables.product.prodname_GH_advanced_security %} at scale. For the introduction to this series, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale)."
15-
16-
{% endnote %}
12+
> [!NOTE]
13+
> This article is part of a series on adopting {% data variables.product.prodname_GH_advanced_security %} at scale. For the introduction to this series, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale)."
1714
1815
## Set clear goals for your company’s rollout
1916

@@ -61,8 +58,5 @@ If your company is interested in custom {% data variables.product.prodname_codeq
6158

6259
When {% data variables.product.prodname_code_scanning %} is run from a pull request, the scan will include the full codebase and not just the changes made in the pull request. Scanning the entire codebase is an important step to ensure the change has been reviewed against all interactions in the codebase.
6360

64-
{% note %}
65-
66-
For the next article in this series, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale)."
67-
68-
{% endnote %}
61+
> [!NOTE]
62+
> For the next article in this series, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale)."

0 commit comments

Comments
 (0)