Skip to content

Commit 9bb1b98

Browse files
akordowskinguyenalex836
akordowski
and
nguyenalex836
authored
Fix inconsistent alerts by using the markdown notation - part 4 (#35223)
Co-authored-by: Alex Nguyen <[email protected]>
1 parent b7bbf37 commit 9bb1b98

File tree

286 files changed

+755
-1616
lines changed

Some content is hidden

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

286 files changed

+755
-1616
lines changed

Diff for: ‎contributing/debugging-the-docs-application.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repo has configuration for debugging the codebase with VS Code's built-in Node Debugger.
44

5-
**Note**: These steps will only help with debugging issues in the Node.js codebase, not in the content files.
5+
**Note:** These steps will only help with debugging issues in the Node.js codebase, not in the content files.
66

77
1. After running the build steps, start the app by running `npm run debug`.
88
1. In VS Code, click on the Debugging icon in the Activity Bar to bring up the Debug view.

Diff for: ‎data/reusables/actions/actions-group-concurrency.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,9 @@ This means that there can be at most one running and one pending job in a concur
22

33
To also cancel any currently running job or workflow in the same concurrency group, specify `cancel-in-progress: true`. To conditionally cancel currently running jobs or workflows in the same concurrency group, you can specify `cancel-in-progress` as an expression with any of the allowed expression contexts.
44

5-
{% note %}
6-
7-
**Notes:**
8-
9-
* The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group.
10-
* Ordering is not guaranteed for jobs or workflow runs using concurrency groups. Jobs or workflow runs in the same concurrency group are handled in an arbitrary order.
11-
12-
{% endnote %}
5+
> [!NOTE]
6+
> * The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group.
7+
> * Ordering is not guaranteed for jobs or workflow runs using concurrency groups. Jobs or workflow runs in the same concurrency group are handled in an arbitrary order.
138
149
### Example: Using concurrency and the default behavior
1510

Diff for: ‎data/reusables/actions/actions-importer-prerequisites.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,5 @@
22
* Docker is [installed](https://docs.docker.com/get-docker/) and running.
33
* [{% data variables.product.prodname_dotcom %} CLI](https://cli.github.com) is installed.
44

5-
{% note %}
6-
7-
**Note**: The {% data variables.product.prodname_actions_importer %} container and CLI do not need to be installed on the same server as your CI platform.
8-
9-
{% endnote %}
5+
> [!NOTE]
6+
> The {% data variables.product.prodname_actions_importer %} container and CLI do not need to be installed on the same server as your CI platform.

Diff for: ‎data/reusables/actions/actions-redirects-workflows.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** To enhance security, {% data variables.product.prodname_actions %} does not support redirects for actions or reusable workflows. This means that when the owner, name of an action's repository, or name of an action is changed, any workflows using that action with the previous name will fail.
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> To enhance security, {% data variables.product.prodname_actions %} does not support redirects for actions or reusable workflows. This means that when the owner, name of an action's repository, or name of an action is changed, any workflows using that action with the previous name will fail.

Diff for: ‎data/reusables/actions/actions-runner-controller-unsupported-customization.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
{% warning %}
2-
3-
**Warning:** This {% data variables.product.prodname_actions_runner_controller %} customization option may be outside the scope of what {% data variables.contact.github_support %} can assist with and may cause unexpected behavior when configured incorrectly.
4-
5-
For more information about what {% data variables.contact.github_support %} can assist with, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller).
6-
7-
{% endwarning %}
1+
> [!WARNING]
2+
> This {% data variables.product.prodname_actions_runner_controller %} customization option may be outside the scope of what {% data variables.contact.github_support %} can assist with and may cause unexpected behavior when configured incorrectly.
3+
>
4+
> For more information about what {% data variables.contact.github_support %} can assist with, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller).

Diff for: ‎data/reusables/actions/actions-secrets-variables-repository-access.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11

22
{% ifversion fpt %}
3-
{% note %}
43

5-
**Note:** Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)".
4+
> [!NOTE]
5+
> Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)".
66
7-
{% endnote %}
87
{% endif %}
98

109
When creating a secret or variable in an organization, you can use a policy to limit access by repository. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories.

Diff for: ‎data/reusables/actions/actions-tab-new-runners-note.md

+5-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
1-
{% note %}
2-
3-
**Note:** Enterprise and organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %} can create runners from this page. To create a new runner, click **New runner** at the top right of the list of runners to add runners to the repository.
4-
5-
For more information, see {% ifversion actions-hosted-runners %}"[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners)" and {% endif %}"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."
6-
1+
> [!NOTE]
2+
> Enterprise and organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %} can create runners from this page. To create a new runner, click **New runner** at the top right of the list of runners to add runners to the repository.
3+
>
4+
> For more information, see {% ifversion actions-hosted-runners %}"[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners)" and {% endif %}"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."
75
{% ifversion custom-org-roles %}
8-
9-
For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
10-
6+
>For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
117
{% endif %}
12-
13-
{% endnote %}

Diff for: ‎data/reusables/actions/allow-specific-actions-intro.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,10 @@ When you choose {% data reusables.actions.policy-label-for-select-actions-workfl
2121
You can use the `*` wildcard character to match patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)."
2222

2323
{% ifversion fpt or ghec %}
24-
{% note %}
2524

26-
**Note:** For {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, or {% data variables.product.prodname_team %} plans, the **Allow specified actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}** option is only available in public repositories.
25+
> [!NOTE]
26+
> For {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, or {% data variables.product.prodname_team %} plans, the **Allow specified actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}** option is only available in public repositories.
2727
28-
{% endnote %}
2928
{% endif %}
3029

3130
This procedure demonstrates how to add specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to the allow list.

Diff for: ‎data/reusables/actions/arc-runners-namespace.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#configuring-a-runner-scale-set)."
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#configuring-a-runner-scale-set)."

Diff for: ‎data/reusables/actions/azure-vnet-configure-azure-resources-script.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,11 @@ Use the following script to set up a subnet for Azure private networking. The sc
44

55
To use the script, fill in the placeholder environment variable values with the actual values and run the script from a bash shell or Windows Subsystem for Linux.
66

7-
{% note %}
8-
9-
**Notes**:
10-
11-
* Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file.
12-
* When setting the `YOUR_AZURE_LOCATION` environment variable, use your region’s name. This value is different than your region’s display name. To see a list of names and display names, use `az account list-locations -o table`.
13-
* When you create the network settings resource, a service association link is applied to the subnet that you provide. This link prevents accidental deletion of the subnet while in use by the {% data variables.product.prodname_actions %} service.
14-
* If you customize this script to use network resources in existing subnets, you must ensure any existing network interfaces (NICs) connected to the subnet are deleted before the subnet is delegated to the {% data variables.product.prodname_actions %} service. Otherwise, the service will fail to apply the service association link to the subnet.
15-
16-
{% endnote %}
7+
> [!NOTE]
8+
> * Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file.
9+
> * When setting the `YOUR_AZURE_LOCATION` environment variable, use your region’s name. This value is different than your region’s display name. To see a list of names and display names, use `az account list-locations -o table`.
10+
> * When you create the network settings resource, a service association link is applied to the subnet that you provide. This link prevents accidental deletion of the subnet while in use by the {% data variables.product.prodname_actions %} service.
11+
> * If you customize this script to use network resources in existing subnets, you must ensure any existing network interfaces (NICs) connected to the subnet are deleted before the subnet is delegated to the {% data variables.product.prodname_actions %} service. Otherwise, the service will fail to apply the service association link to the subnet.
1712
1813
```bash copy
1914
#!/bin/bash

Diff for: ‎data/reusables/actions/azure-vnet-procedures-prereqs.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ You will use a script to automate configuring your Azure resources.
1414

1515
If you use {% data variables.enterprise.data_residency %}, in the `AllowOutBoundGitHub` section, you must also include the egress IP ranges for {% data variables.enterprise.data_residency_site %}. See "[AUTOTITLE](/admin/data-residency/network-details-for-ghecom#ranges-for-egress-traffic)."
1616

17-
{% note %}
18-
19-
**Note:** As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud)." To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses.
20-
21-
{% endnote %}
17+
> [!NOTE]
18+
> As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud)." To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses.
2219
2320
```bicep copy
2421
@description('NSG for outbound rules')

Diff for: ‎data/reusables/actions/branch-and-tag-deployment-rules-configuration.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** Name patterns must be configured for branches or tags individually.
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> Name patterns must be configured for branches or tags individually.

Diff for: ‎data/reusables/actions/branch-requirement.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** This event will only trigger a workflow run if the workflow file is on the default branch.
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> This event will only trigger a workflow run if the workflow file is on the default branch.

Diff for: ‎data/reusables/actions/configuration-variables-beta-note.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** Configuration variables for {% data variables.product.prodname_actions %} are in {% data variables.release-phases.public_preview %} and subject to change.
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> Configuration variables for {% data variables.product.prodname_actions %} are in {% data variables.release-phases.public_preview %} and subject to change.

Diff for: ‎data/reusables/actions/context-example-note.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** This context is an example only. The contents of a context depends on the workflow that you are running. {% data reusables.actions.context-contents %}
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> This context is an example only. The contents of a context depends on the workflow that you are running. {% data reusables.actions.context-contents %}

Diff for: ‎data/reusables/actions/context-injection-warning.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% warning %}
2-
3-
**Warning:** When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections)."
4-
5-
{% endwarning %}
1+
> [!WARNING]
2+
> When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections)."

Diff for: ‎data/reusables/actions/creating-a-runner-group-for-an-organization.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,8 @@ Always include a security admonition above this procedure. This is either one of
77

88
{% endcomment %}
99

10-
{% note %}
11-
12-
**Note:** When creating a runner group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners)."
13-
14-
{% endnote %}
10+
> [!NOTE]
11+
> When creating a runner group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners)."
1512
1613
All organizations have a single default runner group. {% ifversion fpt %}Organization owners using the {% data variables.product.prodname_team %} plan{% else %}Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %}{% endif %} can create additional organization-level runner groups. {% ifversion custom-org-roles %}For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."{% endif %}
1714

Diff for: ‎data/reusables/actions/custom-deployment-protection-rules-beta-note.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** Custom deployment protection rules are currently in {% data variables.release-phases.public_preview %} and subject to change.
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> Custom deployment protection rules are currently in {% data variables.release-phases.public_preview %} and subject to change.

Diff for: ‎data/reusables/actions/custom-deployment-protection-rules-limits.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
1-
{% note %}
2-
3-
**Note:** Any number of {% data variables.product.prodname_github_apps %}-based deployment protection rules can be installed on a repository. However, a maximum of 6 deployment protection rules can be enabled on any environment at the same time.
4-
5-
{% endnote %}
1+
> [!NOTE]
2+
> Any number of {% data variables.product.prodname_github_apps %}-based deployment protection rules can be installed on a repository. However, a maximum of 6 deployment protection rules can be enabled on any environment at the same time.

Diff for: ‎data/reusables/actions/docker-container-os-support.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
{% note %}
2-
3-
**Note:** If your workflows use Docker container actions, job containers, or service containers, then you must use a Linux runner:
4-
5-
* If you are using {% data variables.product.prodname_dotcom %}-hosted runners, you must use an Ubuntu runner.
6-
* If you are using self-hosted runners, you must use a Linux machine as your runner and Docker must be installed.
7-
8-
{% endnote %}
1+
> [!NOTE]
2+
> If your workflows use Docker container actions, job containers, or service containers, then you must use a Linux runner:
3+
>
4+
> * If you are using {% data variables.product.prodname_dotcom %}-hosted runners, you must use an Ubuntu runner.
5+
> * If you are using self-hosted runners, you must use a Linux machine as your runner and Docker must be installed.

Diff for: ‎data/reusables/actions/enterprise-common-prereqs.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
* Review the hardware requirements for {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)."
22
* TLS must be configured for {% data variables.product.prodname_ghe_server %}'s domain. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)."
33

4-
{% note %}
4+
> [!NOTE]
5+
> {% data reusables.actions.enterprise-self-signed-cert %}
56
6-
**Note:** {% data reusables.actions.enterprise-self-signed-cert %}
7-
8-
{% endnote %}
97
* {% data reusables.actions.enterprise-http-proxy %}

0 commit comments

Comments
 (0)