diff --git a/contributing/debugging-the-docs-application.md b/contributing/debugging-the-docs-application.md index 5448881aa448..e01d613a64aa 100644 --- a/contributing/debugging-the-docs-application.md +++ b/contributing/debugging-the-docs-application.md @@ -2,7 +2,7 @@ This repo has configuration for debugging the codebase with VS Code's built-in Node Debugger. -**Note**: These steps will only help with debugging issues in the Node.js codebase, not in the content files. +**Note:** These steps will only help with debugging issues in the Node.js codebase, not in the content files. 1. After running the build steps, start the app by running `npm run debug`. 1. In VS Code, click on the Debugging icon in the Activity Bar to bring up the Debug view. diff --git a/data/reusables/actions/actions-group-concurrency.md b/data/reusables/actions/actions-group-concurrency.md index c8fe0461b481..55ec220e27e0 100644 --- a/data/reusables/actions/actions-group-concurrency.md +++ b/data/reusables/actions/actions-group-concurrency.md @@ -2,14 +2,9 @@ This means that there can be at most one running and one pending job in a concur 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. -{% note %} - -**Notes:** - -* The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group. -* 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. - -{% endnote %} +> [!NOTE] +> * The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group. +> * 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. ### Example: Using concurrency and the default behavior diff --git a/data/reusables/actions/actions-importer-prerequisites.md b/data/reusables/actions/actions-importer-prerequisites.md index debc1aead04c..6ae9365c3fcb 100644 --- a/data/reusables/actions/actions-importer-prerequisites.md +++ b/data/reusables/actions/actions-importer-prerequisites.md @@ -2,8 +2,5 @@ * Docker is [installed](https://docs.docker.com/get-docker/) and running. * [{% data variables.product.prodname_dotcom %} CLI](https://cli.github.com) is installed. - {% note %} - - **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. - - {% endnote %} + > [!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. diff --git a/data/reusables/actions/actions-redirects-workflows.md b/data/reusables/actions/actions-redirects-workflows.md index 27e731a93dc6..7b7d37472d39 100644 --- a/data/reusables/actions/actions-redirects-workflows.md +++ b/data/reusables/actions/actions-redirects-workflows.md @@ -1,5 +1,2 @@ -{% note %} - -**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. - -{% endnote %} +> [!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. diff --git a/data/reusables/actions/actions-runner-controller-unsupported-customization.md b/data/reusables/actions/actions-runner-controller-unsupported-customization.md index 99cf1c75d1c9..c8dc2c6da78e 100644 --- a/data/reusables/actions/actions-runner-controller-unsupported-customization.md +++ b/data/reusables/actions/actions-runner-controller-unsupported-customization.md @@ -1,7 +1,4 @@ -{% warning %} - -**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. - -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). - -{% endwarning %} +> [!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. +> +> 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 --git a/data/reusables/actions/actions-secrets-variables-repository-access.md b/data/reusables/actions/actions-secrets-variables-repository-access.md index 82f19268b1a5..e62085078305 100644 --- a/data/reusables/actions/actions-secrets-variables-repository-access.md +++ b/data/reusables/actions/actions-secrets-variables-repository-access.md @@ -1,10 +1,9 @@ {% ifversion fpt %} -{% note %} -**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)". +> [!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)". -{% endnote %} {% endif %} 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 --git a/data/reusables/actions/actions-tab-new-runners-note.md b/data/reusables/actions/actions-tab-new-runners-note.md index 2055ddf0eb06..336daa78c6ae 100644 --- a/data/reusables/actions/actions-tab-new-runners-note.md +++ b/data/reusables/actions/actions-tab-new-runners-note.md @@ -1,13 +1,7 @@ -{% note %} - -**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. - -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)." - +> [!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. +> +> 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)." {% 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)." - +>For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." {% endif %} - -{% endnote %} diff --git a/data/reusables/actions/allow-specific-actions-intro.md b/data/reusables/actions/allow-specific-actions-intro.md index d4a2718d41ec..02e179889579 100644 --- a/data/reusables/actions/allow-specific-actions-intro.md +++ b/data/reusables/actions/allow-specific-actions-intro.md @@ -21,11 +21,10 @@ When you choose {% data reusables.actions.policy-label-for-select-actions-workfl 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)." {% ifversion fpt or ghec %} - {% note %} - **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. + > [!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. - {% endnote %} {% endif %} This procedure demonstrates how to add specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to the allow list. diff --git a/data/reusables/actions/arc-runners-namespace.md b/data/reusables/actions/arc-runners-namespace.md index 1986d6d11cc9..320248b16ffe 100644 --- a/data/reusables/actions/arc-runners-namespace.md +++ b/data/reusables/actions/arc-runners-namespace.md @@ -1,5 +1,2 @@ -{% note %} - -**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)." - -{% endnote %} +> [!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)." diff --git a/data/reusables/actions/azure-vnet-configure-azure-resources-script.md b/data/reusables/actions/azure-vnet-configure-azure-resources-script.md index 4e8be8216f7e..2fb6fbd6737e 100644 --- a/data/reusables/actions/azure-vnet-configure-azure-resources-script.md +++ b/data/reusables/actions/azure-vnet-configure-azure-resources-script.md @@ -4,16 +4,11 @@ Use the following script to set up a subnet for Azure private networking. The sc 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. -{% note %} - -**Notes**: - -* Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file. -* 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`. -* 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. -* 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. - -{% endnote %} +> [!NOTE] +> * Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file. +> * 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`. +> * 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. +> * 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. ```bash copy #!/bin/bash diff --git a/data/reusables/actions/azure-vnet-procedures-prereqs.md b/data/reusables/actions/azure-vnet-procedures-prereqs.md index dab8e707744c..72a31810ddbf 100644 --- a/data/reusables/actions/azure-vnet-procedures-prereqs.md +++ b/data/reusables/actions/azure-vnet-procedures-prereqs.md @@ -14,11 +14,8 @@ You will use a script to automate configuring your Azure resources. 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)." - {% note %} - - **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. - - {% endnote %} + > [!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. ```bicep copy @description('NSG for outbound rules') diff --git a/data/reusables/actions/branch-and-tag-deployment-rules-configuration.md b/data/reusables/actions/branch-and-tag-deployment-rules-configuration.md index 195bbd617744..fd838cf27eca 100644 --- a/data/reusables/actions/branch-and-tag-deployment-rules-configuration.md +++ b/data/reusables/actions/branch-and-tag-deployment-rules-configuration.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Name patterns must be configured for branches or tags individually. - -{% endnote %} +> [!NOTE] +> Name patterns must be configured for branches or tags individually. diff --git a/data/reusables/actions/branch-requirement.md b/data/reusables/actions/branch-requirement.md index b8be9a7d5365..1c5755893233 100644 --- a/data/reusables/actions/branch-requirement.md +++ b/data/reusables/actions/branch-requirement.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** This event will only trigger a workflow run if the workflow file is on the default branch. - -{% endnote %} +> [!NOTE] +> This event will only trigger a workflow run if the workflow file is on the default branch. diff --git a/data/reusables/actions/configuration-variables-beta-note.md b/data/reusables/actions/configuration-variables-beta-note.md index 064f7eb7f2e7..9aaebc0d63fe 100644 --- a/data/reusables/actions/configuration-variables-beta-note.md +++ b/data/reusables/actions/configuration-variables-beta-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Configuration variables for {% data variables.product.prodname_actions %} are in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Configuration variables for {% data variables.product.prodname_actions %} are in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/actions/context-example-note.md b/data/reusables/actions/context-example-note.md index a93d9bd5d744..d56f4c9ea325 100644 --- a/data/reusables/actions/context-example-note.md +++ b/data/reusables/actions/context-example-note.md @@ -1,5 +1,2 @@ -{% note %} - -**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 %} - -{% endnote %} +> [!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 %} diff --git a/data/reusables/actions/context-injection-warning.md b/data/reusables/actions/context-injection-warning.md index f3bc28090f12..74c4d3dce0ee 100644 --- a/data/reusables/actions/context-injection-warning.md +++ b/data/reusables/actions/context-injection-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**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)." - -{% endwarning %} +> [!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)." diff --git a/data/reusables/actions/creating-a-runner-group-for-an-organization.md b/data/reusables/actions/creating-a-runner-group-for-an-organization.md index 368c819b1854..0061add99f36 100644 --- a/data/reusables/actions/creating-a-runner-group-for-an-organization.md +++ b/data/reusables/actions/creating-a-runner-group-for-an-organization.md @@ -7,11 +7,8 @@ Always include a security admonition above this procedure. This is either one of {% endcomment %} -{% note %} - -**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)." - -{% endnote %} +> [!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)." 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 %} diff --git a/data/reusables/actions/custom-deployment-protection-rules-beta-note.md b/data/reusables/actions/custom-deployment-protection-rules-beta-note.md index 98cbaf70677d..4dd136b06e23 100644 --- a/data/reusables/actions/custom-deployment-protection-rules-beta-note.md +++ b/data/reusables/actions/custom-deployment-protection-rules-beta-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Custom deployment protection rules are currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Custom deployment protection rules are currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/actions/custom-deployment-protection-rules-limits.md b/data/reusables/actions/custom-deployment-protection-rules-limits.md index 02751adc5bd7..4072d07889ce 100644 --- a/data/reusables/actions/custom-deployment-protection-rules-limits.md +++ b/data/reusables/actions/custom-deployment-protection-rules-limits.md @@ -1,5 +1,2 @@ -{% note %} - -**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. - -{% endnote %} +> [!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. diff --git a/data/reusables/actions/docker-container-os-support.md b/data/reusables/actions/docker-container-os-support.md index e334bce18c54..f303df27d284 100644 --- a/data/reusables/actions/docker-container-os-support.md +++ b/data/reusables/actions/docker-container-os-support.md @@ -1,8 +1,5 @@ -{% note %} - -**Note:** If your workflows use Docker container actions, job containers, or service containers, then you must use a Linux runner: - -* If you are using {% data variables.product.prodname_dotcom %}-hosted runners, you must use an Ubuntu runner. -* If you are using self-hosted runners, you must use a Linux machine as your runner and Docker must be installed. - -{% endnote %} +> [!NOTE] +> If your workflows use Docker container actions, job containers, or service containers, then you must use a Linux runner: +> +> * If you are using {% data variables.product.prodname_dotcom %}-hosted runners, you must use an Ubuntu runner. +> * If you are using self-hosted runners, you must use a Linux machine as your runner and Docker must be installed. diff --git a/data/reusables/actions/enterprise-common-prereqs.md b/data/reusables/actions/enterprise-common-prereqs.md index aa9f8e9eed24..58f1fdc84ca5 100644 --- a/data/reusables/actions/enterprise-common-prereqs.md +++ b/data/reusables/actions/enterprise-common-prereqs.md @@ -1,9 +1,7 @@ * 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)." * 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)." - {% note %} + > [!NOTE] + > {% data reusables.actions.enterprise-self-signed-cert %} - **Note:** {% data reusables.actions.enterprise-self-signed-cert %} - - {% endnote %} * {% data reusables.actions.enterprise-http-proxy %} diff --git a/data/reusables/actions/enterprise-github-hosted-runners.md b/data/reusables/actions/enterprise-github-hosted-runners.md index cad74db519f8..2fc1bf27ac3b 100644 --- a/data/reusables/actions/enterprise-github-hosted-runners.md +++ b/data/reusables/actions/enterprise-github-hosted-runners.md @@ -1,7 +1,6 @@ {% ifversion ghes %} -{% note %} -**Note:** {% data variables.product.prodname_dotcom %}-hosted runners are not currently supported on {% data variables.product.prodname_ghe_server %}. You can see more information about planned future support on the [{% data variables.product.prodname_roadmap %}](https://github.com/github/roadmap/issues/72). +> [!NOTE] +> {% data variables.product.prodname_dotcom %}-hosted runners are not currently supported on {% data variables.product.prodname_ghe_server %}. You can see more information about planned future support on the [{% data variables.product.prodname_roadmap %}](https://github.com/github/roadmap/issues/72). -{% endnote %} {% endif %} diff --git a/data/reusables/actions/enterprise-marketplace-actions.md b/data/reusables/actions/enterprise-marketplace-actions.md index be73699d20d3..0f11e48f4df2 100644 --- a/data/reusables/actions/enterprise-marketplace-actions.md +++ b/data/reusables/actions/enterprise-marketplace-actions.md @@ -1,9 +1,6 @@ {% ifversion ghes %} -{% note %} - -**Note:** {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/actions/environment-variables-as-case-sensitive.md b/data/reusables/actions/environment-variables-as-case-sensitive.md index bbfc6f223069..a22915a74854 100644 --- a/data/reusables/actions/environment-variables-as-case-sensitive.md +++ b/data/reusables/actions/environment-variables-as-case-sensitive.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: To avoid issues, it's good practice to treat environment variables as case sensitive, irrespective of the behavior of the operating system and shell you are using. - -{% endnote %} +> [!NOTE] +> To avoid issues, it's good practice to treat environment variables as case sensitive, irrespective of the behavior of the operating system and shell you are using. diff --git a/data/reusables/actions/github-context-warning.md b/data/reusables/actions/github-context-warning.md index 85265e5eb82c..836604a21930 100644 --- a/data/reusables/actions/github-context-warning.md +++ b/data/reusables/actions/github-context-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** When using the whole `github` context, be mindful that it includes sensitive information such as `github.token`. {% data variables.product.prodname_dotcom %} masks secrets when they are printed to the console, but you should be cautious when exporting or printing the context. - -{% endwarning %} +> [!WARNING] +> When using the whole `github` context, be mindful that it includes sensitive information such as `github.token`. {% data variables.product.prodname_dotcom %} masks secrets when they are printed to the console, but you should be cautious when exporting or printing the context. diff --git a/data/reusables/actions/hosted-runner-security-admonition.md b/data/reusables/actions/hosted-runner-security-admonition.md index 72ece6b08afa..00f141b04b68 100644 --- a/data/reusables/actions/hosted-runner-security-admonition.md +++ b/data/reusables/actions/hosted-runner-security-admonition.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning**: {% data reusables.actions.hosted-runner-security %} - -{% endwarning %} +> [!WARNING] +> {% data reusables.actions.hosted-runner-security %} diff --git a/data/reusables/actions/inputs-vs-github-event-inputs.md b/data/reusables/actions/inputs-vs-github-event-inputs.md index 8756da238a1e..422e6d670c64 100644 --- a/data/reusables/actions/inputs-vs-github-event-inputs.md +++ b/data/reusables/actions/inputs-vs-github-event-inputs.md @@ -1,12 +1,8 @@ {% ifversion actions-unified-inputs %} -{% note %} +> [!NOTE] +> * The workflow will also receive the inputs in the `github.event.inputs` context. The information in the `inputs` context and `github.event.inputs` context is identical except that the `inputs` context preserves Boolean values as Booleans instead of converting them to strings. The `choice` type resolves to a string and is a single selectable option. +> * The maximum number of top-level properties for `inputs` is 10. +> * The maximum payload for `inputs` is 65,535 characters. -**Notes**: - -* The workflow will also receive the inputs in the `github.event.inputs` context. The information in the `inputs` context and `github.event.inputs` context is identical except that the `inputs` context preserves Boolean values as Booleans instead of converting them to strings. The `choice` type resolves to a string and is a single selectable option. -* The maximum number of top-level properties for `inputs` is 10. -* The maximum payload for `inputs` is 65,535 characters. - -{% endnote %} {% endif %} diff --git a/data/reusables/actions/invalid-workflow-files.md b/data/reusables/actions/invalid-workflow-files.md index f7c8bb3e8f7f..611bf74a69cb 100644 --- a/data/reusables/actions/invalid-workflow-files.md +++ b/data/reusables/actions/invalid-workflow-files.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Ensure that you only commit valid workflow files to your repository. If `.github/workflows` contains an invalid workflow file, {% data variables.product.prodname_actions %} generates a failed workflow run for every new commit. - -{% endnote %} +> [!NOTE] +> Ensure that you only commit valid workflow files to your repository. If `.github/workflows` contains an invalid workflow file, {% data variables.product.prodname_actions %} generates a failed workflow run for every new commit. diff --git a/data/reusables/actions/ip-allow-list-self-hosted-runners.md b/data/reusables/actions/ip-allow-list-self-hosted-runners.md index 4e89b4fd0cfb..66c042b14853 100644 --- a/data/reusables/actions/ip-allow-list-self-hosted-runners.md +++ b/data/reusables/actions/ip-allow-list-self-hosted-runners.md @@ -1,7 +1,4 @@ -{% warning %} - -**Warning**: If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" {% ifversion actions-hosted-runners %} or "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners)"{% endif %}. - -{% endwarning %} +> [!WARNING] +> If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" {% ifversion actions-hosted-runners %} or "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners)"{% endif %}. To allow your self-hosted {% ifversion actions-hosted-runners %}or larger hosted{% endif %} runners to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your runners to the IP allow list that you have configured for your enterprise. diff --git a/data/reusables/actions/jobs/choosing-runner-github-hosted.md b/data/reusables/actions/jobs/choosing-runner-github-hosted.md index d5077c110c7a..143e84c867a9 100644 --- a/data/reusables/actions/jobs/choosing-runner-github-hosted.md +++ b/data/reusables/actions/jobs/choosing-runner-github-hosted.md @@ -12,17 +12,11 @@ For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/abou In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.product.prodname_dotcom %} offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of managed virtual machines with advanced features - for example, more cores and disk space, GPU-powered machines, and ARM-powered machines. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners)." -{% note %} +> [!NOTE] +> The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. -**Note:** The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. - -{% endnote %} - -{% warning %} - -**Warning:** Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. Beta Images may not be covered by customer support. - -{% endwarning %} +> [!WARNING] +> Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. Beta Images may not be covered by customer support. #### Example: Specifying an operating system diff --git a/data/reusables/actions/jobs/choosing-runner-overview.md b/data/reusables/actions/jobs/choosing-runner-overview.md index 7943fc62a175..c4c386ac5cbd 100644 --- a/data/reusables/actions/jobs/choosing-runner-overview.md +++ b/data/reusables/actions/jobs/choosing-runner-overview.md @@ -42,8 +42,5 @@ Use `jobs..runs-on` to define the type of machine to run the job on. * If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy). -{% note %} - -**Note:** Quotation marks are not required around simple strings like `self-hosted`, but they are required for expressions like {% raw %} `"${{ inputs.chosen-os }}"`{% endraw %}. - -{% endnote %} +> [!NOTE] +> Quotation marks are not required around simple strings like `self-hosted`, but they are required for expressions like {% raw %} `"${{ inputs.chosen-os }}"`{% endraw %}. diff --git a/data/reusables/actions/jobs/matrix-exclude.md b/data/reusables/actions/jobs/matrix-exclude.md index 6a3044674c03..a4a4aa1638af 100644 --- a/data/reusables/actions/jobs/matrix-exclude.md +++ b/data/reusables/actions/jobs/matrix-exclude.md @@ -15,8 +15,5 @@ strategy: runs-on: {% raw %}${{ matrix.os }}{% endraw %} ``` -{% note %} - -**Note:** All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded. - -{% endnote %} +> [!NOTE] +> All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded. diff --git a/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md b/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md index 74758a7c0739..6f67d9f38203 100644 --- a/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md +++ b/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md @@ -1,7 +1,4 @@ Use `jobs..container.options` to configure additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)." -{% warning %} - -**Warning:** The `--network` and `--entrypoint` options are not supported. - -{% endwarning %} +> [!WARNING] +> The `--network` and `--entrypoint` options are not supported. diff --git a/data/reusables/actions/jobs/section-running-jobs-in-a-container.md b/data/reusables/actions/jobs/section-running-jobs-in-a-container.md index b2a7db4150f1..c88b784576d4 100644 --- a/data/reusables/actions/jobs/section-running-jobs-in-a-container.md +++ b/data/reusables/actions/jobs/section-running-jobs-in-a-container.md @@ -2,11 +2,8 @@ Use `jobs..container` to create a container to run any steps in a job th If you do not set a `container`, all steps will run directly on the host specified by `runs-on` unless a step refers to an action configured to run in a container. -{% note %} - -**Note:** The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs..steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell). - -{% endnote %} +> [!NOTE] +> The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs..steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell). ### Example: Running a job within a container diff --git a/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md b/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md index 2a55601156db..813c8d772a74 100644 --- a/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md +++ b/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md @@ -1,10 +1,7 @@ You can use the `jobs..if` conditional to prevent a job from running unless a condition is met. {% data reusables.actions.if-supported-contexts %} -{% note %} - -**Note:** The `jobs..if` condition is evaluated before [`jobs..strategy.matrix`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) is applied. - -{% endnote %} +> [!NOTE] +> The `jobs..if` condition is evaluated before [`jobs..strategy.matrix`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) is applied. {% data reusables.actions.expression-syntax-if %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." diff --git a/data/reusables/actions/oidc-custom-claims-aws-restriction.md b/data/reusables/actions/oidc-custom-claims-aws-restriction.md index 509622dbeb2a..cfbd49f9ca19 100644 --- a/data/reusables/actions/oidc-custom-claims-aws-restriction.md +++ b/data/reusables/actions/oidc-custom-claims-aws-restriction.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Support for custom claims for OIDC is unavailable in AWS. - -{% endnote %} +> [!NOTE] +> Support for custom claims for OIDC is unavailable in AWS. diff --git a/data/reusables/actions/oidc-deployment-protection-rules.md b/data/reusables/actions/oidc-deployment-protection-rules.md index 967b5683feb0..98d137b1506c 100644 --- a/data/reusables/actions/oidc-deployment-protection-rules.md +++ b/data/reusables/actions/oidc-deployment-protection-rules.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-protection-rules)." - -{% endnote %} +> [!NOTE] +> When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-protection-rules)." diff --git a/data/reusables/actions/pull-request-target-permissions-warning.md b/data/reusables/actions/pull-request-target-permissions-warning.md index 545a3ec3a786..6fd6aaa8d7a2 100644 --- a/data/reusables/actions/pull-request-target-permissions-warning.md +++ b/data/reusables/actions/pull-request-target-permissions-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website. - -{% endwarning %} +> [!WARNING] +> For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website. diff --git a/data/reusables/actions/run-jobs-larger-runners.md b/data/reusables/actions/run-jobs-larger-runners.md index 924f49c50641..4e3c29fd90b0 100644 --- a/data/reusables/actions/run-jobs-larger-runners.md +++ b/data/reusables/actions/run-jobs-larger-runners.md @@ -1,9 +1,6 @@ Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. You can use runner groups or labels to define where your jobs run. -{% note %} - -**Note:** {% data variables.actions.hosted_runner_caps %}s are automatically assigned a default label that corresponds to the runner name. You cannot add custom labels to {% data variables.actions.hosted_runner %}s, but you can use the default labels or the runner's group to send jobs to specific types of runners. - -{% endnote %} +> [!NOTE] +> {% data variables.actions.hosted_runner_caps %}s are automatically assigned a default label that corresponds to the runner name. You cannot add custom labels to {% data variables.actions.hosted_runner %}s, but you can use the default labels or the runner's group to send jobs to specific types of runners. Only owner or administrator accounts can see the runner settings. Non-administrative users can contact the organization owner to find out which runners are enabled. Your organization owner can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-a-runner-group)." diff --git a/data/reusables/actions/secrets-and-variables-org-permissions.md b/data/reusables/actions/secrets-and-variables-org-permissions.md index 8c0924cd6ff9..f529580cd1a1 100644 --- a/data/reusables/actions/secrets-and-variables-org-permissions.md +++ b/data/reusables/actions/secrets-and-variables-org-permissions.md @@ -1,9 +1,6 @@ {% ifversion custom-org-roles %} -{% note %} - -**Note:** The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - -{% endnote %} +> [!NOTE] +> The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." {% endif %} diff --git a/data/reusables/actions/secrets-redaction-warning.md b/data/reusables/actions/secrets-redaction-warning.md index fa97628d423b..011dc89ac20e 100644 --- a/data/reusables/actions/secrets-redaction-warning.md +++ b/data/reusables/actions/secrets-redaction-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** If a secret was used in the job, {% data variables.product.prodname_dotcom %} automatically redacts secrets printed to the log. You should avoid printing secrets to the log intentionally. - -{% endwarning %} +> [!WARNING] +> If a secret was used in the job, {% data variables.product.prodname_dotcom %} automatically redacts secrets printed to the log. You should avoid printing secrets to the log intentionally. diff --git a/data/reusables/actions/self-hosted-runner-configure.md b/data/reusables/actions/self-hosted-runner-configure.md index 883e271a16d0..4a1fa69b95b7 100644 --- a/data/reusables/actions/self-hosted-runner-configure.md +++ b/data/reusables/actions/self-hosted-runner-configure.md @@ -6,11 +6,8 @@ Open a shell on your self-hosted runner machine and run each shell command in the order shown. - {% note %} - - **Note:** On Windows, if you want to install the self-hosted runner application as a service, you must open a shell with administrator privileges. We also recommend that you use `C:\actions-runner` as the directory for the self-hosted runner application so that Windows system accounts can access the runner directory. - - {% endnote %} + > [!NOTE] + > On Windows, if you want to install the self-hosted runner application as a service, you must open a shell with administrator privileges. We also recommend that you use `C:\actions-runner` as the directory for the self-hosted runner application so that Windows system accounts can access the runner directory. The instructions walk you through completing these tasks: * Downloading and extracting the self-hosted runner application. diff --git a/data/reusables/actions/self-hosted-runner-public-repo-access.md b/data/reusables/actions/self-hosted-runner-public-repo-access.md index a680c1f902de..11ba5f36e9e9 100644 --- a/data/reusables/actions/self-hosted-runner-public-repo-access.md +++ b/data/reusables/actions/self-hosted-runner-public-repo-access.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." - -{% endnote %} +> [!NOTE] +> For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." diff --git a/data/reusables/actions/self-hosted-runner-security-admonition.md b/data/reusables/actions/self-hosted-runner-security-admonition.md index 3f3205d41275..777e46d3e06f 100644 --- a/data/reusables/actions/self-hosted-runner-security-admonition.md +++ b/data/reusables/actions/self-hosted-runner-security-admonition.md @@ -1,7 +1,4 @@ -{% warning %} - -**Warning**: {% data reusables.actions.self-hosted-runner-security %} - -For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." - -{% endwarning %} +> [!WARNING] +> {% data reusables.actions.self-hosted-runner-security %} +> +> For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." diff --git a/data/reusables/actions/third-party-actions.md b/data/reusables/actions/third-party-actions.md index 0abdad711a93..8334791cf626 100644 --- a/data/reusables/actions/third-party-actions.md +++ b/data/reusables/actions/third-party-actions.md @@ -1,8 +1,3 @@ -{% note %} - -**Notes**: - -* This workflow template contains an action that is not certified by {% data variables.product.prodname_dotcom %}. Actions provided by third parties are governed by separate terms of service, privacy policy, and support documentation. -* If you use actions from third parties you should use a version specified by a commit SHA. If the action is revised and you want to use the newer version, you will need to update the SHA. You can specify a version by referencing a tag or a branch, however the action may change without warning. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)." - -{% endnote %} +> [!NOTE] +> * This workflow template contains an action that is not certified by {% data variables.product.prodname_dotcom %}. Actions provided by third parties are governed by separate terms of service, privacy policy, and support documentation. +> * If you use actions from third parties you should use a version specified by a commit SHA. If the action is revised and you want to use the newer version, you will need to update the SHA. You can specify a version by referencing a tag or a branch, however the action may change without warning. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)." diff --git a/data/reusables/actions/workflows/required-workflow-beta.md b/data/reusables/actions/workflows/required-workflow-beta.md index 02a522716d6e..46d1231aeed6 100644 --- a/data/reusables/actions/workflows/required-workflow-beta.md +++ b/data/reusables/actions/workflows/required-workflow-beta.md @@ -1,9 +1,6 @@ -{% note %} - -**Note:** {% data variables.product.company_short %} no longer supports required workflows for {% data variables.product.prodname_actions %}. To require workflows to pass before merging, upgrade {% data variables.product.prodname_ghe_server %} to the latest version and use repository rulesets instead. - -For more information about upgrading {% data variables.product.prodname_ghe_server %}, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)." - -For more information about repository rulesets, see "[AUTOTITLE](/enterprise-server@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)." - -{% endnote %} +> [!NOTE] +> {% data variables.product.company_short %} no longer supports required workflows for {% data variables.product.prodname_actions %}. To require workflows to pass before merging, upgrade {% data variables.product.prodname_ghe_server %} to the latest version and use repository rulesets instead. +> +> For more information about upgrading {% data variables.product.prodname_ghe_server %}, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)." +> +> For more information about repository rulesets, see "[AUTOTITLE](/enterprise-server@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)." diff --git a/data/reusables/actions/workflows/skipped-job-status-checks-passing.md b/data/reusables/actions/workflows/skipped-job-status-checks-passing.md index df1994669009..6b4fe8666625 100644 --- a/data/reusables/actions/workflows/skipped-job-status-checks-passing.md +++ b/data/reusables/actions/workflows/skipped-job-status-checks-passing.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** A job that is skipped will report its status as "Success". It will not prevent a pull request from merging, even if it is a required check. - -{% endnote %} +> [!NOTE] +> A job that is skipped will report its status as "Success". It will not prevent a pull request from merging, even if it is a required check. diff --git a/data/reusables/actions/working-directory-must-exist.md b/data/reusables/actions/working-directory-must-exist.md index 2c7a381ba162..f3dc3f690c16 100644 --- a/data/reusables/actions/working-directory-must-exist.md +++ b/data/reusables/actions/working-directory-must-exist.md @@ -1,5 +1,2 @@ -{% note %} - -**Tip:** Ensure the `working-directory` you assign exists on the runner before you run your shell in it. - -{% endnote %} +> [!TIP] +> Ensure the `working-directory` you assign exists on the runner before you run your shell in it. diff --git a/data/reusables/advanced-security/note-org-enable-uses-seats.md b/data/reusables/advanced-security/note-org-enable-uses-seats.md index a326e24fc0b4..accfe3bc22fe 100644 --- a/data/reusables/advanced-security/note-org-enable-uses-seats.md +++ b/data/reusables/advanced-security/note-org-enable-uses-seats.md @@ -1,6 +1,6 @@ {% ifversion ghes or ghec %} -{% note %} -**Note:** If you enable {% data variables.product.prodname_GH_advanced_security %}, active committers to these repositories will use {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %}. This option is deactivated if you have exceeded your license capacity. {% ifversion fpt or ghec %}See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} -{% endnote %} +> [!NOTE] +> If you enable {% data variables.product.prodname_GH_advanced_security %}, active committers to these repositories will use {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %}. This option is deactivated if you have exceeded your license capacity. {% ifversion fpt or ghec %}See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} + {% endif %} diff --git a/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md b/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md index 1e3077644acc..ece63ac154b1 100644 --- a/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md +++ b/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md @@ -1,11 +1,7 @@ 1. Optionally, to enable push protection for your custom pattern, click **Enable**. - {% note %} - - **Note:** - * Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information about enabling push protection, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." - * Enabling push protection for commonly found custom patterns can be disruptive to contributors. - - {% endnote %} + > [!NOTE] + > * Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information about enabling push protection, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + > * Enabling push protection for commonly found custom patterns can be disruptive to contributors. ![Screenshot of custom pattern page with the button to enable push protection emphasized.](/assets/images/help/repository/secret-scanning-custom-pattern-enable-push-protection.png) diff --git a/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md b/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md index f82f22059244..f75728e1a6f4 100644 --- a/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md +++ b/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md @@ -1,11 +1,8 @@ 1. In the "Pattern name" field, type a name for your pattern. 1. On the top right, click **Generate with AI**. - {% note %} - - **Note:** You can enter a regular expression manually instead of using the generator, by typing a regular expression for the format of your secret pattern in the "Secret format" field. For more information, see "[Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization)." - - {% endnote %} + > [!NOTE] + > You can enter a regular expression manually instead of using the generator, by typing a regular expression for the format of your secret pattern in the "Secret format" field. For more information, see "[Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization)." 1. In the sliding panel that is displayed: * Complete the "I want a regular expression that" field, describing, ideally in plain English, what patterns you want your regular expression to capture. You can use other natural languages, but the performance may not be as good as with English. diff --git a/data/reusables/advanced-security/starter-workflows-beta.md b/data/reusables/advanced-security/starter-workflows-beta.md index f914a5c5c4e4..e61c99c9dfb1 100644 --- a/data/reusables/advanced-security/starter-workflows-beta.md +++ b/data/reusables/advanced-security/starter-workflows-beta.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Workflow templates for {% data variables.product.prodname_advanced_security %} have been consolidated in a "Security" category in the **Actions** tab of a repository. - -{% endnote %} +> [!NOTE] +> Workflow templates for {% data variables.product.prodname_advanced_security %} have been consolidated in a "Security" category in the **Actions** tab of a repository. diff --git a/data/reusables/apps/deletes_ssh_keys.md b/data/reusables/apps/deletes_ssh_keys.md index c873a483d77e..98b5be19e0b8 100644 --- a/data/reusables/apps/deletes_ssh_keys.md +++ b/data/reusables/apps/deletes_ssh_keys.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning**: Revoking all permission from an {% data variables.product.prodname_oauth_app %} deletes any SSH keys the application generated on behalf of the user, including [deploy keys](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys). - -{% endwarning %} +> [!WARNING] +> Revoking all permission from an {% data variables.product.prodname_oauth_app %} deletes any SSH keys the application generated on behalf of the user, including [deploy keys](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys). diff --git a/data/reusables/apps/generate-installation-access-token.md b/data/reusables/apps/generate-installation-access-token.md index 5619aa9cdb58..ead0d79c09f8 100644 --- a/data/reusables/apps/generate-installation-access-token.md +++ b/data/reusables/apps/generate-installation-access-token.md @@ -29,8 +29,5 @@ For more information about this endpoint, see "[AUTOTITLE](/rest/apps/apps)". - {% note %} - - **Note:** {% data reusables.getting-started.bearer-vs-token %} - - {% endnote %} + > [!NOTE] + > {% data reusables.getting-started.bearer-vs-token %} diff --git a/data/reusables/apps/ip-allow-list-only-apps.md b/data/reusables/apps/ip-allow-list-only-apps.md index 9636f4015e08..499e2c7119db 100644 --- a/data/reusables/apps/ip-allow-list-only-apps.md +++ b/data/reusables/apps/ip-allow-list-only-apps.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** The addresses in the IP allow list of a {% data variables.product.prodname_github_app %} only affect requests made by installations of the {% data variables.product.prodname_github_app %}. The automatic addition of a {% data variables.product.prodname_github_app %}'s IP address to an organization's allow list does not allow access to a {% data variables.product.product_name %} user who connects from that IP address. - -{% endnote %} +> [!NOTE] +> The addresses in the IP allow list of a {% data variables.product.prodname_github_app %} only affect requests made by installations of the {% data variables.product.prodname_github_app %}. The automatic addition of a {% data variables.product.prodname_github_app %}'s IP address to an organization's allow list does not allow access to a {% data variables.product.product_name %} user who connects from that IP address. diff --git a/data/reusables/audit_log/authentication-metadata-git-events-release-phase.md b/data/reusables/audit_log/authentication-metadata-git-events-release-phase.md index 0608619c383b..08cb0b509cc3 100644 --- a/data/reusables/audit_log/authentication-metadata-git-events-release-phase.md +++ b/data/reusables/audit_log/authentication-metadata-git-events-release-phase.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: Display of token data for Git events in the audit log is in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Display of token data for Git events in the audit log is in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/audit_log/authentication-methods-with-metadata.md b/data/reusables/audit_log/authentication-methods-with-metadata.md index 319bf31941b0..9a100260ad7d 100644 --- a/data/reusables/audit_log/authentication-methods-with-metadata.md +++ b/data/reusables/audit_log/authentication-methods-with-metadata.md @@ -7,9 +7,7 @@ Token data appears in the audit log for the following authentication methods. * Deploy key * SSH key -{% note %} +> [!NOTE] +> Display of token data for SSH keys and deploy keys in the audit log is in {% data variables.release-phases.public_preview %} and subject to change. -**Note**: Display of token data for SSH keys and deploy keys in the audit log is in {% data variables.release-phases.public_preview %} and subject to change. - -{%- endnote %} {% endif %} diff --git a/data/reusables/audit_log/git-events-export-limited.md b/data/reusables/audit_log/git-events-export-limited.md index 16f4b1894032..38196e283281 100644 --- a/data/reusables/audit_log/git-events-export-limited.md +++ b/data/reusables/audit_log/git-events-export-limited.md @@ -1,7 +1,6 @@ {% ifversion ghec %} -{% note %} -**Note:** When you export Git events, events that were initiated via the web browser or the REST or GraphQL APIs are not included. For example, when a user merges a pull request in the web browser, changes are pushed to the base branch, but the Git event for that push is not included in the export. +> [!NOTE] +> When you export Git events, events that were initiated via the web browser or the REST or GraphQL APIs are not included. For example, when a user merges a pull request in the web browser, changes are pushed to the base branch, but the Git event for that push is not included in the export. -{% endnote %} {% endif %} diff --git a/data/reusables/audit_log/git-events-not-in-search-results.md b/data/reusables/audit_log/git-events-not-in-search-results.md index 144766296448..e506da1111bb 100644 --- a/data/reusables/audit_log/git-events-not-in-search-results.md +++ b/data/reusables/audit_log/git-events-not-in-search-results.md @@ -1,7 +1,6 @@ {% ifversion git-events-audit-log %} -{% note %} -**Note:** Git events are not included in search results. +> [!NOTE] +> Git events are not included in search results. -{% endnote %} {% endif %} diff --git a/data/reusables/audit_log/searching-for-a-token-on-githubcom.md b/data/reusables/audit_log/searching-for-a-token-on-githubcom.md index 97d267f86439..6eeb2f0a31aa 100644 --- a/data/reusables/audit_log/searching-for-a-token-on-githubcom.md +++ b/data/reusables/audit_log/searching-for-a-token-on-githubcom.md @@ -1,10 +1,7 @@ While searching the audit log on {% data variables.product.prodname_dotcom %}, include `hashed_token:"VALUE"` in your search query, replacing `VALUE` with the SHA-256 hash of the token. -{% note %} - -**Note:** Make sure to wrap the hashed token value in quotation marks. - -{% endnote %} +> [!NOTE] +> Make sure to wrap the hashed token value in quotation marks. {% ifversion token-audit-log-more-metadata %} diff --git a/data/reusables/classroom/free-limited-codespaces-for-verified-teachers-beta-note.md b/data/reusables/classroom/free-limited-codespaces-for-verified-teachers-beta-note.md index 20a92c00c2e8..04bc62cbb173 100644 --- a/data/reusables/classroom/free-limited-codespaces-for-verified-teachers-beta-note.md +++ b/data/reusables/classroom/free-limited-codespaces-for-verified-teachers-beta-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: The {% data variables.product.prodname_codespaces %} Education benefit is currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %} release, your organization will not be charged if you exceed the free allowance. - -{% endnote %} +> [!NOTE] +> The {% data variables.product.prodname_codespaces %} Education benefit is currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %} release, your organization will not be charged if you exceed the free allowance. diff --git a/data/reusables/classroom/invitation-url-warning.md b/data/reusables/classroom/invitation-url-warning.md index bb315450bac8..0e667651eff2 100644 --- a/data/reusables/classroom/invitation-url-warning.md +++ b/data/reusables/classroom/invitation-url-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning**: Be careful where you share invitation URLs. Anyone with an invitation URL for an assignment can accept the invitation and associate a personal account on {% data variables.product.product_name %} with an identifier in your roster. - -{% endwarning %} +> [!WARNING] +> Be careful where you share invitation URLs. Anyone with an invitation URL for an assignment can accept the invitation and associate a personal account on {% data variables.product.product_name %} with an identifier in your roster. diff --git a/data/reusables/classroom/supported-lmses.md b/data/reusables/classroom/supported-lmses.md index 51edba64dc41..b47bd761052e 100644 --- a/data/reusables/classroom/supported-lmses.md +++ b/data/reusables/classroom/supported-lmses.md @@ -12,10 +12,7 @@ Using LTI helps keep your information safe and secure. LTI is an industry-standa * Sakai * Google Classroom -{% note %} - -**Note:** Other LMSes that implement LTI 1.3 may also work with {% data variables.product.prodname_classroom %}, but have not yet been verified. LMS admins may need to configure custom settings around privacy and button placement and may need to provide teachers with documentation on how to launch into {% data variables.product.prodname_classroom %} from the LMS. - -{% endnote %} +> [!NOTE] +> Other LMSes that implement LTI 1.3 may also work with {% data variables.product.prodname_classroom %}, but have not yet been verified. LMS admins may need to configure custom settings around privacy and button placement and may need to provide teachers with documentation on how to launch into {% data variables.product.prodname_classroom %} from the LMS. {% data reusables.classroom.google-classroom-note %} diff --git a/data/reusables/classroom/you-can-choose-a-template-repository.md b/data/reusables/classroom/you-can-choose-a-template-repository.md index f9593422d09b..9d0a80a9f07f 100644 --- a/data/reusables/classroom/you-can-choose-a-template-repository.md +++ b/data/reusables/classroom/you-can-choose-a-template-repository.md @@ -1,7 +1,4 @@ You can optionally choose a template repository as starter code for the assignment. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository)." -{% note %} - -**Note:** The template repository must belong to your organization or be a public repository on {% data variables.product.product_name %}. - -{% endnote %} +> [!NOTE] +> The template repository must belong to your organization or be a public repository on {% data variables.product.product_name %}. diff --git a/data/reusables/cli/filter-issues-and-pull-requests-tip.md b/data/reusables/cli/filter-issues-and-pull-requests-tip.md index cb30d4cea9d4..28f1eb8993cb 100644 --- a/data/reusables/cli/filter-issues-and-pull-requests-tip.md +++ b/data/reusables/cli/filter-issues-and-pull-requests-tip.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip**: You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation. - -{% endtip %} +> [!TIP] +> You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation. diff --git a/data/reusables/code-scanning/beta-alert-tracking-in-issues.md b/data/reusables/code-scanning/beta-alert-tracking-in-issues.md index 8ee6ba293dab..d87e3a511a5c 100644 --- a/data/reusables/code-scanning/beta-alert-tracking-in-issues.md +++ b/data/reusables/code-scanning/beta-alert-tracking-in-issues.md @@ -1,10 +1,8 @@ {% ifversion code-scanning-task-lists %} -{% note %} +> [!NOTE] +> The tracking of {% data variables.product.prodname_code_scanning %} alerts in issues is in {% data variables.release-phases.public_preview %} and subject to change. +> +> This feature supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure, as well as third-party {% data variables.product.prodname_code_scanning %} tools, but _not_ third-party tracking tools. -**Note:** The tracking of {% data variables.product.prodname_code_scanning %} alerts in issues is in {% data variables.release-phases.public_preview %} and subject to change. - -This feature supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure, as well as third-party {% data variables.product.prodname_code_scanning %} tools, but _not_ third-party tracking tools. - -{% endnote %} {% endif %} diff --git a/data/reusables/code-scanning/beta-larger-runners-support.md b/data/reusables/code-scanning/beta-larger-runners-support.md index c104b3da3655..717dab70f1da 100644 --- a/data/reusables/code-scanning/beta-larger-runners-support.md +++ b/data/reusables/code-scanning/beta-larger-runners-support.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Support for {% data variables.actions.hosted_runners %} for {% data variables.product.prodname_code_scanning %} default setup is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Support for {% data variables.actions.hosted_runners %} for {% data variables.product.prodname_code_scanning %} default setup is currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/code-scanning/beta-model-packs.md b/data/reusables/code-scanning/beta-model-packs.md index 77a65d166171..01626cd9ea68 100644 --- a/data/reusables/code-scanning/beta-model-packs.md +++ b/data/reusables/code-scanning/beta-model-packs.md @@ -1,9 +1,6 @@ {% ifversion codeql-model-packs %} -{% note %} - -**Note:** {% data variables.product.prodname_codeql %} model packs and the {% data variables.product.prodname_codeql %} model editor are currently in {% data variables.release-phases.public_preview %} and subject to change. Model packs are supported by {% data variables.code-scanning.codeql_model_packs_support %} analysis. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_codeql %} model packs and the {% data variables.product.prodname_codeql %} model editor are currently in {% data variables.release-phases.public_preview %} and subject to change. Model packs are supported by {% data variables.code-scanning.codeql_model_packs_support %} analysis. {% endif %} diff --git a/data/reusables/code-scanning/beta-org-enable-all.md b/data/reusables/code-scanning/beta-org-enable-all.md index 90c3bf410fe8..cd1c3db681c5 100644 --- a/data/reusables/code-scanning/beta-org-enable-all.md +++ b/data/reusables/code-scanning/beta-org-enable-all.md @@ -1,9 +1,6 @@ {% ifversion ghes = 3.10 %} -{% note %} - -**Note:** The ability to enable and disable default setup for {% data variables.product.prodname_code_scanning %} for eligible repositories in an organization is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The ability to enable and disable default setup for {% data variables.product.prodname_code_scanning %} for eligible repositories in an organization is currently in {% data variables.release-phases.public_preview %} and subject to change. {% endif %} diff --git a/data/reusables/code-scanning/beta-threat-models-cli.md b/data/reusables/code-scanning/beta-threat-models-cli.md index 2c2d54213f26..03e94d7ac51b 100644 --- a/data/reusables/code-scanning/beta-threat-models-cli.md +++ b/data/reusables/code-scanning/beta-threat-models-cli.md @@ -1,9 +1,6 @@ {% ifversion codeql-cli-threat-models %} -{% note %} - -**Note:** Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}. - -{% endnote %} +> [!NOTE] +> Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}. {% endif %} diff --git a/data/reusables/code-scanning/beta-threat-models.md b/data/reusables/code-scanning/beta-threat-models.md index 857e97c50c1b..a883f2185c04 100644 --- a/data/reusables/code-scanning/beta-threat-models.md +++ b/data/reusables/code-scanning/beta-threat-models.md @@ -1,9 +1,6 @@ {% ifversion codeql-threat-models %} -{% note %} - -**Note:** Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}. - -{% endnote %} +> [!NOTE] +> Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}. {% endif %} diff --git a/data/reusables/code-scanning/codeql-action-version-ghes.md b/data/reusables/code-scanning/codeql-action-version-ghes.md index 5f374167490e..674dc71199a2 100644 --- a/data/reusables/code-scanning/codeql-action-version-ghes.md +++ b/data/reusables/code-scanning/codeql-action-version-ghes.md @@ -1,10 +1,7 @@ {% ifversion ghes %} -{% note %} - -**Note:** This article describes the features available with the version of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql_cli %} bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the {% data variables.product.prodname_codeql %} action, see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features. +> [!NOTE] +> This article describes the features available with the version of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql_cli %} bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the {% data variables.product.prodname_codeql %} action, see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features. For information on using the latest version, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)." -{% endnote %} - {% endif %} diff --git a/data/reusables/code-scanning/codeql-cli-version-ghes.md b/data/reusables/code-scanning/codeql-cli-version-ghes.md index 2e00034e256c..9e25fe29e202 100644 --- a/data/reusables/code-scanning/codeql-cli-version-ghes.md +++ b/data/reusables/code-scanning/codeql-cli-version-ghes.md @@ -1,9 +1,8 @@ {% ifversion ghes %} -{% note %} -**Note:** This article describes the features available with the {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %} bundle included in the initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}. +> [!NOTE] +> This article describes the features available with the {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %} bundle included in the initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}. +> +> If your site administrator has updated your {% data variables.product.prodname_codeql_cli %} version to a newer release, please see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features. -If your site administrator has updated your {% data variables.product.prodname_codeql_cli %} version to a newer release, please see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features. - -{% endnote %} {% endif %} diff --git a/data/reusables/code-scanning/codeql-language-identifiers-table.md b/data/reusables/code-scanning/codeql-language-identifiers-table.md index e9d7951b1b38..2524f9acd6a9 100644 --- a/data/reusables/code-scanning/codeql-language-identifiers-table.md +++ b/data/reusables/code-scanning/codeql-language-identifiers-table.md @@ -11,11 +11,8 @@ | Ruby | `ruby` | Swift | `swift` -{% note %} - -**Note:** If you specify one of the alternative identifiers, this is equivalent to using the standard language identifier. For example, specifying `javascript` instead of `javascript-typescript` will not exclude analysis of TypeScript code. You can do this in an advanced setup workflow with the `--paths-ignore` option. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan)." - -{% endnote %} +> [!NOTE] +> If you specify one of the alternative identifiers, this is equivalent to using the standard language identifier. For example, specifying `javascript` instead of `javascript-typescript` will not exclude analysis of TypeScript code. You can do this in an advanced setup workflow with the `--paths-ignore` option. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan)." {% else %} diff --git a/data/reusables/code-scanning/codeql-languages-bullets.md b/data/reusables/code-scanning/codeql-languages-bullets.md index a18f355da740..1fa7df71f47f 100644 --- a/data/reusables/code-scanning/codeql-languages-bullets.md +++ b/data/reusables/code-scanning/codeql-languages-bullets.md @@ -8,13 +8,8 @@ * Ruby * Swift -{% note %} - -**Notes**: - -* Use {% ifversion codeql-language-identifiers-311 %}`java-kotlin`{% else %}`java`{% endif %} to analyze code written in Java, Kotlin or both. -* Use {% ifversion codeql-language-identifiers-311 %}`javascript-typescript`{% else %}`javascript`{% endif %} to analyze code written in JavaScript, TypeScript or both. - -{% endnote %} +> [!NOTE] +> * Use {% ifversion codeql-language-identifiers-311 %}`java-kotlin`{% else %}`java`{% endif %} to analyze code written in Java, Kotlin or both. +> * Use {% ifversion codeql-language-identifiers-311 %}`javascript-typescript`{% else %}`javascript`{% endif %} to analyze code written in JavaScript, TypeScript or both. For more information, see the documentation on the {% data variables.product.prodname_codeql %} website: "[Supported languages and frameworks](https://codeql.github.com/docs/codeql-overview/supported-languages-and-frameworks/)." diff --git a/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md b/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md index c5c076238889..67f62ea16908 100644 --- a/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md +++ b/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md @@ -2,10 +2,7 @@ This table lists the queries available with the latest release of the {% data va {% ifversion ghes %} -{% note %} - -**Note:** The initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }} included {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %}, which may not include all of these queries. Your site administrator can update your {% data variables.product.prodname_codeql %} version to a newer release. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." - -{% endnote %} +> [!NOTE] +> The initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }} included {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %}, which may not include all of these queries. Your site administrator can update your {% data variables.product.prodname_codeql %} version to a newer release. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." {% endif %} diff --git a/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md b/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md index e98342733062..95bb42ca256d 100644 --- a/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md +++ b/data/reusables/code-scanning/enterprise-enable-code-scanning-actions.md @@ -1,9 +1,6 @@ {% ifversion ghes %} -{% note %} - -**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." - -{% endnote %} +> [!NOTE] +> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." {% endif %} diff --git a/data/reusables/code-scanning/enterprise-enable-code-scanning.md b/data/reusables/code-scanning/enterprise-enable-code-scanning.md index f252a452a5af..9276f1ba0f47 100644 --- a/data/reusables/code-scanning/enterprise-enable-code-scanning.md +++ b/data/reusables/code-scanning/enterprise-enable-code-scanning.md @@ -1,11 +1,8 @@ {% ifversion ghes %} -{% note %} - -**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." - -You may not be able to enable or disable {% data variables.product.prodname_code_scanning %} if an enterprise owner has set a {% data variables.product.prodname_GH_advanced_security %} (GHAS) policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." - -{% endnote %} +> [!NOTE] +> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." +> +> You may not be able to enable or disable {% data variables.product.prodname_code_scanning %} if an enterprise owner has set a {% data variables.product.prodname_GH_advanced_security %} (GHAS) policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." {% endif %} diff --git a/data/reusables/code-scanning/licensing-note.md b/data/reusables/code-scanning/licensing-note.md index 8dba7844cdf4..504817a15a94 100644 --- a/data/reusables/code-scanning/licensing-note.md +++ b/data/reusables/code-scanning/licensing-note.md @@ -1,12 +1,8 @@ -{% note %} - -**Notes:** {% ifversion fpt %} -* The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +> [!NOTE] {% ifversion fpt %} +> * The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {%- elsif ghec %} -* The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +> * The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {%- elsif ghes %} -* The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. +> * The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% endif %} -* {% data reusables.code-scanning.non-glibc-linux-support %} - -{% endnote %} +> * {% data reusables.code-scanning.non-glibc-linux-support %} diff --git a/data/reusables/code-scanning/max-paths-setting.md b/data/reusables/code-scanning/max-paths-setting.md index d284a49ade43..5f7f2905a2c4 100644 --- a/data/reusables/code-scanning/max-paths-setting.md +++ b/data/reusables/code-scanning/max-paths-setting.md @@ -9,8 +9,5 @@ * {% data variables.product.prodname_codeql_cli %} `database analyze`: update the database analysis command to include the `--max-paths=1` flag. For more information, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-analyze#--max-pathsmaxpaths)." -{% note %} - -**Note:** The `max-paths` setting affects the results of all dataflow queries. - -{% endnote %} +> [!NOTE] +> The `max-paths` setting affects the results of all dataflow queries. diff --git a/data/reusables/code-scanning/upload-sarif-ghas.md b/data/reusables/code-scanning/upload-sarif-ghas.md index c138bdce9f44..a7192d040d66 100644 --- a/data/reusables/code-scanning/upload-sarif-ghas.md +++ b/data/reusables/code-scanning/upload-sarif-ghas.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Uploading SARIF data to display as {% data variables.product.prodname_code_scanning %} results in {% data variables.product.product_name %} is supported for organization-owned repositories with {% data variables.product.prodname_GH_advanced_security %} enabled{% ifversion fpt or ghec %}, and public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." - -{% endnote %} +> [!NOTE] +> Uploading SARIF data to display as {% data variables.product.prodname_code_scanning %} results in {% data variables.product.product_name %} is supported for organization-owned repositories with {% data variables.product.prodname_GH_advanced_security %} enabled{% ifversion fpt or ghec %}, and public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." diff --git a/data/reusables/codeql-cli/advanced-query-execution.md b/data/reusables/codeql-cli/advanced-query-execution.md index 6398bb9496a3..68fe27c84636 100644 --- a/data/reusables/codeql-cli/advanced-query-execution.md +++ b/data/reusables/codeql-cli/advanced-query-execution.md @@ -1,10 +1,7 @@ -{% note %} - -**Note:** Queries run with `database analyze` have strict [metadata requirements](https://codeql.github.com/docs/codeql-cli/using-custom-queries-with-the-codeql-cli/#including-query-metadata). You can also execute queries using the following plumbing-level subcommands: - -* [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-run-queries), which outputs non-interpreted results in an intermediate binary format called [BQRS](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#bqrs-file). -* [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/query-run), which will output BQRS files, or print results tables directly to the command line. Viewing results directly in the command line may be useful for iterative query development using the CLI. - -Queries run with these commands don’t have the same metadata requirements. However, to save human-readable data you have to process each BQRS results file using the [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode) plumbing subcommand. Therefore, for most use cases it’s easiest to use database analyze to directly generate interpreted results. - -{% endnote %} +> [!NOTE] +> Queries run with `database analyze` have strict [metadata requirements](https://codeql.github.com/docs/codeql-cli/using-custom-queries-with-the-codeql-cli/#including-query-metadata). You can also execute queries using the following plumbing-level subcommands: +> +> * [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-run-queries), which outputs non-interpreted results in an intermediate binary format called [BQRS](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#bqrs-file). +> * [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/query-run), which will output BQRS files, or print results tables directly to the command line. Viewing results directly in the command line may be useful for iterative query development using the CLI. +> +> Queries run with these commands don’t have the same metadata requirements. However, to save human-readable data you have to process each BQRS results file using the [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode) plumbing subcommand. Therefore, for most use cases it’s easiest to use database analyze to directly generate interpreted results. diff --git a/data/reusables/codespaces/about-publishing-templates.md b/data/reusables/codespaces/about-publishing-templates.md index c1e7474a4e37..c40a30f662ec 100644 --- a/data/reusables/codespaces/about-publishing-templates.md +++ b/data/reusables/codespaces/about-publishing-templates.md @@ -4,8 +4,5 @@ You can save your files, close and stop your codespace, and come back to your wo However, if you delete an unpublished codespace, or if it's automatically deleted by being left unused for the duration of the retention period, then your work will be deleted too. To persist your work, and to allow others to work on your project, you will need to publish your codespace to a repository on {% data variables.product.prodname_dotcom %}. -{% note %} - -**Note:** If an unpublished codespace is currently billed to an organization, publishing the codespace transfers ownership and billing of the codespace to your personal account. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#how-billing-is-handled-for-github-codespaces-templates)." - -{% endnote %} +> [!NOTE] +> If an unpublished codespace is currently billed to an organization, publishing the codespace transfers ownership and billing of the codespace to your personal account. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#how-billing-is-handled-for-github-codespaces-templates)." diff --git a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md b/data/reusables/codespaces/codespaces-jetbrains-beta-note.md index e5c4f0f24582..9a8e6675cbfb 100644 --- a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md +++ b/data/reusables/codespaces/codespaces-jetbrains-beta-note.md @@ -1,8 +1,3 @@ -{% note %} - -**Notes:** - -* Using {% data variables.product.prodname_github_codespaces %} with JetBrains IDEs is currently in {% data variables.release-phases.public_preview %} and is subject to change. -* To work on a codespace in a JetBrains IDE you must use release 2023.3.\* or 2024.1.\* of the JetBrains Gateway. - -{% endnote %} +> [!NOTE] +> * Using {% data variables.product.prodname_github_codespaces %} with JetBrains IDEs is currently in {% data variables.release-phases.public_preview %} and is subject to change. +> * To work on a codespace in a JetBrains IDE you must use release 2023.3.\* or 2024.1.\* of the JetBrains Gateway. diff --git a/data/reusables/codespaces/codespaces-org-policies-note.md b/data/reusables/codespaces/codespaces-org-policies-note.md index 525c9e15faf2..5a64d23ec5b0 100644 --- a/data/reusables/codespaces/codespaces-org-policies-note.md +++ b/data/reusables/codespaces/codespaces-org-policies-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: Codespaces policies only apply to codespaces that your organizations pays for. If someone creates a codespace for a repository in your organization at their own expense, then the codespace will not be bound by these policies. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)." - -{% endnote %} +> [!NOTE] +> Codespaces policies only apply to codespaces that your organizations pays for. If someone creates a codespace for a repository in your organization at their own expense, then the codespace will not be bound by these policies. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)." diff --git a/data/reusables/codespaces/codespaces-policy-targets.md b/data/reusables/codespaces/codespaces-policy-targets.md index 2ef2829ff98a..2b5d213b606a 100644 --- a/data/reusables/codespaces/codespaces-policy-targets.md +++ b/data/reusables/codespaces/codespaces-policy-targets.md @@ -2,11 +2,8 @@ ![Screenshot of the repository selection dropdown, showing the options "All repositories" and "Selected repositories."](/assets/images/help/codespaces/selected-repositories.png) - {% note %} - - **Note**: If you're adding a constraint to an existing policy that already contains the "Maximum codespaces per user" constraint, you won't be able to apply the policy to selected repositories. This is because the "Maximum codespaces per user" constraint always applies to all repositories in the organization. - - {% endnote %} + > [!NOTE] + > If you're adding a constraint to an existing policy that already contains the "Maximum codespaces per user" constraint, you won't be able to apply the policy to selected repositories. This is because the "Maximum codespaces per user" constraint always applies to all repositories in the organization. With **Selected repositories** selected: 1. Click {% octicon "gear" aria-label="The settings icon" %}. diff --git a/data/reusables/codespaces/creating-a-codespace-in-vscode.md b/data/reusables/codespaces/creating-a-codespace-in-vscode.md index aaa7b4fd8e4f..1039d37cffc2 100644 --- a/data/reusables/codespaces/creating-a-codespace-in-vscode.md +++ b/data/reusables/codespaces/creating-a-codespace-in-vscode.md @@ -17,8 +17,5 @@ After you connect your account on {% data variables.product.github %} to the {% 1. If prompted to choose a dev container configuration file, choose a file from the list. 1. Click the machine type you want to use. - {% note %} - - **Note**: {% data reusables.codespaces.codespaces-machine-type-availability %} - - {% endnote %} + > [!NOTE] + > {% data reusables.codespaces.codespaces-machine-type-availability %} diff --git a/data/reusables/codespaces/find-address-and-token.md b/data/reusables/codespaces/find-address-and-token.md index d3b861f9bf99..198a1e7b7e40 100644 --- a/data/reusables/codespaces/find-address-and-token.md +++ b/data/reusables/codespaces/find-address-and-token.md @@ -16,8 +16,5 @@ 1. Copy the token. - {% note %} - - **Important**: Don't share this access token with anyone. - - {% endnote %} + > [!IMPORTANT] + > Don't share this access token with anyone. diff --git a/data/reusables/codespaces/full-rebuild-tip.md b/data/reusables/codespaces/full-rebuild-tip.md index 04a95574c99d..d0513894d1c7 100644 --- a/data/reusables/codespaces/full-rebuild-tip.md +++ b/data/reusables/codespaces/full-rebuild-tip.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip:** You may occasionally want to perform a full rebuild to clear your cache and rebuild your container with fresh images. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace#about-rebuilding-a-container)." - -{% endtip %} +> [!TIP] +> You may occasionally want to perform a full rebuild to clear your cache and rebuild your container with fresh images. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace#about-rebuilding-a-container)." diff --git a/data/reusables/codespaces/linking-to-an-existing-codespace.md b/data/reusables/codespaces/linking-to-an-existing-codespace.md index bb594f0c70c5..1029be005808 100644 --- a/data/reusables/codespaces/linking-to-an-existing-codespace.md +++ b/data/reusables/codespaces/linking-to-an-existing-codespace.md @@ -2,11 +2,8 @@ You can create links to your existing codespaces. This is useful if you have a long-lived codespace that you return to frequently. You can save the link in a location of your choice, as an alternative to using the link on https://github.com/codespaces. -{% note %} - -**Note**: You can only open your own codespaces. If someone clicks a link to one of your codespaces they will see a 404 error message. - -{% endnote %} +> [!NOTE] +> You can only open your own codespaces. If someone clicks a link to one of your codespaces they will see a 404 error message. Create a link using one of the following URL patterns. In these URLs `CODESPACE-NAME` represents the unique, permanent name of the codespace, such as `literate-space-parakeet-w5vg5ww5p793g7g9`, not the codespace's display name. You can find the name of a codespace by copying the link to the codespace on your https://github.com/codespaces page and extracting the codespace name from the URL. diff --git a/data/reusables/codespaces/opening-codespace-in-jetbrains.md b/data/reusables/codespaces/opening-codespace-in-jetbrains.md index 1feab749fe85..d6cd82fb44c1 100644 --- a/data/reusables/codespaces/opening-codespace-in-jetbrains.md +++ b/data/reusables/codespaces/opening-codespace-in-jetbrains.md @@ -19,14 +19,9 @@ Alternatively, you can also open the JetBrains Gateway and select an existing co 1. Click **Connect**. - {% note %} - - **Notes**: - - * If you chose Rider as your JetBrains IDE and the repository contains multiple solution files, the "Set Solution Path" dialog is displayed prompting you to choose which solution you want to work in. Choose a solution file from the dropdown menu and click **OK**. - - If the repository doesn't have a solution file, Rider opens in a basic project directory view and will have limited capabilities. For instance, you won't get .NET-specific code navigation. If there is just a single solution file in the repository it will be used automatically, without the prompt being displayed. For more information, see "[Create and open projects and solutions](https://www.jetbrains.com/help/rider/Creating_and_Opening_Projects_and_Solutions.html)" in the JetBrains documentation.

- - * If you are running a firewall, then the first time you connect to a remote resource you may be prompted to allow the JetBrains Gateway to communicate across your network. - - {% endnote %} + > [!NOTE] + > * If you chose Rider as your JetBrains IDE and the repository contains multiple solution files, the "Set Solution Path" dialog is displayed prompting you to choose which solution you want to work in. Choose a solution file from the dropdown menu and click **OK**. + > + > If the repository doesn't have a solution file, Rider opens in a basic project directory view and will have limited capabilities. For instance, you won't get .NET-specific code navigation. If there is just a single solution file in the repository it will be used automatically, without the prompt being displayed. For more information, see "[Create and open projects and solutions](https://www.jetbrains.com/help/rider/Creating_and_Opening_Projects_and_Solutions.html)" in the JetBrains documentation.

+ > + > * If you are running a firewall, then the first time you connect to a remote resource you may be prompted to allow the JetBrains Gateway to communicate across your network. diff --git a/data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md index 8018de2b3405..3e9c8af8acc7 100644 --- a/data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md +++ b/data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md @@ -2,11 +2,8 @@ When an application running inside a codespace prints output to the terminal tha You can edit the dev container configuration for the repository to automatically forward one or more ports. You can also forward a port manually, label forwarded ports, share forwarded ports with members of your organization, share forwarded ports publicly, and add forwarded ports to the codespace configuration. -{% note %} - -**Note**: {% data reusables.codespaces.restrict-port-visibility %} - -{% endnote %} +> [!NOTE] +> {% data reusables.codespaces.restrict-port-visibility %} ## Forwarding a port diff --git a/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md index 6e08b5efc1c1..6bc8540ae1b3 100644 --- a/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md +++ b/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md @@ -1,15 +1,9 @@ ## Sharing a port -{% note %} - -**Note:** You can only make a port private to an organization if your organization uses {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}. - -{% endnote %} +> [!NOTE] +> You can only make a port private to an organization if your organization uses {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}. If you want to share a forwarded port with others, you can either make the port private to your organization or make the port public. After you make a port private to your organization, anyone in the organization with the port's URL can view the running application. After you make a port public, anyone who knows the URL and port number can view the running application without needing to authenticate. -{% note %} - -**Note:** Your choice of port visibility options may be limited by a policy configured for your organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)." - -{% endnote %} +> [!NOTE] +> Your choice of port visibility options may be limited by a policy configured for your organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)." diff --git a/data/reusables/codespaces/prebuilds-permission-authorization.md b/data/reusables/codespaces/prebuilds-permission-authorization.md index 6c4838cacf5e..3d7736cc6c3b 100644 --- a/data/reusables/codespaces/prebuilds-permission-authorization.md +++ b/data/reusables/codespaces/prebuilds-permission-authorization.md @@ -6,8 +6,5 @@ Click **Authorize and continue** to grant these permissions for creation of prebuilds. Alternatively, you can click **Continue without authorizing** but, if you do so, codespaces created from the resulting prebuilds may not work properly. - {% note %} - - **Note**: Users who create codespaces using this prebuild will also be asked to grant these permissions. - - {% endnote %} + > [!NOTE] + > Users who create codespaces using this prebuild will also be asked to grant these permissions. diff --git a/data/reusables/codespaces/publishing-template-codespaces.md b/data/reusables/codespaces/publishing-template-codespaces.md index 1571db3eca46..0bc29f296404 100644 --- a/data/reusables/codespaces/publishing-template-codespaces.md +++ b/data/reusables/codespaces/publishing-template-codespaces.md @@ -5,11 +5,9 @@ If you're working in a codespace, you can publish it from the {% data variables. ![Screenshot of the "Source control" side bar with the staging button (a plus sign), to the right of "Changes," highlighted with a dark orange outline.](/assets/images/help/codespaces/codespaces-commit-stage.png) - {% note %} + > [!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. - **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 %} 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) diff --git a/data/reusables/codespaces/rebuild-note.md b/data/reusables/codespaces/rebuild-note.md index 39b6bc997c58..1a82d1b1dba2 100644 --- a/data/reusables/codespaces/rebuild-note.md +++ b/data/reusables/codespaces/rebuild-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)." - -{% endnote %} +> [!NOTE] +> When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)." diff --git a/data/reusables/codespaces/remote-explorer.md b/data/reusables/codespaces/remote-explorer.md index f5a8d2bf7527..1329f8d06012 100644 --- a/data/reusables/codespaces/remote-explorer.md +++ b/data/reusables/codespaces/remote-explorer.md @@ -1,9 +1,6 @@ -{% note %} - -**Note**: If the Remote Explorer is not displayed in the Activity Bar: - -1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). -1. Type: `details`. -1. Click **Codespaces: Details**. - -{% endnote %} +> [!NOTE] +> If the Remote Explorer is not displayed in the Activity Bar: +> +> 1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +> 1. Type: `details`. +> 1. Click **Codespaces: Details**. diff --git a/data/reusables/codespaces/settings-sync-and-gpg.md b/data/reusables/codespaces/settings-sync-and-gpg.md index f1cb42f50c47..99aa82182d03 100644 --- a/data/reusables/codespaces/settings-sync-and-gpg.md +++ b/data/reusables/codespaces/settings-sync-and-gpg.md @@ -1,7 +1,4 @@ Your list of trusted repositories for {% data variables.product.prodname_github_codespaces %} is shared between the GPG verification and Settings Sync features. Assuming you have both features enabled, if you have added a selected list of trusted repositories for GPG verification, Settings Sync is turned on in codespaces created from these repositories. If you trust a new repository for Settings Sync, GPG verification is enabled for the same repository. Although the features share the same list of trusted repositories, you can enable or disable GPG verification and Settings Sync independently. -{% note %} - -**Note:** If you have previously enabled GPG verification for all repositories, we recommend changing your preferences to use a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)." - -{% endnote %} +> [!NOTE] +> If you have previously enabled GPG verification for all repositories, we recommend changing your preferences to use a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)." diff --git a/data/reusables/codespaces/source-control.md b/data/reusables/codespaces/source-control.md index 98efdd0c5157..f8071fbb5d9e 100644 --- a/data/reusables/codespaces/source-control.md +++ b/data/reusables/codespaces/source-control.md @@ -8,11 +8,8 @@ When you create a codespace from a template repository or a template on the "You {% data reusables.codespaces.create-or-switch-branch %} -{% tip %} - -**Tip**: If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace. - -{% endtip %} +> [!TIP] +> If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace. ## Committing your changes diff --git a/data/reusables/codespaces/trusted-repos-step.md b/data/reusables/codespaces/trusted-repos-step.md index cb00b2b85e84..e034be13f29e 100644 --- a/data/reusables/codespaces/trusted-repos-step.md +++ b/data/reusables/codespaces/trusted-repos-step.md @@ -1,7 +1,4 @@ 1. To change your trusted repositories for GPG verification and Settings Sync, under "Trusted repositories," either select **All repositories**, or select **Selected repositories** and use the "Select repositories" dropdown to add repositories you trust. - {% note %} - - **Note:** We recommend using a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)." - - {% endnote %} + > [!NOTE] + > We recommend using a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)." diff --git a/data/reusables/codespaces/using-tools-to-access-ports-1.md b/data/reusables/codespaces/using-tools-to-access-ports-1.md index 5bb28a77b7ae..b0c0409e3369 100644 --- a/data/reusables/codespaces/using-tools-to-access-ports-1.md +++ b/data/reusables/codespaces/using-tools-to-access-ports-1.md @@ -4,10 +4,7 @@ When you forward a port, your application becomes available at the URL `https:// To access your application using a REST client, such as Postman, or a command-line tool like curl, you don't need to authenticate if you're using a localhost port, or if you're accessing a public port at the remote domain. However, to connect to a private port at the remote domain, you must authenticate by using the `GITHUB_TOKEN` access token in your request. -{% note %} - -**Note**: The `GITHUB_TOKEN` is automatically created when you start a codespace and remains the same for the duration of the codespace session. If you stop and then restart a codespace a new `GITHUB_TOKEN` is generated. - -{% endnote %} +> [!NOTE] +> The `GITHUB_TOKEN` is automatically created when you start a codespace and remains the same for the duration of the codespace session. If you stop and then restart a codespace a new `GITHUB_TOKEN` is generated. diff --git a/data/reusables/command-palette/beta-note.md b/data/reusables/command-palette/beta-note.md index 9b6e151c3a4c..a22543100c9c 100644 --- a/data/reusables/command-palette/beta-note.md +++ b/data/reusables/command-palette/beta-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** The {% data variables.product.prodname_command_palette %} is currently in {% data variables.release-phases.public_preview %} and is subject to change. - -{% endnote %} +> [!NOTE] +> The {% data variables.product.prodname_command_palette %} is currently in {% data variables.release-phases.public_preview %} and is subject to change. diff --git a/data/reusables/community/issue-forms-beta.md b/data/reusables/community/issue-forms-beta.md index c57c2b752b14..e19bc530b180 100644 --- a/data/reusables/community/issue-forms-beta.md +++ b/data/reusables/community/issue-forms-beta.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Issue forms are currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Issue forms are currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/dependabot/automated-tests-note.md b/data/reusables/dependabot/automated-tests-note.md index 581ec29adc2b..816d8d103fcf 100644 --- a/data/reusables/dependabot/automated-tests-note.md +++ b/data/reusables/dependabot/automated-tests-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** It's good practice to have automated tests and acceptance processes in place so that checks are carried out before the pull request is merged. This is particularly important if the suggested version to upgrade to contains additional functionality, or a change that breaks your project's code. For more information about continuous integration, see "[AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration)." - -{% endnote %} +> [!NOTE] +> It's good practice to have automated tests and acceptance processes in place so that checks are carried out before the pull request is merged. This is particularly important if the suggested version to upgrade to contains additional functionality, or a change that breaks your project's code. For more information about continuous integration, see "[AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration)." diff --git a/data/reusables/dependabot/dependabot-grouped-security-updates-order.md b/data/reusables/dependabot/dependabot-grouped-security-updates-order.md index 6c231aceca92..2f0b18adddcc 100644 --- a/data/reusables/dependabot/dependabot-grouped-security-updates-order.md +++ b/data/reusables/dependabot/dependabot-grouped-security-updates-order.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If you have configured group rules for {% data variables.product.prodname_dependabot_security_updates %} in a `dependabot.yml` file, all available updates will be grouped according to the rules you've specified. {% data variables.product.prodname_dependabot %} will only group across those directories not configured in your `dependabot.yml` if the setting for grouped security updates at the organization or repository level is also enabled. - -{% endnote %} +> [!NOTE] +> If you have configured group rules for {% data variables.product.prodname_dependabot_security_updates %} in a `dependabot.yml` file, all available updates will be grouped according to the rules you've specified. {% data variables.product.prodname_dependabot %} will only group across those directories not configured in your `dependabot.yml` if the setting for grouped security updates at the organization or repository level is also enabled. diff --git a/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md b/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md index 0084aed2e49b..f2b7cba07a7c 100644 --- a/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md +++ b/data/reusables/dependabot/dependabot-security-updates-disable-for-alert-rules.md @@ -1,9 +1,6 @@ {% ifversion dependabot-auto-triage-rules %} -{% note %} - -**Note:** When {% data variables.product.prodname_dependabot_security_updates %} are enabled for a repository, {% data variables.product.prodname_dependabot %} will automatically try to open pull requests to resolve **every** open {% data variables.product.prodname_dependabot %} alert that has an available patch. If you prefer to customize which alerts {% data variables.product.prodname_dependabot %} opens pull requests for, you should leave {% data variables.product.prodname_dependabot_security_updates %} **disabled** and create an auto-triage rule. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts)." - -{% endnote %} +> [!NOTE] +> When {% data variables.product.prodname_dependabot_security_updates %} are enabled for a repository, {% data variables.product.prodname_dependabot %} will automatically try to open pull requests to resolve **every** open {% data variables.product.prodname_dependabot %} alert that has an available patch. If you prefer to customize which alerts {% data variables.product.prodname_dependabot %} opens pull requests for, you should leave {% data variables.product.prodname_dependabot_security_updates %} **disabled** and create an auto-triage rule. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts)." {% endif %} diff --git a/data/reusables/dependabot/dependabot-security-updates-groups-supported.md b/data/reusables/dependabot/dependabot-security-updates-groups-supported.md index 2be8b2b0edba..24fbb308eb74 100644 --- a/data/reusables/dependabot/dependabot-security-updates-groups-supported.md +++ b/data/reusables/dependabot/dependabot-security-updates-groups-supported.md @@ -1,8 +1,5 @@ {% ifversion dependabot-grouped-security-updates-config %}You can use the `dependabot.yml` file to create separate rules to group {% data variables.product.prodname_dependabot_version_updates %} and {% data variables.product.prodname_dependabot_security_updates %}.{% else %} You can only use the `dependabot.yml` file to create groups for {% data variables.product.prodname_dependabot_version_updates %}. Grouped {% data variables.product.prodname_dependabot_security_updates %} are enabled or disabled in your repository or organization settings and do not support customization. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates)."{% endif %} -{% note %} - -**Note:** If a grouped pull request for {% data variables.product.prodname_dependabot_version_updates %} contains a vulnerable package, {% data variables.product.prodname_dependabot_security_updates %} will still attempt to create a _separate_ pull request to update the vulnerable package to a secure version. Creating a separate pull request for security updates ensures you have visibility into package vulnerabilities. - -{% endnote %} +> [!NOTE] +> If a grouped pull request for {% data variables.product.prodname_dependabot_version_updates %} contains a vulnerable package, {% data variables.product.prodname_dependabot_security_updates %} will still attempt to create a _separate_ pull request to update the vulnerable package to a secure version. Creating a separate pull request for security updates ensures you have visibility into package vulnerabilities. diff --git a/data/reusables/dependabot/dependabot-version-updates-groups-semver.md b/data/reusables/dependabot/dependabot-version-updates-groups-semver.md index 6afd5a1b5c12..53755a248b0c 100644 --- a/data/reusables/dependabot/dependabot-version-updates-groups-semver.md +++ b/data/reusables/dependabot/dependabot-version-updates-groups-semver.md @@ -1,7 +1,4 @@ You can also specify grouping settings based on how updates affect a specific ecosystem and follow semantic versioning (SemVer). This means you can, for example, group all patch updates together. This approach helps {% data variables.product.prodname_dependabot %} create as few pull requests as possible, while also reducing the chances of accidentally accepting changes that could cause issues. If a package follows SemVer, there's a higher chance (but not a guarantee) that minor and patch updates will be backwards compatible. -{% note %} - -**Note:** SemVer is an accepted standard for defining versions of software packages, in the form `x.y.z`. {% data variables.product.prodname_dependabot %} assumes that versions in this form are always `major.minor.patch`. - -{% endnote %} +> [!NOTE] +> SemVer is an accepted standard for defining versions of software packages, in the form `x.y.z`. {% data variables.product.prodname_dependabot %} assumes that versions in this form are always `major.minor.patch`. diff --git a/data/reusables/dependabot/directory-directories-required.md b/data/reusables/dependabot/directory-directories-required.md index a4fa210919a9..f7c518321dd9 100644 --- a/data/reusables/dependabot/directory-directories-required.md +++ b/data/reusables/dependabot/directory-directories-required.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** You cannot use both `directory` and `directories` in the same configuration block. Only one option is required, not both. - -{% endnote %} +> [!NOTE] +> You cannot use both `directory` and `directories` in the same configuration block. Only one option is required, not both. diff --git a/data/reusables/dependabot/enterprise-enable-dependabot.md b/data/reusables/dependabot/enterprise-enable-dependabot.md index 9809c8985ced..42bc0c5be299 100644 --- a/data/reusables/dependabot/enterprise-enable-dependabot.md +++ b/data/reusables/dependabot/enterprise-enable-dependabot.md @@ -1,11 +1,10 @@ {% ifversion ghes %} -{% note %} - -**Note:** Your site administrator must set up {% data variables.product.prodname_dependabot_updates %} for {% data variables.location.product_location %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." - -{% ifversion security-feature-enablement-policies-dependabot %} You may not be able to enable or disable {% data variables.product.prodname_dependabot_updates %} if an enterprise owner has set a policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)."{% endif %} - -{% endnote %} +> [!NOTE] +> Your site administrator must set up {% data variables.product.prodname_dependabot_updates %} for {% data variables.location.product_location %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +{% ifversion security-feature-enablement-policies-dependabot %} +> +> You may not be able to enable or disable {% data variables.product.prodname_dependabot_updates %} if an enterprise owner has set a policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." +{% endif %} {% endif %} diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index d1376d1d8be5..10eb9d356bea 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -33,11 +33,8 @@ poetry | `pip` | v1 | {% octicon "check" aria-l [yarn](#yarn) | `npm` | v1, v2, v3 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %}|{% else %}yarn | `npm` | v1 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | | | {% endif %} | -{% tip %} - -**Tip:** For package managers such as `pipenv` and `poetry`, you need to use the `pip` YAML value. For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your `dependabot.yml` file. - -{% endtip %} +> [!TIP] +> For package managers such as `pipenv` and `poetry`, you need to use the `pip` YAML value. For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your `dependabot.yml` file. For further information about ecosystem support for {% data variables.product.prodname_dependabot_security_updates %}, see also "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems)." @@ -98,14 +95,10 @@ For more information about using {% data variables.product.prodname_dependabot_v {% ifversion dependabot-security-updates-gradle-support %} For {% data variables.product.prodname_dependabot_security_updates %}, Gradle support is limited to manual uploads of the dependency graph data using the {% data variables.dependency-submission-api.name %}. For more information about the {% data variables.dependency-submission-api.name %}, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)." -{% note %} - -**Notes:** - -* When you upload Gradle dependencies to the dependency graph using the {% data variables.dependency-submission-api.name %}, all project dependencies are uploaded, even transitive dependencies that aren't explicitly mentioned in any dependency file. When an alert is detected in a transitive dependency, {% data variables.product.prodname_dependabot %} isn't able to find the vulnerable dependency in the repository, and therefore won't create a security update for that alert. -* {% data variables.product.prodname_dependabot_version_updates %} will, however, create pull requests when the parent dependency is explicitly declared as a direct dependency in the project's manifest file. +> [!NOTE] +> * When you upload Gradle dependencies to the dependency graph using the {% data variables.dependency-submission-api.name %}, all project dependencies are uploaded, even transitive dependencies that aren't explicitly mentioned in any dependency file. When an alert is detected in a transitive dependency, {% data variables.product.prodname_dependabot %} isn't able to find the vulnerable dependency in the repository, and therefore won't create a security update for that alert. +> * {% data variables.product.prodname_dependabot_version_updates %} will, however, create pull requests when the parent dependency is explicitly declared as a direct dependency in the project's manifest file. -{% endnote %} {% endif %} #### Maven diff --git a/data/reusables/dependabot/vulnerable-calls-beta.md b/data/reusables/dependabot/vulnerable-calls-beta.md index 39f6abc02494..1f5cbb8d16d7 100644 --- a/data/reusables/dependabot/vulnerable-calls-beta.md +++ b/data/reusables/dependabot/vulnerable-calls-beta.md @@ -1,11 +1,7 @@ {% ifversion dependabot-alerts-vulnerable-calls %} -{% note %} +> [!NOTE] +> * The detection of calls to vulnerable functions by {% data variables.product.prodname_dependabot %} is in {% data variables.release-phases.public_preview %} and subject to change. +> * {% data reusables.gated-features.dependency-vulnerable-calls %} -**Notes:** - -* The detection of calls to vulnerable functions by {% data variables.product.prodname_dependabot %} is in {% data variables.release-phases.public_preview %} and subject to change. -* {% data reusables.gated-features.dependency-vulnerable-calls %} - -{% endnote %} {% endif %} diff --git a/data/reusables/dependency-graph/supported-package-ecosystems.md b/data/reusables/dependency-graph/supported-package-ecosystems.md index f083d4375f99..41d7d3a34bb1 100644 --- a/data/reusables/dependency-graph/supported-package-ecosystems.md +++ b/data/reusables/dependency-graph/supported-package-ecosystems.md @@ -17,14 +17,7 @@ | Swift Package Manager | Swift | `Package.resolved` | `Package.resolved` | | Yarn | JavaScript | `yarn.lock` | `package.json`, `yarn.lock` | -{% note %} - -**Notes:** - -* If you list your Python dependencies within a `setup.py` file, we may not be able to parse and list every dependency in your project. - -* {% data variables.product.prodname_actions %} workflows must be located in the `.github/workflows/` directory of a repository to be recognized as manifests. Any actions or workflows referenced using the syntax `jobs[*].steps[*].uses` or `jobs..uses` will be parsed as dependencies. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions)." - -* {% data reusables.dependabot.dependabot-alert-actions-semver %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)" and "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)." - -{% endnote %} +> [!NOTE] +> * If you list your Python dependencies within a `setup.py` file, we may not be able to parse and list every dependency in your project. +> * {% data variables.product.prodname_actions %} workflows must be located in the `.github/workflows/` directory of a repository to be recognized as manifests. Any actions or workflows referenced using the syntax `jobs[*].steps[*].uses` or `jobs..uses` will be parsed as dependencies. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions)." +> * {% data reusables.dependabot.dependabot-alert-actions-semver %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)" and "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)." diff --git a/data/reusables/dependency-review/dependency-review-action-beta-note.md b/data/reusables/dependency-review/dependency-review-action-beta-note.md index bf2d2668cb3c..a4346ecfd2aa 100644 --- a/data/reusables/dependency-review/dependency-review-action-beta-note.md +++ b/data/reusables/dependency-review/dependency-review-action-beta-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: The {% data variables.dependency-review.action_name %} is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The {% data variables.dependency-review.action_name %} is currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/dependency-review/works-with-submission-api-beta.md b/data/reusables/dependency-review/works-with-submission-api-beta.md index a7d5302a7b7e..efb30591c86a 100644 --- a/data/reusables/dependency-review/works-with-submission-api-beta.md +++ b/data/reusables/dependency-review/works-with-submission-api-beta.md @@ -1,4 +1,2 @@ -{% note %} - -**Note:** The dependency review API and the {% data variables.dependency-submission-api.name %} work together. This means that the dependency review API will include dependencies submitted via the {% data variables.dependency-submission-api.name %}. -{% endnote %} +> [!NOTE] +> The dependency review API and the {% data variables.dependency-submission-api.name %} work together. This means that the dependency review API will include dependencies submitted via the {% data variables.dependency-submission-api.name %}. diff --git a/data/reusables/dependency-submission/premade-action-table.md b/data/reusables/dependency-submission/premade-action-table.md index 81f830ed1df3..d2b5d031eada 100644 --- a/data/reusables/dependency-submission/premade-action-table.md +++ b/data/reusables/dependency-submission/premade-action-table.md @@ -7,11 +7,8 @@ Mill | [Mill Dependency Submission](https://github.com/marketplace/actions/mill- Scala | [Sbt Dependency Submission](https://github.com/marketplace/actions/sbt-dependency-submission) | NuGet and others | [Component Detection dependency submission action](https://github.com/marketplace/actions/component-detection-dependency-submission-action) | -{% note %} - -**Note:** For the Component Detection dependency submission action, other supported ecosystems include Vcpkg, Conan, Conda, Crates, as well as NuGet. - -{% endnote %} +> [!NOTE] +> For the Component Detection dependency submission action, other supported ecosystems include Vcpkg, Conan, Conda, Crates, as well as NuGet. For example, the following [Go Dependency Submission](https://github.com/actions/go-dependency-submission) workflow calculates the dependencies for a Go build-target (a Go file with a `main` function) and submits the list to the {% data variables.dependency-submission-api.name %}. diff --git a/data/reusables/desktop/note-start-ssh-agent.md b/data/reusables/desktop/note-start-ssh-agent.md index e75c1196a02d..b2e7f6d325b4 100644 --- a/data/reusables/desktop/note-start-ssh-agent.md +++ b/data/reusables/desktop/note-start-ssh-agent.md @@ -1,5 +1,2 @@ -{% tip %} - -**Note:** The eval commands above start ssh-agent manually in your environment. These commands may fail if ssh-agent already runs as a background system service. If that happens, we recommend you check the relevant documentation for your environment. - -{% endtip %} +> [!NOTE] +> The eval commands above start ssh-agent manually in your environment. These commands may fail if ssh-agent already runs as a background system service. If that happens, we recommend you check the relevant documentation for your environment. diff --git a/data/reusables/developer-site/pull_request_forked_repos_link.md b/data/reusables/developer-site/pull_request_forked_repos_link.md index 429ca4f6f100..aab0a7b2bd7a 100644 --- a/data/reusables/developer-site/pull_request_forked_repos_link.md +++ b/data/reusables/developer-site/pull_request_forked_repos_link.md @@ -14,8 +14,5 @@ When a first-time contributor submits a pull request to a public repository, a m For pull requests from a forked repository to a private repository, workflows only run when they are enabled, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-forks-of-private-repositories)." -{% note %} - -**Note:** Workflows triggered by {% data variables.product.prodname_dependabot %} pull requests are treated as though they are from a forked repository, and are also subject to these restrictions. - -{% endnote %} +> [!NOTE] +> Workflows triggered by {% data variables.product.prodname_dependabot %} pull requests are treated as though they are from a forked repository, and are also subject to these restrictions. diff --git a/data/reusables/education/pdf-support.md b/data/reusables/education/pdf-support.md index 96a01a472071..9c86da81dfa0 100644 --- a/data/reusables/education/pdf-support.md +++ b/data/reusables/education/pdf-support.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** PDF files are not supported and you cannot upload them as proof of affiliation. - -{% endnote %} +> [!NOTE] +> PDF files are not supported and you cannot upload them as proof of affiliation. diff --git a/data/reusables/education/select-email-address.md b/data/reusables/education/select-email-address.md index 856a49e63db1..b4cd56980771 100644 --- a/data/reusables/education/select-email-address.md +++ b/data/reusables/education/select-email-address.md @@ -1,7 +1,4 @@ 1. Select or add the email address you use for school. - {% tip %} - - **Tip**: Selecting a school-issued email address, if you have one, gives you the best chance of a speedy review. - - {% endtip %} + > [!TIP] + > Selecting a school-issued email address, if you have one, gives you the best chance of a speedy review. diff --git a/data/reusables/education/submit-application.md b/data/reusables/education/submit-application.md index 3096aa457dbe..39e6537861ec 100644 --- a/data/reusables/education/submit-application.md +++ b/data/reusables/education/submit-application.md @@ -1,9 +1,6 @@ 1. Verify your application details, then click **Process my application**. - {% note %} - - **Note:** If, after clicking the **Process my application** button, you see a banner asking you to fix something in your application, you should fix it and then click **Reprocess my application**. - - {% endnote %} + > [!NOTE] + > If, after clicking the **Process my application** button, you see a banner asking you to fix something in your application, you should fix it and then click **Reprocess my application**. If your application is approved, you'll receive a confirmation email. Applications are usually processed within a few days, but it may take longer during peak times, such as during the start of a new semester. diff --git a/data/reusables/emus/oauth-app-note.md b/data/reusables/emus/oauth-app-note.md index 2a3041f16d3e..71ccd1691dc0 100644 --- a/data/reusables/emus/oauth-app-note.md +++ b/data/reusables/emus/oauth-app-note.md @@ -1,9 +1,6 @@ {% ifversion ghec %} -{% note %} - -**Note:** On {% data variables.product.prodname_dotcom_the_website %}, even an {% data variables.product.prodname_oauth_app %} created by a {% data variables.enterprise.prodname_managed_user %} or {% data variables.enterprise.prodname_emu_org %} can be accessed by users outside the enterprise. - -{% endnote %} +> [!NOTE] +> On {% data variables.product.prodname_dotcom_the_website %}, even an {% data variables.product.prodname_oauth_app %} created by a {% data variables.enterprise.prodname_managed_user %} or {% data variables.enterprise.prodname_emu_org %} can be accessed by users outside the enterprise. {% endif %} diff --git a/data/reusables/emus/use-enterprise-recovery-code.md b/data/reusables/emus/use-enterprise-recovery-code.md index 745182e09dae..9587b2b17902 100644 --- a/data/reusables/emus/use-enterprise-recovery-code.md +++ b/data/reusables/emus/use-enterprise-recovery-code.md @@ -1,7 +1,4 @@ 1. When prompted to continue to your identity provider, click **Use a recovery code** and sign in using one of your enterprise's recovery codes. - {% note %} - - **Note:** You must use a recovery code for your enterprise, not your user account. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." - - {% endnote %} + > [!NOTE] + > You must use a recovery code for your enterprise, not your user account. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." diff --git a/data/reusables/enterprise-accounts/approved-domains-beta-note.md b/data/reusables/enterprise-accounts/approved-domains-beta-note.md index 09f86b2f4d54..903f79977907 100644 --- a/data/reusables/enterprise-accounts/approved-domains-beta-note.md +++ b/data/reusables/enterprise-accounts/approved-domains-beta-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: The ability to approve a domain not owned by your organization or enterprise is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The ability to approve a domain not owned by your organization or enterprise is currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/enterprise-accounts/emu-azure-admin-consent.md b/data/reusables/enterprise-accounts/emu-azure-admin-consent.md index fa153a5f1a13..5163cbafcc5c 100644 --- a/data/reusables/enterprise-accounts/emu-azure-admin-consent.md +++ b/data/reusables/enterprise-accounts/emu-azure-admin-consent.md @@ -1,6 +1,4 @@ 1. After {% data variables.product.product_name %} redirects you to your IdP, sign in, then follow the instructions to give consent and install the {% data variables.product.prodname_emu_idp_oidc_application %} application. After Entra ID asks for permissions for {% data variables.product.company_short %} {% data variables.product.prodname_emus %} with OIDC, enable **Consent on behalf of your organization**, then click **Accept**. - {% warning %} - **Warning:** You must sign in to Entra ID as a user with global admin rights in order to consent to the installation of the {% data variables.product.prodname_emu_idp_oidc_application %} application. - - {% endwarning %} + > [!WARNING] + > You must sign in to Entra ID as a user with global admin rights in order to consent to the installation of the {% data variables.product.prodname_emu_idp_oidc_application %} application. diff --git a/data/reusables/enterprise-accounts/emu-saml-note.md b/data/reusables/enterprise-accounts/emu-saml-note.md index 3d80739fcce9..604f24357fb4 100644 --- a/data/reusables/enterprise-accounts/emu-saml-note.md +++ b/data/reusables/enterprise-accounts/emu-saml-note.md @@ -1,7 +1,6 @@ {% ifversion ghec %} -{% note %} -**Note**: If your enterprise uses {% data variables.product.prodname_emus %}, you must follow a different process to configure SAML single sign-on. 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)." +> [!NOTE] +> If your enterprise uses {% data variables.product.prodname_emus %}, you must follow a different process to configure SAML single sign-on. 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)." -{% endnote %} {% endif %} diff --git a/data/reusables/enterprise-accounts/emu-scim-note.md b/data/reusables/enterprise-accounts/emu-scim-note.md index b9518e7e026f..a0b66d26eb5d 100644 --- a/data/reusables/enterprise-accounts/emu-scim-note.md +++ b/data/reusables/enterprise-accounts/emu-scim-note.md @@ -1,7 +1,6 @@ {% ifversion ghec %} -{% note %} -**Note**: If your enterprise uses {% data variables.product.prodname_emus %}, you do not need to use team synchronization. Instead, you can manage team membership via the SCIM configuration you created while setting up your enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." +> [!NOTE] +> If your enterprise uses {% data variables.product.prodname_emus %}, you do not need to use team synchronization. Instead, you can manage team membership via the SCIM configuration you created while setting up your enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." -{% endnote %} {% endif %} diff --git a/data/reusables/enterprise-accounts/oidc-gei-warning.md b/data/reusables/enterprise-accounts/oidc-gei-warning.md index 82ecab040c7a..c186d21a83fd 100644 --- a/data/reusables/enterprise-accounts/oidc-gei-warning.md +++ b/data/reusables/enterprise-accounts/oidc-gei-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** If you use {% data variables.product.prodname_importer_proper_name %} to migrate an organization from {% data variables.location.product_location_enterprise %}, make sure to use a service account that is exempt from Entra ID's CAP otherwise your migration may be blocked. - -{% endwarning %} +> [!WARNING] +> If you use {% data variables.product.prodname_importer_proper_name %} to migrate an organization from {% data variables.location.product_location_enterprise %}, make sure to use a service account that is exempt from Entra ID's CAP otherwise your migration may be blocked. diff --git a/data/reusables/enterprise-accounts/support-entitlements.md b/data/reusables/enterprise-accounts/support-entitlements.md index 9620603ff40c..1c8359987234 100644 --- a/data/reusables/enterprise-accounts/support-entitlements.md +++ b/data/reusables/enterprise-accounts/support-entitlements.md @@ -2,9 +2,7 @@ To open, view, and comment on support tickets associated with an enterprise account, you must have support entitlements for the enterprise. Enterprise owners and billing managers automatically have a support entitlement, and enterprise owners can add support entitlements to enterprise members. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." -{% note %} +> [!NOTE] +> Any organization member can create tickets associated with an individual organization that is owned by an enterprise account. Support entitlements are only required to create tickets associated with the enterprise account itself. -**Note:** Any organization member can create tickets associated with an individual organization that is owned by an enterprise account. Support entitlements are only required to create tickets associated with the enterprise account itself. - -{% endnote %} {% endif %} diff --git a/data/reusables/enterprise-managed/sso-redirect-release-phase.md b/data/reusables/enterprise-managed/sso-redirect-release-phase.md index 07fb3fc586c5..d57c5cb035e0 100644 --- a/data/reusables/enterprise-managed/sso-redirect-release-phase.md +++ b/data/reusables/enterprise-managed/sso-redirect-release-phase.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Automatically redirecting users to sign in is currently in {% data variables.release-phases.public_preview %} for {% data variables.product.prodname_emus %} and subject to change. - -{% endnote %} +> [!NOTE] +> Automatically redirecting users to sign in is currently in {% data variables.release-phases.public_preview %} for {% data variables.product.prodname_emus %} and subject to change. diff --git a/data/reusables/enterprise-migration-tool/blob-storage-management-console.md b/data/reusables/enterprise-migration-tool/blob-storage-management-console.md index ebdd077f6b9d..606ed356250f 100644 --- a/data/reusables/enterprise-migration-tool/blob-storage-management-console.md +++ b/data/reusables/enterprise-migration-tool/blob-storage-management-console.md @@ -8,18 +8,13 @@ After you set up an AWS S3 storage bucket or Azure Blob Storage storage account, 1. Under **Migrations**, click **Enable {% data variables.product.company_short %} Migrations**. 1. Optionally, to import storage settings you configured for {% data variables.product.prodname_actions %}, select **Copy Storage settings from Actions**. For more information see, "[Enabling GitHub Actions with Azure Blob storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage)" and "[Enabling GitHub Actions with Amazon S3 storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage)." - {% note %} - - **Note**: After copying your storage settings, you may still need to update the configuration of your cloud storage account to work with {% data variables.product.prodname_importer_proper_name %}. In particular, you must ensure that {% data variables.product.prodname_dotcom %}'s IP addresses are allowlisted. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#configuring-ip-allow-lists-for-migrations)." - - {% endnote %} + > [!NOTE] + > After copying your storage settings, you may still need to update the configuration of your cloud storage account to work with {% data variables.product.prodname_importer_proper_name %}. In particular, you must ensure that {% data variables.product.prodname_dotcom %}'s IP addresses are allowlisted. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#configuring-ip-allow-lists-for-migrations)." 1. If you do not import storage settings from {% data variables.product.prodname_actions %}, select either **Azure Blob Storage** or **Amazon S3** and fill in the required details. - {% note %} - - **Note**: If you use Amazon S3, you must set the "AWS Service URL" to the standard endpoint for the AWS region where your bucket is located. For example, if your bucket is located in the `eu-west-1` region, the "AWS Service URL" would be `https://s3.eu-west-1.amazonaws.com`. Your {% data variables.product.prodname_ghe_server %} instance's network must allow access to this host. Gateway endpoints are not supported, such as `bucket.vpce-0e25b8cdd720f900e-argc85vg.s3.eu-west-1.vpce.amazonaws.com`. For more information about gateway endpoints, see [Gateway endpoints for Amazon S3](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints-s3.html) in the AWS documentation. + > [!NOTE] + > If you use Amazon S3, you must set the "AWS Service URL" to the standard endpoint for the AWS region where your bucket is located. For example, if your bucket is located in the `eu-west-1` region, the "AWS Service URL" would be `https://s3.eu-west-1.amazonaws.com`. Your {% data variables.product.prodname_ghe_server %} instance's network must allow access to this host. Gateway endpoints are not supported, such as `bucket.vpce-0e25b8cdd720f900e-argc85vg.s3.eu-west-1.vpce.amazonaws.com`. For more information about gateway endpoints, see [Gateway endpoints for Amazon S3](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints-s3.html) in the AWS documentation. - {% endnote %} 1. Click **Test storage settings**. 1. Click **Save settings**. diff --git a/data/reusables/enterprise-migration-tool/generate-migration-script.md b/data/reusables/enterprise-migration-tool/generate-migration-script.md index 333ad8c4e4a0..36425f0b652a 100644 --- a/data/reusables/enterprise-migration-tool/generate-migration-script.md +++ b/data/reusables/enterprise-migration-tool/generate-migration-script.md @@ -1,7 +1,4 @@ If you want to migrate multiple repositories to {% data variables.product.prodname_ghe_cloud %} at once, use the {% data variables.product.prodname_cli %} to generate a migration script. The resulting script will contain a list of migration commands, one per repository. -{% note %} - -**Note:** Generating a script outputs a PowerShell script. If you're using Terminal, you will need to output the script with the `.ps1` file extension and install PowerShell for either [Mac](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-macos?view=powershell-7.2) or [Linux](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux?view=powershell-7.2) to run it. - -{% endnote %} +> [!NOTE] +> Generating a script outputs a PowerShell script. If you're using Terminal, you will need to output the script with the `.ps1` file extension and install PowerShell for either [Mac](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-macos?view=powershell-7.2) or [Linux](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux?view=powershell-7.2) to run it. diff --git a/data/reusables/enterprise-migration-tool/gh-repo-stats-not-supported.md b/data/reusables/enterprise-migration-tool/gh-repo-stats-not-supported.md index 0564da268d99..af68b6e53fc5 100644 --- a/data/reusables/enterprise-migration-tool/gh-repo-stats-not-supported.md +++ b/data/reusables/enterprise-migration-tool/gh-repo-stats-not-supported.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** `gh-repo-stats` is a third-party open-source tool which is not supported by GitHub Support. If you need help with this tool, [open an issue](https://github.com/mona-actions/gh-repo-stats/issues) in its repository. - -{% endnote %} +> [!NOTE] +> `gh-repo-stats` is a third-party open-source tool which is not supported by GitHub Support. If you need help with this tool, [open an issue](https://github.com/mona-actions/gh-repo-stats/issues) in its repository. diff --git a/data/reusables/enterprise-migration-tool/github-pat-required-scopes.md b/data/reusables/enterprise-migration-tool/github-pat-required-scopes.md index a0080cf4cf52..1a1e3775ae44 100644 --- a/data/reusables/enterprise-migration-tool/github-pat-required-scopes.md +++ b/data/reusables/enterprise-migration-tool/github-pat-required-scopes.md @@ -1,10 +1,7 @@ The scopes that are required for your {% data variables.product.prodname_dotcom %} {% data variables.product.pat_v1 %} depend on your role and the task you want to complete. -{% note %} - -**Note**: {% data reusables.user-settings.generic-classic-pat-only %} This means that you cannot use {% data variables.product.prodname_importer_proper_name %} if your organization uses the "Restrict {% data variables.product.pat_v1_plural %} from accessing your organizations" policy. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise#restricting-access-by-personal-access-tokens)." - -{% endnote %} +> [!NOTE] +> {% data reusables.user-settings.generic-classic-pat-only %} This means that you cannot use {% data variables.product.prodname_importer_proper_name %} if your organization uses the "Restrict {% data variables.product.pat_v1_plural %} from accessing your organizations" policy. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise#restricting-access-by-personal-access-tokens)." Task | Organization owner | Migrator ---- | -------- | ----- | diff --git a/data/reusables/enterprise-migration-tool/install-github-cli.md b/data/reusables/enterprise-migration-tool/install-github-cli.md index 1b11c51be94c..88cf8e42da57 100644 --- a/data/reusables/enterprise-migration-tool/install-github-cli.md +++ b/data/reusables/enterprise-migration-tool/install-github-cli.md @@ -1,7 +1,4 @@ 1. Install the {% data variables.product.prodname_cli %}. {% data reusables.cli.cli-installation %} - {% note %} - - **Note:** You need version 2.4.0 or newer of {% data variables.product.prodname_cli %}. You can check the version you have installed with the `gh --version` command. - - {% endnote %} + > [!NOTE] + > You need version 2.4.0 or newer of {% data variables.product.prodname_cli %}. You can check the version you have installed with the `gh --version` command. diff --git a/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md b/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md index 4e47cfb956eb..b43e77ed6636 100644 --- a/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md +++ b/data/reusables/enterprise-migration-tool/migration-log-errors-okay.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If the "Migration Log" issue includes "Migration completed" at the bottom, the repository was migrated. Warnings only indicate that specific items within the repository, such as a comment on a pull request, may not have migrated correctly. - -{% endnote %} +> [!NOTE] +> If the "Migration Log" issue includes "Migration completed" at the bottom, the repository was migrated. Warnings only indicate that specific items within the repository, such as a comment on a pull request, may not have migrated correctly. diff --git a/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md b/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md index d96031c1cf89..d2b25c79f7b4 100644 --- a/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md +++ b/data/reusables/enterprise-migration-tool/reclaiming-mannequins.md @@ -2,11 +2,8 @@ {% data reusables.enterprise-migration-tool.how-to-reclaim %} For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer)." -{% note %} - -**Note:** Only organization owners can reclaim mannequins. If you've been granted the migrator role, contact an organization owner to perform this step. - -{% endnote %} +> [!NOTE] +> Only organization owners can reclaim mannequins. If you've been granted the migrator role, contact an organization owner to perform this step. 1. Decide if you want to reclaim mannequins. 1. Plan when you'll complete reclaims. diff --git a/data/reusables/enterprise-migration-tool/set-up-aws-bucket.md b/data/reusables/enterprise-migration-tool/set-up-aws-bucket.md index bb7ce0bf4281..78a2c843b9a0 100644 --- a/data/reusables/enterprise-migration-tool/set-up-aws-bucket.md +++ b/data/reusables/enterprise-migration-tool/set-up-aws-bucket.md @@ -27,8 +27,5 @@ You will also need an AWS access key and secret key with the following permissio } ``` -{% note %} - -**Note:** {% data variables.product.prodname_importer_proper_name %} does not delete your archive from AWS after your migration is finished. To reduce storage costs, we recommend configuring auto-deletion of your archive after a period of time. For more information, see [Setting lifecycle configuration on a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/how-to-set-lifecycle-configuration-intro.html) in the AWS documentation. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_importer_proper_name %} does not delete your archive from AWS after your migration is finished. To reduce storage costs, we recommend configuring auto-deletion of your archive after a period of time. For more information, see [Setting lifecycle configuration on a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/how-to-set-lifecycle-configuration-intro.html) in the AWS documentation. diff --git a/data/reusables/enterprise-migration-tool/set-up-azure-storage-account.md b/data/reusables/enterprise-migration-tool/set-up-azure-storage-account.md index 3f4055129db6..9f73e593fc5f 100644 --- a/data/reusables/enterprise-migration-tool/set-up-azure-storage-account.md +++ b/data/reusables/enterprise-migration-tool/set-up-azure-storage-account.md @@ -1,7 +1,4 @@ In Azure, create a storage account and make a note of your connection string. For more information, see [Manage storage account access keys](https://learn.microsoft.com/en-gb/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#regenerate-access-keys) in Microsoft Docs. -{% note %} - -**Note:** {% data variables.product.prodname_importer_proper_name %} does not delete your archive from Azure Blob Storage after your migration is finished. To reduce storage costs, we recommend configuring auto-deletion of your archive after a period of time. For more information, see [Optimize costs by automatically managing the data lifecycle](https://learn.microsoft.com/en-us/azure/storage/blobs/lifecycle-management-overview) in Microsoft Docs. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_importer_proper_name %} does not delete your archive from Azure Blob Storage after your migration is finished. To reduce storage costs, we recommend configuring auto-deletion of your archive after a period of time. For more information, see [Optimize costs by automatically managing the data lifecycle](https://learn.microsoft.com/en-us/azure/storage/blobs/lifecycle-management-overview) in Microsoft Docs. diff --git a/data/reusables/enterprise-migration-tool/type-note-azure-devops.md b/data/reusables/enterprise-migration-tool/type-note-azure-devops.md index 243f62d95c8a..a86628bb3d7b 100644 --- a/data/reusables/enterprise-migration-tool/type-note-azure-devops.md +++ b/data/reusables/enterprise-migration-tool/type-note-azure-devops.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Make sure to use `AZURE_DEVOPS` for `type`. - -{% endnote %} +> [!NOTE] +> Make sure to use `AZURE_DEVOPS` for `type`. diff --git a/data/reusables/enterprise-migration-tool/type-note-github-archive.md b/data/reusables/enterprise-migration-tool/type-note-github-archive.md index 9724a4d93b23..b1d0c5d9a77b 100644 --- a/data/reusables/enterprise-migration-tool/type-note-github-archive.md +++ b/data/reusables/enterprise-migration-tool/type-note-github-archive.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Make sure to use `GITHUB_ARCHIVE` for `type`. - -{% endnote %} +> [!NOTE] +> Make sure to use `GITHUB_ARCHIVE` for `type`. diff --git a/data/reusables/enterprise/apply-configuration.md b/data/reusables/enterprise/apply-configuration.md index 118bf086e717..50cae4e413de 100644 --- a/data/reusables/enterprise/apply-configuration.md +++ b/data/reusables/enterprise/apply-configuration.md @@ -1,10 +1,7 @@ 1. To apply the configuration, run the following command. - {% note %} - - **Note**: During a configuration run, services on {% data variables.location.product_location %} may restart, which can cause brief downtime for users. - - {% endnote %} + > [!NOTE] + > During a configuration run, services on {% data variables.location.product_location %} may restart, which can cause brief downtime for users. ```shell copy ghe-config-apply diff --git a/data/reusables/enterprise/azure-maps-auth-warning.md b/data/reusables/enterprise/azure-maps-auth-warning.md index f86641cfc9dc..ce14520f8160 100644 --- a/data/reusables/enterprise/azure-maps-auth-warning.md +++ b/data/reusables/enterprise/azure-maps-auth-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning**: {% data variables.product.company_short %} does not recommend the use of an Azure Maps API token for authentication. To improve security, upgrade to the latest patch release of {% data variables.product.product_name %} and reconfigure Azure Maps authentication. After you upgrade, interactive maps will be disabled for your instance until you reconfigure authentication. {% data reusables.enterprise.azure-maps-auth-deprecation-link %} - -{% endwarning %} +> [!WARNING] +> {% data variables.product.company_short %} does not recommend the use of an Azure Maps API token for authentication. To improve security, upgrade to the latest patch release of {% data variables.product.product_name %} and reconfigure Azure Maps authentication. After you upgrade, interactive maps will be disabled for your instance until you reconfigure authentication. {% data reusables.enterprise.azure-maps-auth-deprecation-link %} diff --git a/data/reusables/enterprise/role-permission-hierarchy.md b/data/reusables/enterprise/role-permission-hierarchy.md index 63791e218f3d..7d03d2a82fe5 100644 --- a/data/reusables/enterprise/role-permission-hierarchy.md +++ b/data/reusables/enterprise/role-permission-hierarchy.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** This policy only impacts repository administrators, specifically. Organization owners and security managers can always enable security features, regardless of how you set this policy. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." - -{% endnote %} +> [!NOTE] +> This policy only impacts repository administrators, specifically. Organization owners and security managers can always enable security features, regardless of how you set this policy. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." diff --git a/data/reusables/enterprise/saml-or-ldap.md b/data/reusables/enterprise/saml-or-ldap.md index 1c4cdc1f5f31..6e58fb8531eb 100644 --- a/data/reusables/enterprise/saml-or-ldap.md +++ b/data/reusables/enterprise/saml-or-ldap.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** You can use either SAML or LDAP, but not both. - -{% endnote %} +> [!NOTE] +> You can use either SAML or LDAP, but not both. diff --git a/data/reusables/enterprise_clustering/clustering-requires-https.md b/data/reusables/enterprise_clustering/clustering-requires-https.md index 94e347b509b5..7e5cc31ce6b8 100644 --- a/data/reusables/enterprise_clustering/clustering-requires-https.md +++ b/data/reusables/enterprise_clustering/clustering-requires-https.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** {% data variables.product.prodname_ghe_server %} clustering must be configured with HTTPS. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_ghe_server %} clustering must be configured with HTTPS. diff --git a/data/reusables/enterprise_clustering/replacing-a-cluster-node-replacement-name.md b/data/reusables/enterprise_clustering/replacing-a-cluster-node-replacement-name.md index 0b4d0c5bd1d9..627e9b667236 100644 --- a/data/reusables/enterprise_clustering/replacing-a-cluster-node-replacement-name.md +++ b/data/reusables/enterprise_clustering/replacing-a-cluster-node-replacement-name.md @@ -1,10 +1,7 @@ 1. If you're replacing the primary Redis node, in `cluster.conf`, modify the `redis-master` value with the replacement node name. - {% note %} - - **Note:** If your primary Redis node is also your primary MySQL node, see "[Replacing the primary MySQL node](#replacing-the-primary-mysql-node)." - - {% endnote %} + > [!NOTE] + > If your primary Redis node is also your primary MySQL node, see "[Replacing the primary MySQL node](#replacing-the-primary-mysql-node)." For example, this modified `cluster.conf` file specifies a newly provisioned cluster node, `ghe-replacement-data-node-1` as the primary Redis node: diff --git a/data/reusables/enterprise_enterprise_support/use_ghe_cluster_support_bundle.md b/data/reusables/enterprise_enterprise_support/use_ghe_cluster_support_bundle.md index 1455248601a0..80595569b966 100644 --- a/data/reusables/enterprise_enterprise_support/use_ghe_cluster_support_bundle.md +++ b/data/reusables/enterprise_enterprise_support/use_ghe_cluster_support_bundle.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If {% data variables.location.product_location %} is in a geo-replication configuration, or if your instance is a cluster, you should use the `ghe-cluster-support-bundle` command to retrieve the support bundle. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-cluster-support-bundle)." - -{% endnote %} +> [!NOTE] +> If {% data variables.location.product_location %} is in a geo-replication configuration, or if your instance is a cluster, you should use the `ghe-cluster-support-bundle` command to retrieve the support bundle. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-cluster-support-bundle)." diff --git a/data/reusables/enterprise_installation/changing-hostname-not-supported.md b/data/reusables/enterprise_installation/changing-hostname-not-supported.md index 2f73ba70e7cc..bc3c3f009b6b 100644 --- a/data/reusables/enterprise_installation/changing-hostname-not-supported.md +++ b/data/reusables/enterprise_installation/changing-hostname-not-supported.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning**: Do not change the hostname for {% data variables.product.prodname_ghe_server %} after initial setup. Changing the hostname will cause unexpected behavior, up to and including instance outages and invalidation of users' security keys. If you have changed the hostname for your instance and are experiencing problems, contact {% data variables.contact.enterprise_support %} or {% data variables.contact.premium_support %}. - -{% endwarning %} +> [!WARNING] +> Do not change the hostname for {% data variables.product.prodname_ghe_server %} after initial setup. Changing the hostname will cause unexpected behavior, up to and including instance outages and invalidation of users' security keys. If you have changed the hostname for your instance and are experiencing problems, contact {% data variables.contact.enterprise_support %} or {% data variables.contact.premium_support %}. diff --git a/data/reusables/enterprise_installation/disable-github-pages-warning.md b/data/reusables/enterprise_installation/disable-github-pages-warning.md index b3d855ab373d..9f7aa8f7dae5 100644 --- a/data/reusables/enterprise_installation/disable-github-pages-warning.md +++ b/data/reusables/enterprise_installation/disable-github-pages-warning.md @@ -1,7 +1,6 @@ {% ifversion ghes %} -{% warning %} -**Warning:** If subdomain isolation is disabled, we recommend also disabling {% data variables.product.prodname_pages %} on your enterprise. There will be no way to isolate user-supplied {% data variables.product.prodname_pages %} content from the rest of your enterprise's data. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)." +> [!WARNING] +> If subdomain isolation is disabled, we recommend also disabling {% data variables.product.prodname_pages %} on your enterprise. There will be no way to isolate user-supplied {% data variables.product.prodname_pages %} content from the rest of your enterprise's data. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise)." -{% endwarning %} {% endif %} diff --git a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md index 3621d1ad6d4b..8bc40fbdc9e2 100644 --- a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md +++ b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md @@ -45,11 +45,8 @@ If you plan to enable {% data variables.product.prodname_actions %} for the user {% data reusables.enterprise_installation.increasing-cpus-req %} -{% warning %} - -**Warning:** We recommend that users configure webhook events to notify external systems of activity on {% data variables.product.prodname_ghe_server %}. Automated checks for changes, or _polling_, will negatively impact the performance and scalability of your instance. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/about-webhooks)." - -{% endwarning %} +> [!WARNING] +> We recommend that users configure webhook events to notify external systems of activity on {% data variables.product.prodname_ghe_server %}. Automated checks for changes, or _polling_, will negatively impact the performance and scalability of your instance. For more information, see "[AUTOTITLE](/get-started/exploring-integrations/about-webhooks)." For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[AUTOTITLE](/admin/enterprise-management/monitoring-your-appliance)." diff --git a/data/reusables/enterprise_installation/image-urls-viewable-warning.md b/data/reusables/enterprise_installation/image-urls-viewable-warning.md index 896a1e806b15..e08c7385537d 100644 --- a/data/reusables/enterprise_installation/image-urls-viewable-warning.md +++ b/data/reusables/enterprise_installation/image-urls-viewable-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** If you add an image attachment to a pull request or issue comment, anyone can view the anonymized image URL without authentication{% ifversion ghes %}, even if the pull request is in a private repository, or if private mode is enabled. To prevent unauthorized access to the images, ensure that you restrict network access to the systems that serve the images, including {% data variables.location.product_location %}{% endif %}. - -{% endwarning %} +> [!WARNING] +> If you add an image attachment to a pull request or issue comment, anyone can view the anonymized image URL without authentication{% ifversion ghes %}, even if the pull request is in a private repository, or if private mode is enabled. To prevent unauthorized access to the images, ensure that you restrict network access to the systems that serve the images, including {% data variables.location.product_location %}{% endif %}. diff --git a/data/reusables/enterprise_installation/new-instance-attack-vector-warning.md b/data/reusables/enterprise_installation/new-instance-attack-vector-warning.md index 4d5b39b7ff9c..b4e7a8b32e2e 100644 --- a/data/reusables/enterprise_installation/new-instance-attack-vector-warning.md +++ b/data/reusables/enterprise_installation/new-instance-attack-vector-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning**: To prevent an attacker from compromising the new instance, ensure that you personally set the {% ifversion enterprise-management-console-multi-user-auth %}root {% endif %}{% data variables.enterprise.management_console %} password and create the first user as soon as possible. - -{% endwarning %} +> [!WARNING] +> To prevent an attacker from compromising the new instance, ensure that you personally set the {% ifversion enterprise-management-console-multi-user-auth %}root {% endif %}{% data variables.enterprise.management_console %} password and create the first user as soon as possible. diff --git a/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md b/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md index 1927e06e436c..5b1c3de6dd24 100644 --- a/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md +++ b/data/reusables/enterprise_installation/proxy-incompatible-with-aws-nlbs.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** {% data variables.product.prodname_ghe_server %} supports PROXY Protocol V1, which is incompatible with AWS Network Load Balancers. If you use AWS Network Load Balancers with {% data variables.product.prodname_ghe_server %}, do not enable PROXY support. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_ghe_server %} supports PROXY Protocol V1, which is incompatible with AWS Network Load Balancers. If you use AWS Network Load Balancers with {% data variables.product.prodname_ghe_server %}, do not enable PROXY support. diff --git a/data/reusables/enterprise_installation/replication-command.md b/data/reusables/enterprise_installation/replication-command.md index ad0e1b94ee6b..ef876aa65290 100644 --- a/data/reusables/enterprise_installation/replication-command.md +++ b/data/reusables/enterprise_installation/replication-command.md @@ -4,8 +4,5 @@ ghe-repl-start ``` - {% warning %} - - **Warning:** `ghe-repl-start` causes a brief outage on the primary server, during which users may see internal server errors. To provide a friendlier message, run `ghe-maintenance -s` on the primary node before running `ghe-repl-start` on the replica node to put the appliance in maintenance mode. Once replication starts, disable maintenance mode with `ghe-maintenance -u`. Git replication will not progress while the primary node is in maintenance mode. - - {% endwarning %} + > [!WARNING] + > `ghe-repl-start` causes a brief outage on the primary server, during which users may see internal server errors. To provide a friendlier message, run `ghe-maintenance -s` on the primary node before running `ghe-repl-start` on the replica node to put the appliance in maintenance mode. Once replication starts, disable maintenance mode with `ghe-maintenance -u`. Git replication will not progress while the primary node is in maintenance mode. diff --git a/data/reusables/enterprise_installation/replication-status-upgrade.md b/data/reusables/enterprise_installation/replication-status-upgrade.md index e0ab1ad5e44c..9f27796ddc27 100644 --- a/data/reusables/enterprise_installation/replication-status-upgrade.md +++ b/data/reusables/enterprise_installation/replication-status-upgrade.md @@ -1,21 +1,16 @@ If the command returns `Replication is not running`, the replication may still be starting. Wait about one minute before running `ghe-repl-status` again. - {% note %} - - **Notes:** - - * While the resync is in progress `ghe-repl-status` may indicate that replication is behind. For example, you may see the following message. - - ```text - CRITICAL: git replication is behind the primary by more than 1007 repositories and/or gists - ``` - - * If {% data variables.product.prodname_actions %} is enabled on {% data variables.location.product_location %}, you may see a message like the following. This message is expected when replication is paused due to maintenance mode being set on the primary appliance. Once maintenance mode is unset, this message should be resolved. - - ```text - CRITICAL: mssql replication is down, didn't find Token_Configuration! - ``` - - {% endnote %} - - If `ghe-repl-status` did not return `OK`, and the explanation isn't listed in the note above, contact {% data variables.contact.enterprise_support %}. For more information, see "[AUTOTITLE](/support/contacting-github-support)." + > [!NOTE] + > * While the resync is in progress `ghe-repl-status` may indicate that replication is behind. For example, you may see the following message. + > + > ```text + > CRITICAL: git replication is behind the primary by more than 1007 repositories and/or gists + > ``` + > + > * If {% data variables.product.prodname_actions %} is enabled on {% data variables.location.product_location %}, you may see a message like the following. This message is expected when replication is paused due to maintenance mode being set on the primary appliance. Once maintenance mode is unset, this message should be resolved. + > + > ```text + > CRITICAL: mssql replication is down, didn't find Token_Configuration! + > ``` + + If `ghe-repl-status` did not return `OK`, and the explanation isn't listed in the note above, contact {% data variables.contact.enterprise_support %}. For more information, see "[AUTOTITLE](/support/contacting-github-support)." diff --git a/data/reusables/enterprise_installation/terminating-tls.md b/data/reusables/enterprise_installation/terminating-tls.md index b1252afb6774..6492003ed960 100644 --- a/data/reusables/enterprise_installation/terminating-tls.md +++ b/data/reusables/enterprise_installation/terminating-tls.md @@ -1,5 +1,2 @@ -{% warning %} - - **Warning:** When terminating HTTPS connections on a load balancer, the requests from the load balancer to {% data variables.product.prodname_ghe_server %} also need to use HTTPS. Downgrading the connection to HTTP is not supported. - -{% endwarning %} +> [!WARNING] +> When terminating HTTPS connections on a load balancer, the requests from the load balancer to {% data variables.product.prodname_ghe_server %} also need to use HTTPS. Downgrading the connection to HTTP is not supported. diff --git a/data/reusables/enterprise_management_console/api-deprecation.md b/data/reusables/enterprise_management_console/api-deprecation.md index 37756c4b6f09..e929452dcda0 100644 --- a/data/reusables/enterprise_management_console/api-deprecation.md +++ b/data/reusables/enterprise_management_console/api-deprecation.md @@ -1,7 +1,6 @@ {% ifversion management-console-manage-ghes-parity %} -{% note %} -**Note:** The {% data variables.enterprise.management_console %} endpoints will be deprecated in a future version of {% data variables.product.prodname_ghe_server %}. You can access the same functionality using the Manage {% data variables.product.prodname_ghe_server %} endpoints. For more information, see "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)." +> [!NOTE] +> The {% data variables.enterprise.management_console %} endpoints will be deprecated in a future version of {% data variables.product.prodname_ghe_server %}. You can access the same functionality using the Manage {% data variables.product.prodname_ghe_server %} endpoints. For more information, see "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)." -{% endnote %} {% endif %} diff --git a/data/reusables/enterprise_management_console/save-settings.md b/data/reusables/enterprise_management_console/save-settings.md index 68ecebbeb65f..1a08295ca2e6 100644 --- a/data/reusables/enterprise_management_console/save-settings.md +++ b/data/reusables/enterprise_management_console/save-settings.md @@ -1,9 +1,6 @@ 1. Under the "Settings" sidebar, click **Save settings**. - {% note %} - - **Note:** Saving settings in the {% data variables.enterprise.management_console %} restarts system services, which could result in user-visible downtime. - - {% endnote %} + > [!NOTE] + > Saving settings in the {% data variables.enterprise.management_console %} restarts system services, which could result in user-visible downtime. {% data reusables.enterprise_site_admin_settings.wait-for-configuration-run %} diff --git a/data/reusables/enterprise_migrations/fork-persistence.md b/data/reusables/enterprise_migrations/fork-persistence.md index 038dd6d1538f..a0d859d81fbe 100644 --- a/data/reusables/enterprise_migrations/fork-persistence.md +++ b/data/reusables/enterprise_migrations/fork-persistence.md @@ -1,5 +1,2 @@ -{% tip %} - -**Note:** Fork relationships do not persist after a migration. - -{% endtip %} +> [!NOTE] +> Fork relationships do not persist after a migration. diff --git a/data/reusables/enterprise_migrations/locking-repositories.md b/data/reusables/enterprise_migrations/locking-repositories.md index 912ca4f6ff78..ed0da5d3533e 100644 --- a/data/reusables/enterprise_migrations/locking-repositories.md +++ b/data/reusables/enterprise_migrations/locking-repositories.md @@ -1,6 +1,4 @@ -{% tip %} - -**Note:** Locking a repository prevents all write access to the repository. You cannot associate new teams or collaborators with a locked repository. - -If you're performing a trial run, you do not need to lock the repository. When you migrate data from a repository that's in use, {% data variables.product.company_short %} strongly recommends locking the repository. For more information, see "[AUTOTITLE](/migrations/using-ghe-migrator/about-ghe-migrator#types-of-migrations)." -{% endtip %} +> [!NOTE] +> Locking a repository prevents all write access to the repository. You cannot associate new teams or collaborators with a locked repository. +> +>If you're performing a trial run, you do not need to lock the repository. When you migrate data from a repository that's in use, {% data variables.product.company_short %} strongly recommends locking the repository. For more information, see "[AUTOTITLE](/migrations/using-ghe-migrator/about-ghe-migrator#types-of-migrations)." diff --git a/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md b/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md index 0d502cb382b6..75794fcbc5f5 100644 --- a/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md +++ b/data/reusables/enterprise_site_admin_settings/add-key-to-web-flow-user.md @@ -8,8 +8,5 @@ 1. Sign into {% data variables.product.prodname_ghe_server %} as the user created for web commit signing, for example, `web-flow`. 1. Add the public PGP key to the user's profile. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)." - {% note %} - - **Note:** Do not remove other public keys from the list of GPG keys. If a public key is deleted, any commits signed with the corresponding private key will no longer be marked as verified. - - {% endnote %} + > [!NOTE] + > Do not remove other public keys from the list of GPG keys. If a public key is deleted, any commits signed with the corresponding private key will no longer be marked as verified. diff --git a/data/reusables/enterprise_site_admin_settings/maintenance-mode-status.md b/data/reusables/enterprise_site_admin_settings/maintenance-mode-status.md index b3b1f46465b4..58307e656431 100644 --- a/data/reusables/enterprise_site_admin_settings/maintenance-mode-status.md +++ b/data/reusables/enterprise_site_admin_settings/maintenance-mode-status.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** When the appliance is in maintenance mode, the `https://HOSTNAME/status` URL will return status code `503` (Service Unavailable). For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." - -{% endnote %} +> [!NOTE] +> When the appliance is in maintenance mode, the `https://HOSTNAME/status` URL will return status code `503` (Service Unavailable). For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." diff --git a/data/reusables/enterprise_site_admin_settings/override-policy.md b/data/reusables/enterprise_site_admin_settings/override-policy.md index c84a814e80c5..9976166b792a 100644 --- a/data/reusables/enterprise_site_admin_settings/override-policy.md +++ b/data/reusables/enterprise_site_admin_settings/override-policy.md @@ -1,5 +1,2 @@ -{% tip %} - -**Note:** Each repository automatically inherits default settings from the organization or user that owns it. You cannot override the default setting if the repository's owner has enforced the setting on all of their repositories. - -{% endtip %} +> [!NOTE] +> Each repository automatically inherits default settings from the organization or user that owns it. You cannot override the default setting if the repository's owner has enforced the setting on all of their repositories. diff --git a/data/reusables/enterprise_site_admin_settings/tls-downtime.md b/data/reusables/enterprise_site_admin_settings/tls-downtime.md index 06f181e15252..c5967a1edb8c 100644 --- a/data/reusables/enterprise_site_admin_settings/tls-downtime.md +++ b/data/reusables/enterprise_site_admin_settings/tls-downtime.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** Configuring TLS causes a small amount of downtime for {% data variables.location.product_location %}. - -{% endwarning %} +> [!WARNING] +> Configuring TLS causes a small amount of downtime for {% data variables.location.product_location %}. diff --git a/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md b/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md index 5df5c79dda86..9fdee101b1af 100644 --- a/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md +++ b/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md @@ -1,9 +1,4 @@ -{% warning %} - -**Warnings:** - -* The Git protocol is unauthenticated and unencrypted. An attacker could intercept repository data transferred over connections using this protocol. -* If you enable anonymous Git read access, you're responsible for all access and use of the feature. {% data variables.product.company_short %} is not responsible for any unintended access, security risks, or misuse of the feature. -* You may not use this feature to violate your license from {% data variables.product.company_short %}, including the limit on the number of user licenses for {% data variables.location.product_location %}. - -{% endwarning %} +> [!WARNING] +> * The Git protocol is unauthenticated and unencrypted. An attacker could intercept repository data transferred over connections using this protocol. +> * If you enable anonymous Git read access, you're responsible for all access and use of the feature. {% data variables.product.company_short %} is not responsible for any unintended access, security risks, or misuse of the feature. +> * You may not use this feature to violate your license from {% data variables.product.company_short %}, including the limit on the number of user licenses for {% data variables.location.product_location %}. diff --git a/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md b/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md index cec6eb93329e..324c5cc30b99 100644 --- a/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md +++ b/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md @@ -1,8 +1,4 @@ -{% note %} - -**Notes:** -* You cannot change the Git read access settings for forked repositories since they inherit their access settings from the root repository by default. -* If a public repository becomes private, then anonymous Git read access will automatically be disabled for that repository and it forks. -* If a repository with anonymous authentication contains {% data variables.large_files.product_name_short %} assets, it will fail to download the {% data variables.large_files.product_name_short %} assets since they still require authentication. We strongly recommend not enabling anonymous Git read access for a repository with {% data variables.large_files.product_name_short %} assets. - -{% endnote %} +> [!NOTE] +> * You cannot change the Git read access settings for forked repositories since they inherit their access settings from the root repository by default. +> * If a public repository becomes private, then anonymous Git read access will automatically be disabled for that repository and it forks. +> * If a repository with anonymous authentication contains {% data variables.large_files.product_name_short %} assets, it will fail to download the {% data variables.large_files.product_name_short %} assets since they still require authentication. We strongly recommend not enabling anonymous Git read access for a repository with {% data variables.large_files.product_name_short %} assets. diff --git a/data/reusables/gist/anonymous-gists-cannot-be-deleted.md b/data/reusables/gist/anonymous-gists-cannot-be-deleted.md index 08240b244823..ae171a60d3c9 100644 --- a/data/reusables/gist/anonymous-gists-cannot-be-deleted.md +++ b/data/reusables/gist/anonymous-gists-cannot-be-deleted.md @@ -1,7 +1,6 @@ {% ifversion ghes %} -{% warning %} -**Warning:** Anonymous gists cannot be deleted from the web browser. To have an anonymous gist deleted, contact {% data variables.contact.contact_support %}. Please provide the URL of the gist you wish to delete. +> [!WARNING] +> Anonymous gists cannot be deleted from the web browser. To have an anonymous gist deleted, contact {% data variables.contact.contact_support %}. Please provide the URL of the gist you wish to delete. -{% endwarning %} {% endif %} diff --git a/data/reusables/gpg/copy-ssh-public-key.md b/data/reusables/gpg/copy-ssh-public-key.md index d8259e9cc095..c833e24f942a 100644 --- a/data/reusables/gpg/copy-ssh-public-key.md +++ b/data/reusables/gpg/copy-ssh-public-key.md @@ -8,11 +8,9 @@ # Copies the contents of the id_ed25519.pub file to your clipboard ``` - {% tip %} + > [!TIP] + > If `pbcopy` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - **Tip:** If `pbcopy` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - {% endtip %} {% endmac %} {% windows %} @@ -21,19 +19,15 @@ # Copies the contents of the id_ed25519.pub file to your clipboard ``` - {% note %} - - **Notes:** - - * With Windows Subsystem for Linux (WSL), you can use `clip.exe`. Otherwise if `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - * On newer versions of Windows that use the {% data variables.product.prodname_windows_terminal %}, or anywhere else that uses the PowerShell command line, you may receive a `ParseError` stating that `The '<' operator is reserved for future use.` In this case, the following alternative `clip` command should be used: - - ```shell - $ cat ~/.ssh/id_ed25519.pub | clip - # Copies the contents of the id_ed25519.pub file to your clipboard - ``` + > [!NOTE] + > * With Windows Subsystem for Linux (WSL), you can use `clip.exe`. Otherwise if `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + > * On newer versions of Windows that use the {% data variables.product.prodname_windows_terminal %}, or anywhere else that uses the PowerShell command line, you may receive a `ParseError` stating that `The '<' operator is reserved for future use.` In this case, the following alternative `clip` command should be used: + > + > ```shell + > $ cat ~/.ssh/id_ed25519.pub | clip + > # Copies the contents of the id_ed25519.pub file to your clipboard + > ``` - {% endnote %} {% endwindows %} {% linux %} @@ -43,9 +37,7 @@ # displayed in the terminal to your clipboard ``` - {% tip %} - - **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + > [!TIP] + > Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - {% endtip %} {% endlinux %} diff --git a/data/reusables/gpg/desktop-support-for-commit-signing.md b/data/reusables/gpg/desktop-support-for-commit-signing.md index 5093127a3e08..429ffaf6dd49 100644 --- a/data/reusables/gpg/desktop-support-for-commit-signing.md +++ b/data/reusables/gpg/desktop-support-for-commit-signing.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** [GitHub Desktop](https://desktop.github.com/) only supports commit signing if your Git client is configured to sign commits by default. - -{% endnote %} +> [!NOTE] +> [GitHub Desktop](https://desktop.github.com/) only supports commit signing if your Git client is configured to sign commits by default. diff --git a/data/reusables/gpg/list-keys-with-note.md b/data/reusables/gpg/list-keys-with-note.md index 5d6a8ac343ca..ae59f152df63 100644 --- a/data/reusables/gpg/list-keys-with-note.md +++ b/data/reusables/gpg/list-keys-with-note.md @@ -4,8 +4,5 @@ gpg --list-secret-keys --keyid-format=long ``` - {% note %} - - **Note:** Some GPG installations on Linux may require you to use `gpg2 --list-keys --keyid-format LONG` to view a list of your existing keys instead. In this case you will also need to configure Git to use `gpg2` by running `git config --global gpg.program gpg2`. - - {% endnote %} + > [!NOTE] + > Some GPG installations on Linux may require you to use `gpg2 --list-keys --keyid-format LONG` to view a list of your existing keys instead. In this case you will also need to configure Git to use `gpg2` by running `git config --global gpg.program gpg2`. diff --git a/data/reusables/gpg/smime-git-version.md b/data/reusables/gpg/smime-git-version.md index 3e7c5a78b5b0..b49bb8a1dd70 100644 --- a/data/reusables/gpg/smime-git-version.md +++ b/data/reusables/gpg/smime-git-version.md @@ -1,6 +1,3 @@ -{% note %} - -**Note:** S/MIME signature verification is available in Git 2.19 or later. To update your version of Git, see the [Git](https://git-scm.com/downloads) website. - -{% endnote %} +> [!NOTE] +> S/MIME signature verification is available in Git 2.19 or later. To update your version of Git, see the [Git](https://git-scm.com/downloads) website. diff --git a/data/reusables/gpg/ssh-git-version.md b/data/reusables/gpg/ssh-git-version.md index 00395fab2938..3f0c3b34b6ae 100644 --- a/data/reusables/gpg/ssh-git-version.md +++ b/data/reusables/gpg/ssh-git-version.md @@ -1,6 +1,3 @@ -{% note %} - -**Note:** SSH signature verification is available in Git 2.34 or later. To update your version of Git, see the [Git](https://git-scm.com/downloads) website. - -{% endnote %} +> [!NOTE] +> SSH signature verification is available in Git 2.34 or later. To update your version of Git, see the [Git](https://git-scm.com/downloads) website. diff --git a/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md index 79039cec9da3..a9b99865fe57 100644 --- a/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md +++ b/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -1,13 +1,10 @@ After you create an IP allow list, you can enable allowed IP addresses. When you enable allowed IP addresses, {% data variables.product.company_short %} immediately enforces any enabled entries in your IP allow list. {% ifversion ghec %} -{% note %} -**Note:** +> [!NOTE] +> After you enable an IP allow list for your organization you won't be able to use {% data variables.product.prodname_github_codespaces %} for repositories owned by the organization. -After you enable an IP allow list for your organization you won't be able to use {% data variables.product.prodname_github_codespaces %} for repositories owned by the organization. - -{% endnote %} {% endif %} Before you enable your IP allow list, you can check whether your allow list will permit a connection from a particular IP address. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." diff --git a/data/reusables/identity-and-permissions/ip-address-add-or-remove-caching.md b/data/reusables/identity-and-permissions/ip-address-add-or-remove-caching.md index 268dc3af7463..e6604cb237db 100644 --- a/data/reusables/identity-and-permissions/ip-address-add-or-remove-caching.md +++ b/data/reusables/identity-and-permissions/ip-address-add-or-remove-caching.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Due to caching, adding or removing IP addresses can take a few minutes to fully take effect. - -{% endnote %} +> [!NOTE] +> Due to caching, adding or removing IP addresses can take a few minutes to fully take effect. diff --git a/data/reusables/identity-and-permissions/ip-allow-lists-githubapps-enterprise.md b/data/reusables/identity-and-permissions/ip-allow-lists-githubapps-enterprise.md index 43906c1975f9..35e16222db81 100644 --- a/data/reusables/identity-and-permissions/ip-allow-lists-githubapps-enterprise.md +++ b/data/reusables/identity-and-permissions/ip-allow-lists-githubapps-enterprise.md @@ -13,9 +13,7 @@ To enable automatic addition of IP addresses for {% data variables.product.prodn {% data reusables.enterprise-accounts.security-tab %} 1. Under "IP allow list", select **Enable IP allow list configuration for installed GitHub Apps**. - {% note %} + > [!NOTE] + > If you're using {% data variables.product.prodname_emus %} with OIDC, you can only allow access by GitHub Apps if you use {% data variables.product.prodname_dotcom %} for your IP allow list configuration. - **Note:** If you're using {% data variables.product.prodname_emus %} with OIDC, you can only allow access by GitHub Apps if you use {% data variables.product.prodname_dotcom %} for your IP allow list configuration. - - {% endnote %} 1. Click **Save**. diff --git a/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/data/reusables/identity-and-permissions/ipv6-allow-lists.md index c5f600ba8da5..92b3a8f6f16d 100644 --- a/data/reusables/identity-and-permissions/ipv6-allow-lists.md +++ b/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -1,7 +1,6 @@ {% ifversion fpt or ghec %} -{% note %} -**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. +> [!NOTE] +> {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. -{% endnote %} {% endif %} diff --git a/data/reusables/identity-and-permissions/revoking-identity-team-sync.md b/data/reusables/identity-and-permissions/revoking-identity-team-sync.md index 13567c139fad..2d7cfcfb8039 100644 --- a/data/reusables/identity-and-permissions/revoking-identity-team-sync.md +++ b/data/reusables/identity-and-permissions/revoking-identity-team-sync.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** If your organization uses team synchronization, revoking a person's SSO identity will remove that person from any teams mapped to IdP groups. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." - -{% endwarning %} +> [!WARNING] +> If your organization uses team synchronization, revoking a person's SSO identity will remove that person from any teams mapped to IdP groups. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)." diff --git a/data/reusables/identity-and-permissions/team-sync-disable.md b/data/reusables/identity-and-permissions/team-sync-disable.md index bae468826d88..49508095bdfa 100644 --- a/data/reusables/identity-and-permissions/team-sync-disable.md +++ b/data/reusables/identity-and-permissions/team-sync-disable.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** When you disable team synchronization, any team members that were assigned to a {% data variables.product.prodname_dotcom %} team through the IdP group are removed from the team and may lose access to repositories. - -{% endwarning %} +> [!WARNING] +> When you disable team synchronization, any team members that were assigned to a {% data variables.product.prodname_dotcom %} team through the IdP group are removed from the team and may lose access to repositories. diff --git a/data/reusables/marketplace/confirm-install-account-org.md b/data/reusables/marketplace/confirm-install-account-org.md index d330981ee132..eeab7b345c36 100644 --- a/data/reusables/marketplace/confirm-install-account-org.md +++ b/data/reusables/marketplace/confirm-install-account-org.md @@ -9,9 +9,8 @@ ![Screenshot of the {% data variables.product.prodname_marketplace %} app purchase screen. A collapsed gray dropdown menu labeled "Account" is outlined in dark orange.](/assets/images/help/marketplace/marketplace-confirm-org-no-org-details.png) {% ifversion ghec %} - {% note %} - **Note**: {% data reusables.apps.github_app_install_saml %} + > [!NOTE] + > {% data reusables.apps.github_app_install_saml %} - {% endnote %} {% endif %} diff --git a/data/reusables/marketplace/free-plan-note.md b/data/reusables/marketplace/free-plan-note.md index bf63caa53df4..9afe0ff4c992 100644 --- a/data/reusables/marketplace/free-plan-note.md +++ b/data/reusables/marketplace/free-plan-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If you're listing an app on {% data variables.product.prodname_marketplace %}, you can't list your app with a free pricing plan if you offer a paid service outside of {% data variables.product.prodname_marketplace %}. - -{% endnote %} +> [!NOTE] +> If you're listing an app on {% data variables.product.prodname_marketplace %}, you can't list your app with a free pricing plan if you offer a paid service outside of {% data variables.product.prodname_marketplace %}. diff --git a/data/reusables/marketplace/marketplace-apps-not-actions.md b/data/reusables/marketplace/marketplace-apps-not-actions.md index 234d878b1f99..930f59c0f7bf 100644 --- a/data/reusables/marketplace/marketplace-apps-not-actions.md +++ b/data/reusables/marketplace/marketplace-apps-not-actions.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** This article applies to publishing apps in {% data variables.product.prodname_marketplace %} only. For more information about publishing {% data variables.product.prodname_actions %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)." - -{% endnote %} +> [!NOTE] +> This article applies to publishing apps in {% data variables.product.prodname_marketplace %} only. For more information about publishing {% data variables.product.prodname_actions %} in {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)." diff --git a/data/reusables/marketplace/marketplace-apps-only.md b/data/reusables/marketplace/marketplace-apps-only.md index d7ecaca68263..4b4227f9e9c3 100644 --- a/data/reusables/marketplace/marketplace-apps-only.md +++ b/data/reusables/marketplace/marketplace-apps-only.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** This article applies to installing and purchasing apps from {% data variables.product.prodname_marketplace %} only. For more information on apps purchased from integrators, see "[AUTOTITLE](/get-started/exploring-integrations/about-integrations)." - -{% endnote %} +> [!NOTE] +> This article applies to installing and purchasing apps from {% data variables.product.prodname_marketplace %} only. For more information on apps purchased from integrators, see "[AUTOTITLE](/get-started/exploring-integrations/about-integrations)." diff --git a/data/reusables/marketplace/marketplace-double-purchases.md b/data/reusables/marketplace/marketplace-double-purchases.md index 0417dd94e750..9681ac605f56 100644 --- a/data/reusables/marketplace/marketplace-double-purchases.md +++ b/data/reusables/marketplace/marketplace-double-purchases.md @@ -1,5 +1,2 @@ -{% warning %} - -**Note:** In the current version of {% data variables.product.prodname_marketplace %}, it's possible for a customer to purchase your app through {% data variables.product.prodname_marketplace %} when they already have an existing account purchased from your app's website. If you find that you already have an account set up for the customer who purchased your app, please report the "double" purchases to [GitHub Support](https://github.com/contact). - -{% endwarning %} +> [!NOTE] +> In the current version of {% data variables.product.prodname_marketplace %}, it's possible for a customer to purchase your app through {% data variables.product.prodname_marketplace %} when they already have an existing account purchased from your app's website. If you find that you already have an account set up for the customer who purchased your app, please report the "double" purchases to [GitHub Support](https://github.com/contact). diff --git a/data/reusables/marketplace/marketplace-enterprise-account.md b/data/reusables/marketplace/marketplace-enterprise-account.md index f3ed63095241..2ec86eb80eec 100644 --- a/data/reusables/marketplace/marketplace-enterprise-account.md +++ b/data/reusables/marketplace/marketplace-enterprise-account.md @@ -1,7 +1,4 @@ -{% note %} - -**Note:** To use a {% data variables.product.prodname_marketplace %} app, you must install the app on an organization account within your enterprise. For more information, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)." - -You cannot purchase or manage paid {% data variables.product.prodname_marketplace %} apps if your enterprise account is invoiced. Organizations belonging to an enterprise can view and use {% data variables.product.prodname_marketplace %} apps from their billing settings, but you can only purchase or manage apps through your enterprise account. Only enterprise owners who are also organization owners can purchase {% data variables.product.prodname_marketplace %} apps. - -{% endnote %} +> [!NOTE] +> To use a {% data variables.product.prodname_marketplace %} app, you must install the app on an organization account within your enterprise. For more information, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)." +> +> You cannot purchase or manage paid {% data variables.product.prodname_marketplace %} apps if your enterprise account is invoiced. Organizations belonging to an enterprise can view and use {% data variables.product.prodname_marketplace %} apps from their billing settings, but you can only purchase or manage apps through your enterprise account. Only enterprise owners who are also organization owners can purchase {% data variables.product.prodname_marketplace %} apps. diff --git a/data/reusables/marketplace/marketplace-malicious-behavior.md b/data/reusables/marketplace/marketplace-malicious-behavior.md index 3c0cf8992084..08dfcd1032fa 100644 --- a/data/reusables/marketplace/marketplace-malicious-behavior.md +++ b/data/reusables/marketplace/marketplace-malicious-behavior.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If you notice any spammy {% data variables.product.prodname_marketplace %} purchases or other malicious behavior, please complete the [report abuse](https://github.com/contact/report-abuse) form with more information on the user. - -{% endnote %} +> [!NOTE] +> If you notice any spammy {% data variables.product.prodname_marketplace %} purchases or other malicious behavior, please complete the [report abuse](https://github.com/contact/report-abuse) form with more information on the user. diff --git a/data/reusables/marketplace/marketplace-org-perms.md b/data/reusables/marketplace/marketplace-org-perms.md index c3c0bd69a8b2..95c1d577f9d0 100644 --- a/data/reusables/marketplace/marketplace-org-perms.md +++ b/data/reusables/marketplace/marketplace-org-perms.md @@ -1,5 +1,2 @@ -{% tip %} - - **Tip**: If an app requires organization-level access, then only an organization owner can purchase, install, or cancel the app, and manage app billing for the organization. If the app doesn't require organization-level access, then a repository administrator can install and uninstall the app. - -{% endtip %} +> [!TIP] +> If an app requires organization-level access, then only an organization owner can purchase, install, or cancel the app, and manage app billing for the organization. If the app doesn't require organization-level access, then a repository administrator can install and uninstall the app. diff --git a/data/reusables/notifications/outbound_email_tip.md b/data/reusables/notifications/outbound_email_tip.md index b8f39b8511a2..0ad3178fe40a 100644 --- a/data/reusables/notifications/outbound_email_tip.md +++ b/data/reusables/notifications/outbound_email_tip.md @@ -1,7 +1,6 @@ {% ifversion ghes %} -{% note %} -**Note**: You'll only receive email notifications if outbound email support is enabled on {% data variables.location.product_location %}. For more information, contact your site administrator. +> [!NOTE] +> You'll only receive email notifications if outbound email support is enabled on {% data variables.location.product_location %}. For more information, contact your site administrator. -{% endnote %} {% endif %} diff --git a/data/reusables/notifications/shared_state.md b/data/reusables/notifications/shared_state.md index e39e0753bdd2..0af38705ab1a 100644 --- a/data/reusables/notifications/shared_state.md +++ b/data/reusables/notifications/shared_state.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip:** If you receive both web and email notifications, you can automatically sync the read or unread status of the notification so that web notifications are automatically marked as read once you've read the corresponding email notification. To enable this sync, your email client must be able to view images from {% ifversion fpt or ghec %}`notifications@github.com`{% else %}the `no-reply` email address {% ifversion ghes %}for {% data variables.location.product_location %}, which your site administrator configures{% endif %}{% endif %}. - -{% endtip %} +> [!TIP] +> If you receive both web and email notifications, you can automatically sync the read or unread status of the notification so that web notifications are automatically marked as read once you've read the corresponding email notification. To enable this sync, your email client must be able to view images from {% ifversion fpt or ghec %}`notifications@github.com`{% else %}the `no-reply` email address {% ifversion ghes %}for {% data variables.location.product_location %}, which your site administrator configures{% endif %}{% endif %}. diff --git a/data/reusables/notifications/vulnerable-dependency-notification-options.md b/data/reusables/notifications/vulnerable-dependency-notification-options.md index 3c42b8de0ae4..c0bbb958275b 100644 --- a/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -5,17 +5,12 @@ * On the command line. Warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**CLI** option). * On {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#enabling-push-notifications-with-github-mobile)." -{% note %} - -**Note:** The email and web/{% data variables.product.prodname_mobile %} notifications are: - -* _Per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. - -* _Per organization_ when a new vulnerability is discovered. - -* Sent when a new vulnerability is discovered. {% data variables.product.prodname_dotcom %} doesn't send notifications when vulnerabilities are updated. - -{% endnote %} +> [!NOTE] +> The email and web/{% data variables.product.prodname_mobile %} notifications are: +> +> * _Per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. +> * _Per organization_ when a new vulnerability is discovered. +> * Sent when a new vulnerability is discovered. {% data variables.product.prodname_dotcom %} doesn't send notifications when vulnerabilities are updated. {% ifversion update-notification-settings-22 %} You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a daily or weekly digest email summarizing alerts for up to 10 of your repositories using the **Email weekly digest** option. diff --git a/data/reusables/organizations/custom-repo-roles-ghec-only.md b/data/reusables/organizations/custom-repo-roles-ghec-only.md index 92269d71e1a6..8a52ad40e135 100644 --- a/data/reusables/organizations/custom-repo-roles-ghec-only.md +++ b/data/reusables/organizations/custom-repo-roles-ghec-only.md @@ -1,7 +1,6 @@ {% ifversion ghec %} -{% note %} -**Note:** Only organizations that use {% data variables.product.prodname_ghe_cloud %} can create custom repository roles.{% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> Only organizations that use {% data variables.product.prodname_ghe_cloud %} can create custom repository roles.{% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} diff --git a/data/reusables/organizations/data_saved_for_reinstating_a_former_org_member.md b/data/reusables/organizations/data_saved_for_reinstating_a_former_org_member.md index 82a023cc5b50..97e74e215c40 100644 --- a/data/reusables/organizations/data_saved_for_reinstating_a_former_org_member.md +++ b/data/reusables/organizations/data_saved_for_reinstating_a_former_org_member.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** When you remove a user from your organization, their membership data is saved for three months. You can restore their data, or any private forks they owned of your organization's repositories, if you invite the user to rejoin the organization within that time frame. For more information, see "[AUTOTITLE](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." - -{% endnote %} +> [!NOTE] +> When you remove a user from your organization, their membership data is saved for three months. You can restore their data, or any private forks they owned of your organization's repositories, if you invite the user to rejoin the organization within that time frame. For more information, see "[AUTOTITLE](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." diff --git a/data/reusables/organizations/follow-organizations-beta.md b/data/reusables/organizations/follow-organizations-beta.md index ac2a895d9a02..1858fbaf2528 100644 --- a/data/reusables/organizations/follow-organizations-beta.md +++ b/data/reusables/organizations/follow-organizations-beta.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** The ability to follow organizations is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The ability to follow organizations is currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/organizations/organization-rulesets-targeting-repositories-step.md b/data/reusables/organizations/organization-rulesets-targeting-repositories-step.md index 3d28bca78478..4807dc9725be 100644 --- a/data/reusables/organizations/organization-rulesets-targeting-repositories-step.md +++ b/data/reusables/organizations/organization-rulesets-targeting-repositories-step.md @@ -18,11 +18,8 @@ To target all repositories in your organization, in the "Target repositories" se 1. To begin defining a targeting pattern, in the "Targeting criteria" section, select **Add a target** {% octicon "triangle-down" aria-hidden="true" %}, then click **Include by pattern** or **Exclude by pattern**. 1. In the modal dialog that appears, enter a repository naming pattern using `fnmatch` syntax, then click **Add Inclusion pattern** or **Add Exclusion pattern**. For more information on `fnmatch` syntax, see "[Using `fnmatch` syntax](#using-fnmatch-syntax)." - {% note %} - - **Note:** You can add multiple targeting criteria to the same ruleset. For example, you could include any repositories matching the pattern `*cat*`, then specifically exclude a repository matching the pattern `not-a-cat`. - - {% endnote %} + > [!NOTE] + > You can add multiple targeting criteria to the same ruleset. For example, you could include any repositories matching the pattern `*cat*`, then specifically exclude a repository matching the pattern `not-a-cat`. 1. Optionally, on the ruleset configuration page, select **Prevent renaming of target repositories**. diff --git a/data/reusables/organizations/require-ssh-cert.md b/data/reusables/organizations/require-ssh-cert.md index 76650012da08..612a2c9ac92e 100644 --- a/data/reusables/organizations/require-ssh-cert.md +++ b/data/reusables/organizations/require-ssh-cert.md @@ -1,9 +1,6 @@ 1. Optionally, to require members to use SSH certificates, select **Require SSH Certificates**, then click **Save**. - {% note %} - - **Note:** When you require SSH certificates, users will not be able to authenticate to access the organization's repositories over HTTPS or with an unsigned SSH key{% ifversion ghes %}.{% elsif ghec %}, regardless of whether the SSH key is authorized for an organization that requires authentication through an external identity system.{% endif %} - - The requirement does not apply to authorized {% data variables.product.prodname_github_apps %} {% ifversion ssh-cert-policy-allow-u2s-tokens %}(including user-to-server tokens){% endif %}, deploy keys, or to {% data variables.product.prodname_dotcom %} features such as {% data variables.product.prodname_actions %}{% ifversion fpt or ghec %} and {% data variables.product.prodname_codespaces %}{% endif %}, which are trusted environments within the {% data variables.product.prodname_dotcom %} ecosystem. - - {% endnote %} + > [!NOTE] + > When you require SSH certificates, users will not be able to authenticate to access the organization's repositories over HTTPS or with an unsigned SSH key{% ifversion ghes %}.{% elsif ghec %}, regardless of whether the SSH key is authorized for an organization that requires authentication through an external identity system.{% endif %} + > + > The requirement does not apply to authorized {% data variables.product.prodname_github_apps %} {% ifversion ssh-cert-policy-allow-u2s-tokens %}(including user-to-server tokens){% endif %}, deploy keys, or to {% data variables.product.prodname_dotcom %} features such as {% data variables.product.prodname_actions %}{% ifversion fpt or ghec %} and {% data variables.product.prodname_codespaces %}{% endif %}, which are trusted environments within the {% data variables.product.prodname_dotcom %} ecosystem. diff --git a/data/reusables/organizations/security-manager-beta-note.md b/data/reusables/organizations/security-manager-beta-note.md index 9a12f034f15e..3051050b714f 100644 --- a/data/reusables/organizations/security-manager-beta-note.md +++ b/data/reusables/organizations/security-manager-beta-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** The security manager role is in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The security manager role is in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/organizations/ssh-ca-ghec-only.md b/data/reusables/organizations/ssh-ca-ghec-only.md index 8f47e4f3b703..c419018d4583 100644 --- a/data/reusables/organizations/ssh-ca-ghec-only.md +++ b/data/reusables/organizations/ssh-ca-ghec-only.md @@ -1,7 +1,6 @@ {% ifversion fpt or ghec %} -{% note %} -**Note:** To use SSH certificate authorities, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> To use SSH certificate authorities, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} diff --git a/data/reusables/organizations/team-discussions-deprecation.md b/data/reusables/organizations/team-discussions-deprecation.md index 521e46b62c09..2219cfec17f1 100644 --- a/data/reusables/organizations/team-discussions-deprecation.md +++ b/data/reusables/organizations/team-discussions-deprecation.md @@ -1,21 +1,15 @@ {% ifversion ghec or fpt %} -{% note %} - -**Note**: Team Discussions are {% data variables.release-phases.retired %}. You can read more about this on the [GitHub Blog](https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/). - -You can use {% data variables.product.prodname_discussions %} to create organization-level discussions. For more information about {% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions)." - -{% endnote %} +> [!NOTE] +> Team Discussions are {% data variables.release-phases.retired %}. You can read more about this on the [GitHub Blog](https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/). +> +> You can use {% data variables.product.prodname_discussions %} to create organization-level discussions. For more information about {% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions)." {% elsif ghes %} -{% note %} - -**Note**: Team Discussions are now {% data variables.release-phases.retired %}. You can read more about this on the [GitHub Blog](https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/). - -You can use {% data variables.product.prodname_discussions %} to create organization-level discussions. For more information about{% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions)." - -{% endnote %} +> [!NOTE] +> Team Discussions are now {% data variables.release-phases.retired %}. You can read more about this on the [GitHub Blog](https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/). +> +> You can use {% data variables.product.prodname_discussions %} to create organization-level discussions. For more information about{% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions)." {% endif %} diff --git a/data/reusables/organizations/team-discussions-migration.md b/data/reusables/organizations/team-discussions-migration.md index a4dd7dca57d6..dc4ccd90647a 100644 --- a/data/reusables/organizations/team-discussions-migration.md +++ b/data/reusables/organizations/team-discussions-migration.md @@ -1,8 +1,5 @@ -{% note %} - -**Note**: Team discussions are {% data variables.release-phases.closing_down %} in {% data variables.product.prodname_ghe_server %} 3.13 in favor of {% data variables.product.prodname_discussions %}. You can transfer your existing team discussions to a repository's discussions by using a migration tool that allows team admins to migrate both public and private team discussions. Click the "Transfer" button in the banner at the top of your team discussions page, then choose the repository in your organization that you want to migrate the discussions to. - -For more information about {% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions)." - -{% endnote %} +> [!NOTE] +> Team discussions are {% data variables.release-phases.closing_down %} in {% data variables.product.prodname_ghe_server %} 3.13 in favor of {% data variables.product.prodname_discussions %}. You can transfer your existing team discussions to a repository's discussions by using a migration tool that allows team admins to migrate both public and private team discussions. Click the "Transfer" button in the banner at the top of your team discussions page, then choose the repository in your organization that you want to migrate the discussions to. +> +> For more information about {% data variables.product.prodname_discussions %}, see "[AUTOTITLE](/discussions)." diff --git a/data/reusables/organizations/team-notifications.md b/data/reusables/organizations/team-notifications.md index c025cd2f5afc..197dd310fa28 100644 --- a/data/reusables/organizations/team-notifications.md +++ b/data/reusables/organizations/team-notifications.md @@ -1,7 +1,4 @@ 1. Under "Team notifications", select **Enabled** or **Disabled**. - {% note %} - - **Note:** This setting only applies to @mentions of the team name. This setting does not affect notifications for reviews requested from the team. - - {% endnote %} + > [!NOTE] + > This setting only applies to @mentions of the team name. This setting does not affect notifications for reviews requested from the team. diff --git a/data/reusables/package_registry/admins-can-configure-package-types.md b/data/reusables/package_registry/admins-can-configure-package-types.md index 768f2d35cb21..3921c20a035c 100644 --- a/data/reusables/package_registry/admins-can-configure-package-types.md +++ b/data/reusables/package_registry/admins-can-configure-package-types.md @@ -1,7 +1,6 @@ {% ifversion ghes %} -{% note %} -**Note:** This package type may not be available for your instance, because site administrators can enable or disable each supported package type. For more information, see "[AUTOTITLE](/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." +> [!NOTE] +> This package type may not be available for your instance, because site administrators can enable or disable each supported package type. For more information, see "[AUTOTITLE](/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." -{% endnote %} {% endif %} 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 c3dffc197802..63dfa8547049 100644 --- a/data/reusables/package_registry/authenticate-to-container-registry-steps.md +++ b/data/reusables/package_registry/authenticate-to-container-registry-steps.md @@ -1,11 +1,9 @@ {% data reusables.package_registry.packages-classic-pat-only %} 1. Create a new {% data variables.product.pat_v1 %} with the appropriate scopes for the tasks you want to accomplish. If your organization requires SSO, you must enable SSO for your new token. - {% warning %} - **Note:** By default, when you select the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface, the `repo` scope will also be selected. The `repo` scope offers unnecessary and broad access, which we recommend you avoid using for {% data variables.product.prodname_actions %} workflows in particular. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#considering-cross-repository-access)." As a workaround, you can select just the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface with this url: `https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/settings/tokens/new?scopes=write:packages`. - - {% endwarning %} + > [!NOTE] + > By default, when you select the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface, the `repo` scope will also be selected. The `repo` scope offers unnecessary and broad access, which we recommend you avoid using for {% data variables.product.prodname_actions %} workflows in particular. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#considering-cross-repository-access)." As a workaround, you can select just the `write:packages` scope for your {% data variables.product.pat_v1 %} in the user interface with this url: `https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/settings/tokens/new?scopes=write:packages`. * Select the `read:packages` scope to download container images and read their metadata. * Select the `write:packages` scope to download and upload container images and read and write their metadata. diff --git a/data/reusables/package_registry/auto-inherit-permissions-note.md b/data/reusables/package_registry/auto-inherit-permissions-note.md index b64667a6e0b8..0765c33c07e1 100644 --- a/data/reusables/package_registry/auto-inherit-permissions-note.md +++ b/data/reusables/package_registry/auto-inherit-permissions-note.md @@ -1,9 +1,6 @@ {% ifversion packages-inherit-permissions %} -{% note %} - -**Note:** If you publish a package that is linked to a repository, the package automatically inherits the access permissions of the linked repository, and {% data variables.product.prodname_actions %} workflows in the linked repository automatically get access to the package, unless your organization has disabled automatic inheritance of access permissions. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#about-inheritance-of-access-permissions)." - -{% endnote %} +> [!NOTE] +> If you publish a package that is linked to a repository, the package automatically inherits the access permissions of the linked repository, and {% data variables.product.prodname_actions %} workflows in the linked repository automatically get access to the package, unless your organization has disabled automatic inheritance of access permissions. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#about-inheritance-of-access-permissions)." {% endif %} diff --git a/data/reusables/package_registry/delete-with-github-token-using-api-beta.md b/data/reusables/package_registry/delete-with-github-token-using-api-beta.md index 53dd649bed28..9ce4e35ecdd5 100644 --- a/data/reusables/package_registry/delete-with-github-token-using-api-beta.md +++ b/data/reusables/package_registry/delete-with-github-token-using-api-beta.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** The ability for {% data variables.product.prodname_actions %} workflows to delete and restore packages using the REST API is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The ability for {% data variables.product.prodname_actions %} workflows to delete and restore packages using the REST API is currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/package_registry/disable-auto-inheritance-step.md b/data/reusables/package_registry/disable-auto-inheritance-step.md index 3e2dc526e976..f56765cdd0d7 100644 --- a/data/reusables/package_registry/disable-auto-inheritance-step.md +++ b/data/reusables/package_registry/disable-auto-inheritance-step.md @@ -1,7 +1,4 @@ 1. To choose whether a package inherits access permissions from the linked repository, under "Manage access" or "Inherited access", select or deselect **Inherit access from repository (recommended)**. - {% note %} - - **Note:** The name of this section changes depending on whether the package already inherits its permissions from a repository. - - {% endnote %} + > [!NOTE] + > The name of this section changes depending on whether the package already inherits its permissions from a repository. diff --git a/data/reusables/package_registry/docker_registry_deprecation_status.md b/data/reusables/package_registry/docker_registry_deprecation_status.md index df327c3f2469..068ee874ac1d 100644 --- a/data/reusables/package_registry/docker_registry_deprecation_status.md +++ b/data/reusables/package_registry/docker_registry_deprecation_status.md @@ -1,5 +1,2 @@ -{% warning %} - -**Note:** The {% data variables.product.prodname_registry %} Docker registry {% ifversion ghes %} will be superseded in a future {% data variables.product.product_name %} release with the {% data variables.product.prodname_container_registry %}, which offers improved container support.{% elsif fpt %} is superseded by the {% data variables.product.prodname_container_registry %}, which offers improved container support. {% endif %} {% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)." {% endif %} - -{% endwarning %} +> [!NOTE] +> The {% data variables.product.prodname_registry %} Docker registry {% ifversion ghes %} will be superseded in a future {% data variables.product.product_name %} release with the {% data variables.product.prodname_container_registry %}, which offers improved container support.{% elsif fpt %} is superseded by the {% data variables.product.prodname_container_registry %}, which offers improved container support. {% endif %} {% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)." {% endif %} diff --git a/data/reusables/package_registry/packages-cluster-support.md b/data/reusables/package_registry/packages-cluster-support.md index 02855ece5850..d223cdb5790f 100644 --- a/data/reusables/package_registry/packages-cluster-support.md +++ b/data/reusables/package_registry/packages-cluster-support.md @@ -1,7 +1,6 @@ {% ifversion ghes %} -{% note %} -**Note:** {% data variables.product.prodname_registry %} on {% data variables.product.product_name %} does not currently support clustering. +> [!NOTE] +> {% data variables.product.prodname_registry %} on {% data variables.product.product_name %} does not currently support clustering. -{% endnote %} {% endif %} diff --git a/data/reusables/package_registry/publish-docker-image.md b/data/reusables/package_registry/publish-docker-image.md index 19f92eb5d01f..db5956f53b56 100644 --- a/data/reusables/package_registry/publish-docker-image.md +++ b/data/reusables/package_registry/publish-docker-image.md @@ -1,11 +1,6 @@ -{% note %} - -**Notes:** - -* {% data reusables.actions.actions-not-certified-by-github %} -* {% data reusables.actions.actions-use-sha-pinning %} - -{% endnote %} +> [!NOTE] +> * {% data reusables.actions.actions-not-certified-by-github %} +> * {% data reusables.actions.actions-use-sha-pinning %} ```yaml annotate copy # diff --git a/data/reusables/package_registry/visibility-and-access-permissions.md b/data/reusables/package_registry/visibility-and-access-permissions.md index 8832040f926b..c9621ccf36d2 100644 --- a/data/reusables/package_registry/visibility-and-access-permissions.md +++ b/data/reusables/package_registry/visibility-and-access-permissions.md @@ -3,11 +3,10 @@ If a package belongs to a registry that supports granular permissions, anyone wi In most registries, to pull a package, you must authenticate with a {% data variables.product.pat_generic %} or `GITHUB_TOKEN`, regardless of whether the package is public or private. However, in the {% data variables.product.prodname_container_registry %}, public packages allow anonymous access and can be pulled without authentication or signing in via the CLI. {% ifversion packages-inherit-permissions %} -{% note %} -**Note:** If you publish a package that is linked to a repository, the package inherits its permissions from the linked repository by default. To access the package's granular permissions settings, you must remove the package's inherited permissions. If you're the owner of an organization, you can disable the automatic inheritance of permissions for all new packages scoped to your organization. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#selecting-whether-a-package-inherits-permissions-from-a-repository)" and "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#disabling-automatic-inheritance-of-access-permissions-in-an-organization)." +> [!NOTE] +> If you publish a package that is linked to a repository, the package inherits its permissions from the linked repository by default. To access the package's granular permissions settings, you must remove the package's inherited permissions. If you're the owner of an organization, you can disable the automatic inheritance of permissions for all new packages scoped to your organization. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#selecting-whether-a-package-inherits-permissions-from-a-repository)" and "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#disabling-automatic-inheritance-of-access-permissions-in-an-organization)." -{% endnote %} {% endif %} When you publish a package, you automatically get admin permissions to the package. If you publish a package to an organization, anyone with the `owner` role in the organization also gets admin permissions to the package. diff --git a/data/reusables/pages/admin-must-push.md b/data/reusables/pages/admin-must-push.md index 4f8ab0c022ba..0c35977f1043 100644 --- a/data/reusables/pages/admin-must-push.md +++ b/data/reusables/pages/admin-must-push.md @@ -1,9 +1,3 @@ -{% note %} - -**Notes**: - -* {% ifversion pages-custom-workflow %}If you are publishing from a branch and{% else %}If{% endif %} your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source. - -* {% data reusables.actions.actions-do-not-trigger-pages-rebuilds %} - -{% endnote %} +> [!NOTE] +> * {% ifversion pages-custom-workflow %}If you are publishing from a branch and{% else %}If{% endif %} your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source. +> * {% data reusables.actions.actions-do-not-trigger-pages-rebuilds %} diff --git a/data/reusables/pages/check-workflow-run.md b/data/reusables/pages/check-workflow-run.md index 57b74167ed52..038c5e281062 100644 --- a/data/reusables/pages/check-workflow-run.md +++ b/data/reusables/pages/check-workflow-run.md @@ -1,10 +1,7 @@ {% ifversion build-pages-with-actions %} 1. Your {% data variables.product.prodname_pages %} site is built and deployed with a {% data variables.product.prodname_actions %} workflow. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)". - {% note %} - - **Note:** {% data variables.product.prodname_actions %} is free for public repositories. Usage charges apply for private and internal repositories that go beyond the monthly allotment of free minutes. For more information, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration)". - - {% endnote %} + > [!NOTE] + > {% data variables.product.prodname_actions %} is free for public repositories. Usage charges apply for private and internal repositories that go beyond the monthly allotment of free minutes. For more information, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration)". {% endif %} diff --git a/data/reusables/pages/custom-domain-warning.md b/data/reusables/pages/custom-domain-warning.md index dbc31b724fac..80c22b7d3ee1 100644 --- a/data/reusables/pages/custom-domain-warning.md +++ b/data/reusables/pages/custom-domain-warning.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip:** We recommend verifying your custom domain prior to adding it to your repository, in order to improve security and avoid takeover attacks. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)." - -{% endtip %} +> [!TIP] +> We recommend verifying your custom domain prior to adding it to your repository, in order to improve security and avoid takeover attacks. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)." diff --git a/data/reusables/pages/emu-org-only.md b/data/reusables/pages/emu-org-only.md index 547d6044ae3f..d5139dd2b071 100644 --- a/data/reusables/pages/emu-org-only.md +++ b/data/reusables/pages/emu-org-only.md @@ -1,7 +1,6 @@ {% ifversion ghec %} -{% note %} -**Note:** If you're a {% data variables.enterprise.prodname_managed_user %}, you can only publish {% data variables.product.prodname_pages %} sites from repositories owned by organizations. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages#limitations-for-enterprise-managed-users)." +> [!NOTE] +> If you're a {% data variables.enterprise.prodname_managed_user %}, you can only publish {% data variables.product.prodname_pages %} sites from repositories owned by organizations. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages#limitations-for-enterprise-managed-users)." -{% endnote %} {% endif %} diff --git a/data/reusables/pages/jekyll-install-troubleshooting.md b/data/reusables/pages/jekyll-install-troubleshooting.md index ef89285b375d..8214364c261b 100644 --- a/data/reusables/pages/jekyll-install-troubleshooting.md +++ b/data/reusables/pages/jekyll-install-troubleshooting.md @@ -1,9 +1,6 @@ {% mac %} -{% tip %} - -**Tip:** If you see a Ruby error when you try to install Jekyll using Bundler, you may need to use a package manager, such as [RVM](https://rvm.io/) or [Homebrew](https://brew.sh/), to manage your Ruby installation. For more information, see "[Troubleshooting](https://jekyllrb.com/docs/troubleshooting/#jekyll--macos)" in the Jekyll documentation. - -{% endtip %} +> [!TIP] +> If you see a Ruby error when you try to install Jekyll using Bundler, you may need to use a package manager, such as [RVM](https://rvm.io/) or [Homebrew](https://brew.sh/), to manage your Ruby installation. For more information, see "[Troubleshooting](https://jekyllrb.com/docs/troubleshooting/#jekyll--macos)" in the Jekyll documentation. {% endmac %} diff --git a/data/reusables/pages/org-owners-can-restrict-pages-creation.md b/data/reusables/pages/org-owners-can-restrict-pages-creation.md index 7ab66c341c24..5bb1b8caf8e3 100644 --- a/data/reusables/pages/org-owners-can-restrict-pages-creation.md +++ b/data/reusables/pages/org-owners-can-restrict-pages-creation.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Organization owners can restrict the publication of {% data variables.product.prodname_pages %} sites from repositories owned by the organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." - -{% endnote %} +> [!NOTE] +> Organization owners can restrict the publication of {% data variables.product.prodname_pages %} sites from repositories owned by the organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." diff --git a/data/reusables/pages/private_pages_are_public_warning.md b/data/reusables/pages/private_pages_are_public_warning.md index fb37f4fcfe63..071bbff6bea5 100644 --- a/data/reusables/pages/private_pages_are_public_warning.md +++ b/data/reusables/pages/private_pages_are_public_warning.md @@ -1,11 +1,8 @@ -{% warning %} - +> [!WARNING] {% ifversion fpt %} -**Warning**: {% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private (if your plan or organization allows it). If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +> {% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private (if your plan or organization allows it). If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." {% elsif ghec %} -**Warning**: Unless your enterprise uses {% data variables.product.prodname_emus %}, {% data variables.product.prodname_pages %} sites are publicly available on the internet by default, even if the repository for the site is private or internal. You can publish a site privately by managing access control for the site. Otherwise, if you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" and "[AUTOTITLE](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." +> Unless your enterprise uses {% data variables.product.prodname_emus %}, {% data variables.product.prodname_pages %} sites are publicly available on the internet by default, even if the repository for the site is private or internal. You can publish a site privately by managing access control for the site. Otherwise, if you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)" and "[AUTOTITLE](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." {% elsif ghes %} -**Warning**: If your site administrator has enabled Public Pages, {% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private or internal. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +> If your site administrator has enabled Public Pages, {% data variables.product.prodname_pages %} sites are publicly available on the internet, even if the repository for the site is private or internal. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise#enabling-public-sites-for-github-pages)" and "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." {% endif %} - -{% endwarning %} diff --git a/data/reusables/pages/privately-publish-ghec-only.md b/data/reusables/pages/privately-publish-ghec-only.md index dca0839282ea..98cd6a085fb3 100644 --- a/data/reusables/pages/privately-publish-ghec-only.md +++ b/data/reusables/pages/privately-publish-ghec-only.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** To publish a {% data variables.product.prodname_pages %} site privately, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} - -{% endnote %} +> [!NOTE] +> To publish a {% data variables.product.prodname_pages %} site privately, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} diff --git a/data/reusables/pages/symlink-removal.md b/data/reusables/pages/symlink-removal.md index 3db3708f64dd..c19b53ad0459 100644 --- a/data/reusables/pages/symlink-removal.md +++ b/data/reusables/pages/symlink-removal.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If your repository contains symbolic links, you will need to publish your site using a {% data variables.product.prodname_actions %} workflow. For more information about {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions)." - -{% endnote %} +> [!NOTE] +> If your repository contains symbolic links, you will need to publish your site using a {% data variables.product.prodname_actions %} workflow. For more information about {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions)." diff --git a/data/reusables/pages/wildcard-dns-warning.md b/data/reusables/pages/wildcard-dns-warning.md index 0dd709ead5d2..b1b8c4a2ed08 100644 --- a/data/reusables/pages/wildcard-dns-warning.md +++ b/data/reusables/pages/wildcard-dns-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** We strongly recommend that you do not use wildcard DNS records, such as `*.example.com`. These records put you at an immediate risk of domain takeovers, even if you verify the domain. For example, if you verify `example.com` this prevents someone from using `a.example.com` but they could still take over `b.a.example.com` (which is covered by the wildcard DNS record). For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)." - -{% endwarning %} +> [!WARNING] +> We strongly recommend that you do not use wildcard DNS records, such as `*.example.com`. These records put you at an immediate risk of domain takeovers, even if you verify the domain. For example, if you verify `example.com` this prevents someone from using `a.example.com` but they could still take over `b.a.example.com` (which is covered by the wildcard DNS record). For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)." diff --git a/data/reusables/pre-release-program/api-preview-warning.md b/data/reusables/pre-release-program/api-preview-warning.md index 480d2dc69c41..b6cd05c01489 100644 --- a/data/reusables/pre-release-program/api-preview-warning.md +++ b/data/reusables/pre-release-program/api-preview-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact {% data variables.contact.contact_support %}. - -{% endwarning %} +> [!WARNING] +> The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact {% data variables.contact.contact_support %}. diff --git a/data/reusables/pre-release-program/starfox-preview.md b/data/reusables/pre-release-program/starfox-preview.md index 93fd99ab54a5..5e0cc5ec15ed 100644 --- a/data/reusables/pre-release-program/starfox-preview.md +++ b/data/reusables/pre-release-program/starfox-preview.md @@ -1,11 +1,8 @@ -{% note %} - -**Note:** Project card details are now shown in REST API responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). - -To receive the `project_card` attribute, {% data variables.projects.projects_v1_boards %} must be [enabled](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header: - -```text -application/vnd.github.starfox-preview+json -``` - -{% endnote %} +> [!NOTE] +> Project card details are now shown in REST API responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). +> +> To receive the `project_card` attribute, {% data variables.projects.projects_v1_boards %} must be [enabled](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header: +> +> ```text +> application/vnd.github.starfox-preview+json +> ``` diff --git a/data/reusables/project-management/edit-project-columns.md b/data/reusables/project-management/edit-project-columns.md index fdbbde77f43b..38665f258066 100644 --- a/data/reusables/project-management/edit-project-columns.md +++ b/data/reusables/project-management/edit-project-columns.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip:** To edit or remove a column from your {% data variables.projects.projects_v1_board %}, in the upper-right corner of the column, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. - -{% endtip %} +> [!TIP] +> To edit or remove a column from your {% data variables.projects.projects_v1_board %}, in the upper-right corner of the column, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. diff --git a/data/reusables/projects/classic-project-creation.md b/data/reusables/projects/classic-project-creation.md index 29c15666ca9a..21b16b8193b5 100644 --- a/data/reusables/projects/classic-project-creation.md +++ b/data/reusables/projects/classic-project-creation.md @@ -1,9 +1,6 @@ {% ifversion fpt or ghec %} -{% note %} - -**Note:** You can only create a new {% data variables.projects.projects_v1_board %} for an organization, user, or repository that already has at least one {% data variables.projects.projects_v1_board %}. If you're unable to create a {% data variables.projects.projects_v1_board %}, create a {% data variables.projects.project_v2 %} instead. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." - -{% endnote %} +> [!NOTE] +> You can only create a new {% data variables.projects.projects_v1_board %} for an organization, user, or repository that already has at least one {% data variables.projects.projects_v1_board %}. If you're unable to create a {% data variables.projects.projects_v1_board %}, create a {% data variables.projects.project_v2 %} instead. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." {% endif %} diff --git a/data/reusables/projects/customize/group-fields.md b/data/reusables/projects/customize/group-fields.md index eec9d9d02c12..b6ed9f96fb8f 100644 --- a/data/reusables/projects/customize/group-fields.md +++ b/data/reusables/projects/customize/group-fields.md @@ -1,8 +1,5 @@ -{% note %} - -**Note:** You cannot group by title, labels, reviewers, or linked pull requests. - -{% endnote %} +> [!NOTE] +> You cannot group by title, labels, reviewers, or linked pull requests. {% data reusables.projects.open-view-menu %} 1. Click {% octicon "rows" aria-hidden="true" %} **Group by**. diff --git a/data/reusables/projects/customize/slice-panel.md b/data/reusables/projects/customize/slice-panel.md index 2d90d640703a..104a0c9f9b69 100644 --- a/data/reusables/projects/customize/slice-panel.md +++ b/data/reusables/projects/customize/slice-panel.md @@ -1,10 +1,7 @@ You can slice your items by a field to view a list of the field values in a separate panel. When you click on a value in the slice panel, the current view will adjust to only show items with that value. The slice panel works with the current filter applied to your view. -{% note %} - -**Note:** You cannot slice by title, reviewers, or linked pull requests. - -{% endnote %} +> [!NOTE] +> You cannot slice by title, reviewers, or linked pull requests. {% data reusables.projects.open-view-menu %} 1. Click **Slice by**. diff --git a/data/reusables/projects/enable_enterprise_workflows.md b/data/reusables/projects/enable_enterprise_workflows.md index 8979496622cb..05547b09bf63 100644 --- a/data/reusables/projects/enable_enterprise_workflows.md +++ b/data/reusables/projects/enable_enterprise_workflows.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Project workflow automations must be enabled by an enterprise owner in the enterprise settings page for policies for projects. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise)." - -{% endnote %} +> [!NOTE] +> Project workflow automations must be enabled by an enterprise owner in the enterprise settings page for policies for projects. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise)." diff --git a/data/reusables/projects/org-templates-release-stage.md b/data/reusables/projects/org-templates-release-stage.md index 321a87503fbe..90f9c5635b37 100644 --- a/data/reusables/projects/org-templates-release-stage.md +++ b/data/reusables/projects/org-templates-release-stage.md @@ -1,9 +1,6 @@ {% ifversion ghes = 3.10 or ghes = 3.11 %} -{% note %} - -**Note:** Project templates for organizations is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Project templates for organizations is currently in {% data variables.release-phases.public_preview %} and subject to change. {% endif %} diff --git a/data/reusables/projects/projects-api.md b/data/reusables/projects/projects-api.md index e85992c6a05a..25d3fe9c56a7 100644 --- a/data/reusables/projects/projects-api.md +++ b/data/reusables/projects/projects-api.md @@ -1,21 +1,18 @@ {% ifversion projects-v1-can-create %} {% ifversion fpt or ghec %} -{% note %} -**Notes:** +> [!NOTE] +> * These endpoints only interact with {% data variables.product.prodname_projects_v1 %}. To manage {% data variables.product.prodname_projects_v2 %}, use the GraphQL API. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." +> * To create a new {% data variables.projects.projects_v1_board %}, the organization, user, or repository must already have at least one {% data variables.projects.projects_v1_board %}. -* These endpoints only interact with {% data variables.product.prodname_projects_v1 %}. To manage {% data variables.product.prodname_projects_v2 %}, use the GraphQL API. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." -* To create a new {% data variables.projects.projects_v1_board %}, the organization, user, or repository must already have at least one {% data variables.projects.projects_v1_board %}. - -{% endnote %} {% endif %} {% else %} ->[!NOTE] +> [!NOTE] {% data reusables.projects.sunset_notice_content %} > ->These endpoints only interact with {% data variables.product.prodname_projects_v1 %}. To manage {% data variables.product.prodname_projects_v2 %}, use the GraphQL API. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." +> These endpoints only interact with {% data variables.product.prodname_projects_v1 %}. To manage {% data variables.product.prodname_projects_v2 %}, use the GraphQL API. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." {% endif %} diff --git a/data/reusables/pull_requests/auto-merge-requires-branch-protection.md b/data/reusables/pull_requests/auto-merge-requires-branch-protection.md index 8db233257fb7..eb731406b011 100644 --- a/data/reusables/pull_requests/auto-merge-requires-branch-protection.md +++ b/data/reusables/pull_requests/auto-merge-requires-branch-protection.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: The option to enable auto-merge is shown only on pull requests that cannot be merged immediately. For example, when a branch protection rule enforces "Require pull request reviews before merging" or "Require status checks to pass before merging" and these conditions are not yet met. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule)." - -{% endnote %} +> [!NOTE] +> The option to enable auto-merge is shown only on pull requests that cannot be merged immediately. For example, when a branch protection rule enforces "Require pull request reviews before merging" or "Require status checks to pass before merging" and these conditions are not yet met. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule)." diff --git a/data/reusables/pull_requests/perms-to-open-pull-request.md b/data/reusables/pull_requests/perms-to-open-pull-request.md index 881d727dede8..bb480af0e7c0 100644 --- a/data/reusables/pull_requests/perms-to-open-pull-request.md +++ b/data/reusables/pull_requests/perms-to-open-pull-request.md @@ -1,9 +1,6 @@ {% ifversion fpt or ghec %} -{% note %} - -**Note**: To open a pull request in a public repository, you must have write access to the head or the source branch or, for organization-owned repositories, you must be a member of the organization that owns the repository to open a pull request. - -{% endnote %} +> [!NOTE] +> To open a pull request in a public repository, you must have write access to the head or the source branch or, for organization-owned repositories, you must be a member of the organization that owns the repository to open a pull request. {% endif %} diff --git a/data/reusables/pull_requests/pull_request_merges_and_contributions.md b/data/reusables/pull_requests/pull_request_merges_and_contributions.md index 8212fcbba95f..bac3bb3adb6d 100644 --- a/data/reusables/pull_requests/pull_request_merges_and_contributions.md +++ b/data/reusables/pull_requests/pull_request_merges_and_contributions.md @@ -1,8 +1,6 @@ -{% note %} - -**Notes:**{% ifversion ghes %} -* To appear on your profile contributions graph, co-authored commits must meet the same criteria as commits with one author.{% endif %} -* When rebasing commits, the original authors of the commit and the person who rebased the commits, whether on the command line or on {% data variables.location.product_location %}, receive contribution credit.{% ifversion ghec or fpt %} -* If you merged multiple personal accounts, issues, pull requests, and discussions will not be attributed to the new account and will not appear on your contribution graph.{% endif %} - -{% endnote %} +> [!NOTE] +{% ifversion ghes %} +> * To appear on your profile contributions graph, co-authored commits must meet the same criteria as commits with one author. +{% endif %} +> * When rebasing commits, the original authors of the commit and the person who rebased the commits, whether on the command line or on {% data variables.location.product_location %}, receive contribution credit.{% ifversion ghec or fpt %} +> * If you merged multiple personal accounts, issues, pull requests, and discussions will not be attributed to the new account and will not appear on your contribution graph.{% endif %} diff --git a/data/reusables/repositories/allow-maintainers-user-forks.md b/data/reusables/repositories/allow-maintainers-user-forks.md index ac64eac3aa47..56d803a1a4f6 100644 --- a/data/reusables/repositories/allow-maintainers-user-forks.md +++ b/data/reusables/repositories/allow-maintainers-user-forks.md @@ -1,7 +1,4 @@ 1. On user-owned forks, if you want to allow anyone with push access to the upstream repository to make changes to your pull request, select **Allow edits from maintainers**. - {% warning %} - - **Warning:** If your fork contains {% data variables.product.prodname_actions %} workflows, the option is **Allow edits and access to secrets by maintainers**. Allowing edits on a fork's branch that contains {% data variables.product.prodname_actions %} workflows also allows a maintainer to edit the forked repository's workflows, which can potentially reveal values of secrets and grant access to other branches. - - {% endwarning %} + > [!WARNING] + > If your fork contains {% data variables.product.prodname_actions %} workflows, the option is **Allow edits and access to secrets by maintainers**. Allowing edits on a fork's branch that contains {% data variables.product.prodname_actions %} workflows also allows a maintainer to edit the forked repository's workflows, which can potentially reveal values of secrets and grant access to other branches. diff --git a/data/reusables/repositories/asking-for-review.md b/data/reusables/repositories/asking-for-review.md index 7f59e5204544..b12b30b3fedb 100644 --- a/data/reusables/repositories/asking-for-review.md +++ b/data/reusables/repositories/asking-for-review.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip:** After you create a pull request, you can ask a specific person to [review your proposed changes](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request). For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." - -{% endtip %} +> [!TIP] +> After you create a pull request, you can ask a specific person to [review your proposed changes](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request). For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." diff --git a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index ef12f11b0ae9..77f341224306 100644 --- a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -1,11 +1,5 @@ -{% warning %} - -**Warning:** - -* If you remove a person’s access to a private repository, any of their forks of that private repository are deleted. Local clones of the private repository are retained. If a team's access to a private repository is revoked or a team with access to a private repository is deleted, and team members do not have access to the repository through another team, private forks of the repository will be deleted.{% ifversion ghes %} -* When [LDAP Sync is enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} -* You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. - -* People with admin permissions to a private{% ifversion ghes or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghec %} or internal{% endif %} repository in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." - -{% endwarning %} +> [!WARNING] +> * If you remove a person’s access to a private repository, any of their forks of that private repository are deleted. Local clones of the private repository are retained. If a team's access to a private repository is revoked or a team with access to a private repository is deleted, and team members do not have access to the repository through another team, private forks of the repository will be deleted.{% ifversion ghes %} +> * When [LDAP Sync is enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} +> * You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +> * People with admin permissions to a private{% ifversion ghes or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghec %} or internal{% endif %} repository in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." diff --git a/data/reusables/repositories/deleting-ruleset-tip.md b/data/reusables/repositories/deleting-ruleset-tip.md index 36271b935387..13ebacaca96e 100644 --- a/data/reusables/repositories/deleting-ruleset-tip.md +++ b/data/reusables/repositories/deleting-ruleset-tip.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip:** If you want to temporarily disable a ruleset but do not want to delete it, you can set the ruleset's status to "Disabled." For more information, see "[Editing a ruleset](#editing-a-ruleset)." - -{% endtip %} +> [!TIP] +> If you want to temporarily disable a ruleset but do not want to delete it, you can set the ruleset's status to "Disabled." For more information, see "[Editing a ruleset](#editing-a-ruleset)." diff --git a/data/reusables/repositories/edit-file.md b/data/reusables/repositories/edit-file.md index f26f48f60dde..e69146144f39 100644 --- a/data/reusables/repositories/edit-file.md +++ b/data/reusables/repositories/edit-file.md @@ -1,11 +1,10 @@ {% data reusables.repositories.edit-file-button %} {% ifversion githubdev-editor -%} - {% note %} - **Note:** Instead of editing and committing the file using the default file editor, you can optionally choose to use the [github.dev code editor](/codespaces/the-githubdev-web-based-editor) by selecting the {% octicon "triangle-down" aria-label="More edit options" %} dropdown menu and clicking **github.dev**. You can also clone the repository and edit the file locally via {% data variables.product.prodname_desktop %} by clicking **{% data variables.product.prodname_desktop %}**. + > [!NOTE] + > Instead of editing and committing the file using the default file editor, you can optionally choose to use the [github.dev code editor](/codespaces/the-githubdev-web-based-editor) by selecting the {% octicon "triangle-down" aria-label="More edit options" %} dropdown menu and clicking **github.dev**. You can also clone the repository and edit the file locally via {% data variables.product.prodname_desktop %} by clicking **{% data variables.product.prodname_desktop %}**. + > + > ![Screenshot of a file. In the header, a downwards-facing triangle icon is outlined in dark orange.](/assets/images/help/repository/edit-file-edit-dropdown.png) - ![Screenshot of a file. In the header, a downwards-facing triangle icon is outlined in dark orange.](/assets/images/help/repository/edit-file-edit-dropdown.png) - - {% endnote %} {%- endif %} diff --git a/data/reusables/repositories/edited-comment-list.md b/data/reusables/repositories/edited-comment-list.md index f0f76d2bbb2a..b9fe774f48e6 100644 --- a/data/reusables/repositories/edited-comment-list.md +++ b/data/reusables/repositories/edited-comment-list.md @@ -1,10 +1,7 @@ 1. At the top of the comment, click **edited** to open the edit history. - {% note %} - - **Note:** If you don't see the **edited** option, then the comment doesn't have an edit history. - - {% endnote %} + > [!NOTE] + > If you don't see the **edited** option, then the comment doesn't have an edit history. 1. To view the details of a specific change, select it from the list of edits. diff --git a/data/reusables/repositories/private_forks_inherit_permissions.md b/data/reusables/repositories/private_forks_inherit_permissions.md index c81f31248cda..b901a5a5b160 100644 --- a/data/reusables/repositories/private_forks_inherit_permissions.md +++ b/data/reusables/repositories/private_forks_inherit_permissions.md @@ -1,7 +1,4 @@ Private forks inherit the permissions structure of the upstream repository. This helps owners of private repositories maintain control over their code. For example, if the upstream repository is private and gives read/write access to a team, then the same team will have read/write access to any forks of the private upstream repository. Only team permissions (not individual permissions) are inherited by private forks. -{% note %} - -**Note:** {% data reusables.repositories.org-base-permissions-private-forks %} For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization#about-base-permissions-for-an-organization)." - -{% endnote %} +> [!NOTE] +> {% data reusables.repositories.org-base-permissions-private-forks %} For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization#about-base-permissions-for-an-organization)." diff --git a/data/reusables/repositories/repo-insights-commit-limit.md b/data/reusables/repositories/repo-insights-commit-limit.md index b350ae043dbf..08c647189656 100644 --- a/data/reusables/repositories/repo-insights-commit-limit.md +++ b/data/reusables/repositories/repo-insights-commit-limit.md @@ -1,9 +1,6 @@ {% ifversion not ghes %} -{% note %} - -**Note:** Certain contributor, commit, and code frequency insights are only available for repositories that have less than 10,000 commits. - -{% endnote %} +> [!NOTE] +> Certain contributor, commit, and code frequency insights are only available for repositories that have less than 10,000 commits. {% endif %} diff --git a/data/reusables/repositories/request-changes-tips.md b/data/reusables/repositories/request-changes-tips.md index 2088eb6e0cec..d5c6db2622fc 100644 --- a/data/reusables/repositories/request-changes-tips.md +++ b/data/reusables/repositories/request-changes-tips.md @@ -1,11 +1,7 @@ -{% tip %} - -**Tips**: -* The **Request changes** option is purely informational and will not prevent merging unless a ruleset or classic branch protection rule is configured with the "require a pull request" option. If configured and a collaborator with `admin`, `owner`, or `write` access to the repository submits a review requesting changes, the pull request cannot be merged until the same collaborator submits another review approving the changes in the pull request. -* Repository owners and administrators can merge a pull request even if it hasn't received an approving review, or if a reviewer who requested changes has left the organization or is unavailable. -* If both required reviews and stale review dismissal are enabled and a code-modifying commit is pushed to the branch of an approved pull request, the approval is dismissed. The pull request must be reviewed and approved again before it can be merged. -* When several open pull requests each have a head branch pointing to the same commit, you won’t be able to merge them if one or both have a pending or rejected review. -* If your repository requires approving reviews from people with write or admin permissions, then any approvals from people with these permissions are denoted with a green check mark, and approvals from people without these permissions have a gray check mark. Approvals with a gray check mark do not affect whether the pull request can be merged. -* Pull request authors cannot approve their own pull requests. - -{% endtip %} +> [!TIP] +> * The **Request changes** option is purely informational and will not prevent merging unless a ruleset or classic branch protection rule is configured with the "require a pull request" option. If configured and a collaborator with `admin`, `owner`, or `write` access to the repository submits a review requesting changes, the pull request cannot be merged until the same collaborator submits another review approving the changes in the pull request. +> * Repository owners and administrators can merge a pull request even if it hasn't received an approving review, or if a reviewer who requested changes has left the organization or is unavailable. +> * If both required reviews and stale review dismissal are enabled and a code-modifying commit is pushed to the branch of an approved pull request, the approval is dismissed. The pull request must be reviewed and approved again before it can be merged. +> * When several open pull requests each have a head branch pointing to the same commit, you won’t be able to merge them if one or both have a pending or rejected review. +> * If your repository requires approving reviews from people with write or admin permissions, then any approvals from people with these permissions are denoted with a green check mark, and approvals from people without these permissions have a gray check mark. Approvals with a gray check mark do not affect whether the pull request can be merged. +> * Pull request authors cannot approve their own pull requests. diff --git a/data/reusables/repositories/ruleset-beta-note.md b/data/reusables/repositories/ruleset-beta-note.md index b9260bb50dae..76051d176c6d 100644 --- a/data/reusables/repositories/ruleset-beta-note.md +++ b/data/reusables/repositories/ruleset-beta-note.md @@ -1,8 +1,3 @@ -{% note %} - -**Notes:** - -* Ruleset history is currently in {% data variables.release-phases.public_preview %} and subject to change. -* Only changes made to a ruleset after the {% data variables.release-phases.public_preview %} release, on October 11, 2023, are included in the ruleset history. - -{% endnote %} +> [!NOTE] +> * Ruleset history is currently in {% data variables.release-phases.public_preview %} and subject to change. +> * Only changes made to a ruleset after the {% data variables.release-phases.public_preview %} release, on October 11, 2023, are included in the ruleset history. diff --git a/data/reusables/repositories/rulesets-anyone-can-view.md b/data/reusables/repositories/rulesets-anyone-can-view.md index 924603336407..5eb62e9f0fdc 100644 --- a/data/reusables/repositories/rulesets-anyone-can-view.md +++ b/data/reusables/repositories/rulesets-anyone-can-view.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Anyone with read access to a repository can view the active rulesets operating on that repository. - -{% endnote %} +> [!NOTE] +> Anyone with read access to a repository can view the active rulesets operating on that repository. diff --git a/data/reusables/repositories/rulesets-commit-regex.md b/data/reusables/repositories/rulesets-commit-regex.md index 3b3502e7bc94..9f0a4e57f554 100644 --- a/data/reusables/repositories/rulesets-commit-regex.md +++ b/data/reusables/repositories/rulesets-commit-regex.md @@ -8,11 +8,8 @@ By default, regular expressions in metadata restrictions do not consider multipl The negative lookahead assertion, denoted `?!`, is not supported. However, for cases where you need to look for a given string that is not followed by another given string, you can use the positive lookahead assertion, denoted `?`, combined with the "Must not match a given regex pattern" requirement. -{% note %} - -**Note:** If you require contributors to sign off on commits, this may interfere with your regular expression patterns. When someone signs off, {% data variables.product.prodname_dotcom %} adds a string like `Signed-off-by: #AUTHOR-NAME <#AUTHOR-EMAIL>` to the commit message. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)." - -{% endnote %} +> [!NOTE] +> If you require contributors to sign off on commits, this may interfere with your regular expression patterns. When someone signs off, {% data variables.product.prodname_dotcom %} adds a string like `Signed-off-by: #AUTHOR-NAME <#AUTHOR-EMAIL>` to the commit message. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)." #### Useful regular expression patterns diff --git a/data/reusables/repositories/rulesets-protections-step.md b/data/reusables/repositories/rulesets-protections-step.md index d7c1ba0d973e..ec6512cbfb8c 100644 --- a/data/reusables/repositories/rulesets-protections-step.md +++ b/data/reusables/repositories/rulesets-protections-step.md @@ -1,9 +1,6 @@ In the "Branch protections" or "Tag protections" section, select the rules you want to include in the ruleset. When you select a rule, you may be able to enter additional settings for the rule. For more information on the rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets)." -{% note %} - -**Notes:** If you select **Require status checks before merging**, in the "Additional settings" section: -* You can enter the name of each status check you would like to require. To finish adding the status check as a requirement, you must click {% octicon "plus" aria-label="Add selected status checks" %}. -* If you select **Require branches to be up to date before merging**, you must define a check for the protection to take effect. - -{% endnote %} +> [!NOTE] +> If you select **Require status checks before merging**, in the "Additional settings" section: +> * You can enter the name of each status check you would like to require. To finish adding the status check as a requirement, you must click {% octicon "plus" aria-label="Add selected status checks" %}. +> * If you select **Require branches to be up to date before merging**, you must define a check for the protection to take effect. diff --git a/data/reusables/repositories/sensitive-info-warning.md b/data/reusables/repositories/sensitive-info-warning.md index 6daaa56183df..2b67f0629b91 100644 --- a/data/reusables/repositories/sensitive-info-warning.md +++ b/data/reusables/repositories/sensitive-info-warning.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning:** Never `git add`, `commit`, or `push` sensitive information, for example passwords or API keys, to a remote repository. If you've already added this information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." - -{% endwarning %} +> [!WARNING] +> Never `git add`, `commit`, or `push` sensitive information, for example passwords or API keys, to a remote repository. If you've already added this information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." diff --git a/data/reusables/repositories/settings-permissions-org-policy-note.md b/data/reusables/repositories/settings-permissions-org-policy-note.md index a37a19e045d2..4ff117f228d4 100644 --- a/data/reusables/repositories/settings-permissions-org-policy-note.md +++ b/data/reusables/repositories/settings-permissions-org-policy-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." - -{% endnote %} +> [!NOTE] +> You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." diff --git a/data/reusables/repositories/transfer-repository-steps.md b/data/reusables/repositories/transfer-repository-steps.md index f40cb189532d..f58d8fb2fe4d 100644 --- a/data/reusables/repositories/transfer-repository-steps.md +++ b/data/reusables/repositories/transfer-repository-steps.md @@ -6,11 +6,9 @@ * Select the dropdown menu and click an organization. * Optionally, in the "Repository name" field, type a new name for the repository. - {% note %} + > [!NOTE] + > You must be an owner of the target organization to rename the repository. - **Note:** You must be an owner of the target organization to rename the repository. - - {% endnote %} * To specify an organization or username, select **Specify an organization or username**, then type the organization name or the new owner's username. 1. Read the warnings about potential loss of features depending on the new owner's {% data variables.product.prodname_dotcom %} subscription. 1. Following **Type REPOSITORY NAME to confirm**, type the name of the repository you'd like to transfer, then click **I understand, transfer this repository**. diff --git a/data/reusables/saml/ghec-only.md b/data/reusables/saml/ghec-only.md index 66880fab8a9e..6fe531823ecb 100644 --- a/data/reusables/saml/ghec-only.md +++ b/data/reusables/saml/ghec-only.md @@ -1,7 +1,6 @@ {% ifversion ghec %} -{% note %} -**Note:** To use SAML single sign-on, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> To use SAML single sign-on, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} diff --git a/data/reusables/saml/must-authorize-linked-identity.md b/data/reusables/saml/must-authorize-linked-identity.md index 224fa9a5e787..4697c484ca5a 100644 --- a/data/reusables/saml/must-authorize-linked-identity.md +++ b/data/reusables/saml/must-authorize-linked-identity.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If you have a linked identity for an organization, you can only use authorized {% data variables.product.pat_generic %}s and SSH keys with that organization, even if SAML is not enforced. You have a linked identity for an organization if you've ever authenticated via SAML SSO for that organization, unless an organization or enterprise owner later revoked the linked identity. For more information about revoking linked identities, see "[AUTOTITLE](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)." - -{% endnote %} +> [!NOTE] +> If you have a linked identity for an organization, you can only use authorized {% data variables.product.pat_generic %}s and SSH keys with that organization, even if SAML is not enforced. You have a linked identity for an organization if you've ever authenticated via SAML SSO for that organization, unless an organization or enterprise owner later revoked the linked identity. For more information about revoking linked identities, see "[AUTOTITLE](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)." diff --git a/data/reusables/saml/no-scim-for-enterprises.md b/data/reusables/saml/no-scim-for-enterprises.md index eaec1b22a6f2..d38ac64856d9 100644 --- a/data/reusables/saml/no-scim-for-enterprises.md +++ b/data/reusables/saml/no-scim-for-enterprises.md @@ -1,9 +1,8 @@ {% ifversion ghec %} -{% note %} -**Note:** You cannot configure SCIM for your enterprise account unless your account was created for {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." +> [!NOTE] +> You cannot configure SCIM for your enterprise account unless your account was created for {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." +> +> If you do not use {% data variables.product.prodname_emus %}, and you want to use SCIM provisioning, you must configure SAML SSO at the organization level, not the enterprise level. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." -If you do not use {% data variables.product.prodname_emus %}, and you want to use SCIM provisioning, you must configure SAML SSO at the organization level, not the enterprise level. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." - -{% endnote %} {% endif %} diff --git a/data/reusables/saml/outside-collaborators-exemption.md b/data/reusables/saml/outside-collaborators-exemption.md index 894ee9b00fb2..da0ee78b56ee 100644 --- a/data/reusables/saml/outside-collaborators-exemption.md +++ b/data/reusables/saml/outside-collaborators-exemption.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** SAML authentication is not required for outside collaborators. For more information about outside collaborators, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." - -{% endnote %} +> [!NOTE] +> SAML authentication is not required for outside collaborators. For more information about outside collaborators, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." diff --git a/data/reusables/saml/saml-accounts.md b/data/reusables/saml/saml-accounts.md index 7eb82d1f5380..7e3a87806fa1 100644 --- a/data/reusables/saml/saml-accounts.md +++ b/data/reusables/saml/saml-accounts.md @@ -1,7 +1,4 @@ If you configure SAML SSO, members of your organization will continue to sign into their personal accounts on {% data variables.product.prodname_dotcom_the_website %}. When a member accesses most resources within your organization, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. After successful authentication, your IdP redirects the member back to {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)." -{% note %} - -**Note:** SAML SSO does not replace the normal sign-in process for {% data variables.product.prodname_dotcom %}. Unless you use {% data variables.product.prodname_emus %}, members will continue to sign into their personal accounts on {% data variables.product.prodname_dotcom_the_website %}, and each personal account will be linked to an external identity in your IdP. - -{% endnote %} +> [!NOTE] +> SAML SSO does not replace the normal sign-in process for {% data variables.product.prodname_dotcom %}. Unless you use {% data variables.product.prodname_emus %}, members will continue to sign into their personal accounts on {% data variables.product.prodname_dotcom_the_website %}, and each personal account will be linked to an external identity in your IdP. diff --git a/data/reusables/scim/emu-scim-rate-limit.md b/data/reusables/scim/emu-scim-rate-limit.md index 253536dbfaf9..b113dc48dcb3 100644 --- a/data/reusables/scim/emu-scim-rate-limit.md +++ b/data/reusables/scim/emu-scim-rate-limit.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** {% data reusables.scim.emu-scim-rate-limit-details %} For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise#scim-provisioning-errors)." - -{% endnote %} +> [!NOTE] +> {% data reusables.scim.emu-scim-rate-limit-details %} For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise#scim-provisioning-errors)." diff --git a/data/reusables/scim/organization-rest-api-ghec-deployment-option.md b/data/reusables/scim/organization-rest-api-ghec-deployment-option.md index d0317f83fa90..b0af51674215 100644 --- a/data/reusables/scim/organization-rest-api-ghec-deployment-option.md +++ b/data/reusables/scim/organization-rest-api-ghec-deployment-option.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: This operation allows you to provision access to an organization on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is not available for use with {% data variables.product.prodname_emus %}. For more information about provisioning {% data variables.enterprise.prodname_managed_users %} using SCIM, see "[AUTOTITLE](/rest/enterprise-admin/scim)." - -{% endnote %} +> [!NOTE] +> This operation allows you to provision access to an organization on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is not available for use with {% data variables.product.prodname_emus %}. For more information about provisioning {% data variables.enterprise.prodname_managed_users %} using SCIM, see "[AUTOTITLE](/rest/enterprise-admin/scim)." diff --git a/data/reusables/search/requested_reviews_search_tip.md b/data/reusables/search/requested_reviews_search_tip.md index c0e26ab1233d..b7d581a53d6f 100644 --- a/data/reusables/search/requested_reviews_search_tip.md +++ b/data/reusables/search/requested_reviews_search_tip.md @@ -1,5 +1,2 @@ -{% tip %} - -**Tip:** You can find a pull request where you or a team you're a member of is requested for review with the search qualifier `review-requested:[USERNAME]` or `team-review-requested:[TEAMNAME]`. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests)." - -{% endtip %} +> [!TIP] +> You can find a pull request where you or a team you're a member of is requested for review with the search qualifier `review-requested:[USERNAME]` or `team-review-requested:[TEAMNAME]`. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests)." diff --git a/data/reusables/search/syntax_tips.md b/data/reusables/search/syntax_tips.md index 8036e948538f..7cfe15d39dbc 100644 --- a/data/reusables/search/syntax_tips.md +++ b/data/reusables/search/syntax_tips.md @@ -1,8 +1,6 @@ -{% tip %} - -**Tips:**{% ifversion ghes %} -* This article contains links to example searches on the {% data variables.product.prodname_dotcom_the_website %} website, but you can use the same search filters with {% data variables.product.product_name %}. In the linked example searches, replace `github.com` with the hostname for {% data variables.location.product_location %}.{% endif %} -* For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". -* Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. - -{% endtip %} +> [!TIP] +{% ifversion ghes %} +> * This article contains links to example searches on the {% data variables.product.prodname_dotcom_the_website %} website, but you can use the same search filters with {% data variables.product.product_name %}. In the linked example searches, replace `github.com` with the hostname for {% data variables.location.product_location %}. +{% endif %} +> * For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". +> * Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. diff --git a/data/reusables/secret-scanning/api-beta.md b/data/reusables/secret-scanning/api-beta.md index ff75e718f2cb..956acb1d1868 100644 --- a/data/reusables/secret-scanning/api-beta.md +++ b/data/reusables/secret-scanning/api-beta.md @@ -1,9 +1,6 @@ {% ifversion ghes %} -{% note %} - -**Note:** The endpoints to manage {% data variables.product.prodname_secret_scanning %} are currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The endpoints to manage {% data variables.product.prodname_secret_scanning %} are currently in {% data variables.release-phases.public_preview %} and subject to change. {% endif %} diff --git a/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md b/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md index ce395820816e..da15e6d0215a 100644 --- a/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md +++ b/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md @@ -1,11 +1,8 @@ {% ifversion ghes %} -{% note %} - -**Note:** Your site administrator must enable {% data variables.product.prodname_secret_scanning %} for the instance before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance)." - -You may not be able to enable or disable {% data variables.product.prodname_secret_scanning %}, if an enterprise owner has set a policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." - -{% endnote %} +> [!NOTE] +> Your site administrator must enable {% data variables.product.prodname_secret_scanning %} for the instance before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance)." +> +> You may not be able to enable or disable {% data variables.product.prodname_secret_scanning %}, if an enterprise owner has set a policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." {% endif %} diff --git a/data/reusables/secret-scanning/non-provider-patterns-beta.md b/data/reusables/secret-scanning/non-provider-patterns-beta.md index c7efde0b5691..53c482b0d3c8 100644 --- a/data/reusables/secret-scanning/non-provider-patterns-beta.md +++ b/data/reusables/secret-scanning/non-provider-patterns-beta.md @@ -1,5 +1,6 @@ {% ifversion ghes > 3.11 and ghes < 3.16 %} -**Note:** The detection of non-provider patterns is currently in {% data variables.release-phases.public_preview %} and subject to change. +> [!NOTE] +> The detection of non-provider patterns is currently in {% data variables.release-phases.public_preview %} and subject to change. {% endif %} diff --git a/data/reusables/secret-scanning/push-protection-enterprise-note.md b/data/reusables/secret-scanning/push-protection-enterprise-note.md index a99fa4423d87..e780bc770143 100644 --- a/data/reusables/secret-scanning/push-protection-enterprise-note.md +++ b/data/reusables/secret-scanning/push-protection-enterprise-note.md @@ -1,8 +1,3 @@ -{% note %} - -**Notes:** - -* To enable push protection for custom patterns, {% data variables.product.prodname_secret_scanning %} as push protection needs to be enabled at the enterprise level. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-your-enterprise)." -* Enabling push protection for commonly found custom patterns can be disruptive to contributors. - -{% endnote %} +> [!NOTE] +> * To enable push protection for custom patterns, {% data variables.product.prodname_secret_scanning %} as push protection needs to be enabled at the enterprise level. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-your-enterprise)." +> * Enabling push protection for commonly found custom patterns can be disruptive to contributors. diff --git a/data/reusables/secret-scanning/push-protection-multiple-branch-note.md b/data/reusables/secret-scanning/push-protection-multiple-branch-note.md index df569cb53eca..7f892a170210 100644 --- a/data/reusables/secret-scanning/push-protection-multiple-branch-note.md +++ b/data/reusables/secret-scanning/push-protection-multiple-branch-note.md @@ -1,8 +1,3 @@ -{% note %} - -**Notes**: - -* If your Git configuration supports pushes to multiple branches, and not only to the current branch, your push may be blocked due to additional and unintended refs being pushed. For more information, see the [`push.default` options](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushdefault) in the Git documentation. -* If {% data variables.product.prodname_secret_scanning %} upon a push times out, {% data variables.product.prodname_dotcom %} will still scan your commits for secrets after the push. - -{% endnote %} +> [!NOTE] +> * If your Git configuration supports pushes to multiple branches, and not only to the current branch, your push may be blocked due to additional and unintended refs being pushed. For more information, see the [`push.default` options](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushdefault) in the Git documentation. +> * If {% data variables.product.prodname_secret_scanning %} upon a push times out, {% data variables.product.prodname_dotcom %} will still scan your commits for secrets after the push. diff --git a/data/reusables/secret-scanning/push-protection-org-metrics-beta.md b/data/reusables/secret-scanning/push-protection-org-metrics-beta.md index 9816abd9098e..cb4b70ed82f1 100644 --- a/data/reusables/secret-scanning/push-protection-org-metrics-beta.md +++ b/data/reusables/secret-scanning/push-protection-org-metrics-beta.md @@ -1,6 +1,3 @@ -{% note %} - -**Note:** {% data variables.product.prodname_secret_scanning_caps %} metrics for push protection is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_secret_scanning_caps %} metrics for push protection is currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/secret-scanning/push-protection-org-notes.md b/data/reusables/secret-scanning/push-protection-org-notes.md index 5922abc4aeba..b15d2405f563 100644 --- a/data/reusables/secret-scanning/push-protection-org-notes.md +++ b/data/reusables/secret-scanning/push-protection-org-notes.md @@ -1,8 +1,4 @@ -{% note %} - -**Notes:** -* The option to enable push protection is visible for published patterns only. -* Push protection for custom patterns will only apply to repositories in your organization that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization)." -* Enabling push protection for commonly found custom patterns can be disruptive to contributors. - -{% endnote %} +> [!NOTE] +> * The option to enable push protection is visible for published patterns only. +> * Push protection for custom patterns will only apply to repositories in your organization that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization)." +> * Enabling push protection for commonly found custom patterns can be disruptive to contributors. diff --git a/data/reusables/secret-scanning/push-protection-public-repos-bypass.md b/data/reusables/secret-scanning/push-protection-public-repos-bypass.md index f30147f861dc..3380b58a469f 100644 --- a/data/reusables/secret-scanning/push-protection-public-repos-bypass.md +++ b/data/reusables/secret-scanning/push-protection-public-repos-bypass.md @@ -1,13 +1,10 @@ {% ifversion secret-scanning-push-protection-for-users %} - {% note %} - - **Note:** You are required to specify a reason for bypassing push protection if the repository has secret scanning enabled. - - When pushing to a _public_ repository that doesn't have secret scanning enabled, you are still protected from accidentally pushing secrets thanks to _push protection for users_, which is on by default for your user account. - - With push protection for users, GitHub will automatically block pushes to public repositories if these pushes contain supported secrets, but you won't need to specify a reason for allowing the secret, and {% data variables.product.prodname_dotcom %} won't generate an alert. For more information, see "[AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users)." - - {% endnote %} + > [!NOTE] + > You are required to specify a reason for bypassing push protection if the repository has secret scanning enabled. + > + > When pushing to a _public_ repository that doesn't have secret scanning enabled, you are still protected from accidentally pushing secrets thanks to _push protection for users_, which is on by default for your user account. + > + > With push protection for users, GitHub will automatically block pushes to public repositories if these pushes contain supported secrets, but you won't need to specify a reason for allowing the secret, and {% data variables.product.prodname_dotcom %} won't generate an alert. For more information, see "[AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users)." {% endif %} diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md b/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md index 0327b00d3ff6..0ddf3d9eb746 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If the repository doesn't have private vulnerability reporting enabled, you need to initiate the reporting process by following the instructions in the security policy for the repository, or create an issue asking the maintainers for a preferred security contact. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github)." - -{% endnote %} +> [!NOTE] +> If the repository doesn't have private vulnerability reporting enabled, you need to initiate the reporting process by following the instructions in the security policy for the repository, or create an issue asking the maintainers for a preferred security contact. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github)." diff --git a/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md b/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md index 764a67ffc9bd..05f90d79bb07 100644 --- a/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md +++ b/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md @@ -2,21 +2,16 @@ {% data reusables.repositories.sidebar-security %} 1. Click **Report a vulnerability** to open the advisory form. 1. Fill in the advisory details form. - {% tip %} - **Tip:** In this form, only the title and description are mandatory. (In the general draft security advisory form, which the repository maintainer initiates, specifying the ecosystem is also required.) However, we recommend security researchers provide as much information as possible on the form so that the maintainers can make an informed decision about the submitted report. You can adopt the template used by our security researchers from the {% data variables.product.prodname_security %}, which is available on the "[`github/securitylab` repository](https://github.com/github/securitylab/blob/main/docs/report-template.md)." - - {% endtip %} + > [!TIP] + > In this form, only the title and description are mandatory. (In the general draft security advisory form, which the repository maintainer initiates, specifying the ecosystem is also required.) However, we recommend security researchers provide as much information as possible on the form so that the maintainers can make an informed decision about the submitted report. You can adopt the template used by our security researchers from the {% data variables.product.prodname_security %}, which is available on the "[`github/securitylab` repository](https://github.com/github/securitylab/blob/main/docs/report-template.md)." For more information about the fields available and guidance on filling in the form, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory)" and "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories)." 1. At the bottom of the form, click **Submit report**. {% data variables.product.prodname_dotcom %} will display a message letting you know that maintainers have been notified and that you have a pending credit for this security advisory. - {% tip %} - - **Tip:** When the report is submitted, {% data variables.product.prodname_dotcom %} automatically adds the reporter of the vulnerability as a collaborator and as a credited user on the proposed advisory. - - {% endtip %} + > [!TIP] + > When the report is submitted, {% data variables.product.prodname_dotcom %} automatically adds the reporter of the vulnerability as a collaborator and as a credited user on the proposed advisory. 1. Optionally, click **Start a temporary private fork** if you want to start to fix the issue. Note that only the repository maintainer can merge changes from that private fork into the parent repository. diff --git a/data/reusables/security-advisory/repository-level-advisory-note.md b/data/reusables/security-advisory/repository-level-advisory-note.md index acb9b3fdf6f0..99b078df658e 100644 --- a/data/reusables/security-advisory/repository-level-advisory-note.md +++ b/data/reusables/security-advisory/repository-level-advisory-note.md @@ -1,7 +1,4 @@ -{% note %} - -**Note**: This article applies to editing repository-level advisories as an owner of a public repository. - -Users who are not repository owners can contribute to global security advisories in the {% data variables.product.prodname_advisory_database %} at [github.com/advisories](https://github.com/advisories). Edits to global advisories will not change or affect how the advisory appears on the repository. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database)." - -{% endnote %} +> [!NOTE] +> This article applies to editing repository-level advisories as an owner of a public repository. +> +> Users who are not repository owners can contribute to global security advisories in the {% data variables.product.prodname_advisory_database %} at [github.com/advisories](https://github.com/advisories). Edits to global advisories will not change or affect how the advisory appears on the repository. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database)." diff --git a/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md b/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md index 9ecd6387a129..be9570614881 100644 --- a/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md +++ b/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** If you are a security researcher, you should directly contact maintainers to ask them to create security advisories or issue CVEs on your behalf in repositories that you don't administer. However, if private vulnerability reporting is enabled for the repository, you can _privately_ report a vulnerability yourself. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability)." - -{% endnote %} +> [!NOTE] +> If you are a security researcher, you should directly contact maintainers to ask them to create security advisories or issue CVEs on your behalf in repositories that you don't administer. However, if private vulnerability reporting is enabled for the repository, you can _privately_ report a vulnerability yourself. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability)." diff --git a/data/reusables/security-configurations/default-configuration-exception-repo-transfers.md b/data/reusables/security-configurations/default-configuration-exception-repo-transfers.md index 50713005c60a..3fdcf11977e5 100644 --- a/data/reusables/security-configurations/default-configuration-exception-repo-transfers.md +++ b/data/reusables/security-configurations/default-configuration-exception-repo-transfers.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** The default {% data variables.product.prodname_security_configuration %} for an organization is only automatically applied to new repositories created in your organization. If a repository is transferred into your organization, you will still need to apply an appropriate {% data variables.product.prodname_security_configuration %} to the repository manually. - -{% endnote %} +> [!NOTE] +> The default {% data variables.product.prodname_security_configuration %} for an organization is only automatically applied to new repositories created in your organization. If a repository is transferred into your organization, you will still need to apply an appropriate {% data variables.product.prodname_security_configuration %} to the repository manually. diff --git a/data/reusables/security-overview/beta-org-risk-coverage.md b/data/reusables/security-overview/beta-org-risk-coverage.md index 2c27eb007d4f..82e75218af44 100644 --- a/data/reusables/security-overview/beta-org-risk-coverage.md +++ b/data/reusables/security-overview/beta-org-risk-coverage.md @@ -1,9 +1,6 @@ {% ifversion ghes < 3.11 %} -{% note %} - -**Note:** The "Security risk" and "Security coverage" views are currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The "Security risk" and "Security coverage" views are currently in {% data variables.release-phases.public_preview %} and subject to change. {% endif %} diff --git a/data/reusables/security-overview/settings-limitations.md b/data/reusables/security-overview/settings-limitations.md index 424ea93a60f5..86ba27f1619a 100644 --- a/data/reusables/security-overview/settings-limitations.md +++ b/data/reusables/security-overview/settings-limitations.md @@ -1,19 +1,12 @@ {% ifversion secret-scanning-non-provider-patterns %} -{% note %} -**Notes:** - -* Enabling {% data variables.product.prodname_code_scanning %} default setup _will not_ override any existing configurations of advanced setup for the selected repositories, but it _will_ override any existing configurations of default setup. -* Enabling "Alerts" for {% data variables.product.prodname_secret_scanning %} enables {% ifversion secret-scanning-alert-experimental-list %}default{% else %}high confidence{% endif %} alerts. If you want to enable non-provider alerts, you need to edit the repository, organization, or enterprise settings. For more information about alert types, see "[Supported secrets](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - -{% endnote %} +> [!NOTE] +> * Enabling {% data variables.product.prodname_code_scanning %} default setup _will not_ override any existing configurations of advanced setup for the selected repositories, but it _will_ override any existing configurations of default setup. +> * Enabling "Alerts" for {% data variables.product.prodname_secret_scanning %} enables {% ifversion secret-scanning-alert-experimental-list %}default{% else %}high confidence{% endif %} alerts. If you want to enable non-provider alerts, you need to edit the repository, organization, or enterprise settings. For more information about alert types, see "[Supported secrets](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." {% elsif bulk-code-scanning-query-suite and not fpt %} -{% note %} - -**Note:** For {% ifversion code-security-multi-repo-enablement %}both the single and multiple {% else %}the single {% endif %}repository enablement settings, enabling {% data variables.product.prodname_code_scanning %} will override any existing {% data variables.product.prodname_code_scanning %} configurations for the selected repositories, including any previous query suite selections and workflows for advanced setups. - -{% endnote %} +> [!NOTE] +> For {% ifversion code-security-multi-repo-enablement %}both the single and multiple {% else %}the single {% endif %}repository enablement settings, enabling {% data variables.product.prodname_code_scanning %} will override any existing {% data variables.product.prodname_code_scanning %} configurations for the selected repositories, including any previous query suite selections and workflows for advanced setups. {% endif %} diff --git a/data/reusables/security/some-security-and-analysis-features-are-enabled-by-default.md b/data/reusables/security/some-security-and-analysis-features-are-enabled-by-default.md index 08b23b62267b..297fd4973b32 100644 --- a/data/reusables/security/some-security-and-analysis-features-are-enabled-by-default.md +++ b/data/reusables/security/some-security-and-analysis-features-are-enabled-by-default.md @@ -1,7 +1,6 @@ {% ifversion fpt or ghec %} -{% note %} -**Note**: You can't disable some security and analysis features that are enabled by default for public repositories. +> [!NOTE] +> You can't disable some security and analysis features that are enabled by default for public repositories. -{% endnote %} {% endif %} diff --git a/data/reusables/ssh/apple-use-keychain.md b/data/reusables/ssh/apple-use-keychain.md index 913560e08e04..fa630a7aa688 100644 --- a/data/reusables/ssh/apple-use-keychain.md +++ b/data/reusables/ssh/apple-use-keychain.md @@ -1,11 +1,8 @@ -{% note %} - -**Note:** The `--apple-use-keychain` option stores the passphrase in your keychain for you when you add an SSH key to the ssh-agent. If you chose not to add a passphrase to your key, run the command without the `--apple-use-keychain` option. - -The `--apple-use-keychain` option is in Apple's standard version of `ssh-add`. In macOS versions prior to Monterey (12.0), the `--apple-use-keychain` and `--apple-load-keychain` flags used the syntax `-K` and `-A`, respectively. - -If you don't have Apple's standard version of `ssh-add` installed, you may receive an error. For more information, see "[AUTOTITLE](/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain)." - -If you continue to be prompted for your passphrase, you may need to add the command to your `~/.zshrc` file (or your `~/.bashrc` file for bash). - -{% endnote %} +> [!NOTE] +> The `--apple-use-keychain` option stores the passphrase in your keychain for you when you add an SSH key to the ssh-agent. If you chose not to add a passphrase to your key, run the command without the `--apple-use-keychain` option. +> +> The `--apple-use-keychain` option is in Apple's standard version of `ssh-add`. In macOS versions prior to Monterey (12.0), the `--apple-use-keychain` and `--apple-load-keychain` flags used the syntax `-K` and `-A`, respectively. +> +> If you don't have Apple's standard version of `ssh-add` installed, you may receive an error. For more information, see "[AUTOTITLE](/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain)." +> +> If you continue to be prompted for your passphrase, you may need to add the command to your `~/.zshrc` file (or your `~/.bashrc` file for bash). diff --git a/data/reusables/ssh/key-type-support.md b/data/reusables/ssh/key-type-support.md index 5714213b7319..cb74c84f4981 100644 --- a/data/reusables/ssh/key-type-support.md +++ b/data/reusables/ssh/key-type-support.md @@ -1,11 +1,10 @@ {% ifversion fpt or ghec %} -{% note %} -**Note:** {% data variables.product.company_short %} improved security by dropping older, insecure key types on March 15, 2022. +> [!NOTE] +> {% data variables.product.company_short %} improved security by dropping older, insecure key types on March 15, 2022. +> +> As of that date, DSA keys (`ssh-dss`) are no longer supported. You cannot add new DSA keys to your personal account on {% data variables.product.prodname_dotcom %}. +> +> RSA keys (`ssh-rsa`) with a `valid_after` before November 2, 2021 may continue to use any signature algorithm. RSA keys generated after that date must use a SHA-2 signature algorithm. Some older clients may need to be upgraded in order to use SHA-2 signatures. -As of that date, DSA keys (`ssh-dss`) are no longer supported. You cannot add new DSA keys to your personal account on {% data variables.product.prodname_dotcom %}. - -RSA keys (`ssh-rsa`) with a `valid_after` before November 2, 2021 may continue to use any signature algorithm. RSA keys generated after that date must use a SHA-2 signature algorithm. Some older clients may need to be upgraded in order to use SHA-2 signatures. - -{% endnote %} {% endif %} diff --git a/data/reusables/subversion/sunset.md b/data/reusables/subversion/sunset.md index 63e9502de812..0ebce3e3617d 100644 --- a/data/reusables/subversion/sunset.md +++ b/data/reusables/subversion/sunset.md @@ -1,8 +1,4 @@ -{% note %} - -**Note**: Subversion support will be removed with {% data variables.product.prodname_dotcom %} -version 3.13. For more information, see [the GitHub blog][svn-sunset-blog]. - -[svn-sunset-blog]: https://github.blog/2023-01-20-sunsetting-subversion-support/ - -{% endnote %} +> [!NOTE] +> Subversion support will be removed with {% data variables.product.prodname_dotcom %} version 3.13. For more information, see [the GitHub blog][svn-sunset-blog]. +> +> [svn-sunset-blog]: https://github.blog/2023-01-20-sunsetting-subversion-support/ diff --git a/data/reusables/support/entitlements-note.md b/data/reusables/support/entitlements-note.md index 450a503935e1..0a29c64e1cbe 100644 --- a/data/reusables/support/entitlements-note.md +++ b/data/reusables/support/entitlements-note.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** You must have an enterprise support entitlement to view tickets associated with an organization or enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." - -{% endnote %} +> [!NOTE] +> You must have an enterprise support entitlement to view tickets associated with an organization or enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." diff --git a/data/reusables/support/submit-a-ticket.md b/data/reusables/support/submit-a-ticket.md index 87248d38171d..d57348a1f966 100644 --- a/data/reusables/support/submit-a-ticket.md +++ b/data/reusables/support/submit-a-ticket.md @@ -1,20 +1,17 @@ {% ifversion fpt %} 1. At the top of the page, under "How can we help?", choose a topic or click **open a support ticket**. - {% note %} - **Note:** You will only see the link to open a support ticket if your account uses a paid {% data variables.product.prodname_dotcom %} product or you are a member of an organization that uses a paid product. If you don't see the link, you can speak to {% data variables.product.prodname_dotcom %} users and staff on the {% data variables.contact.community_support_forum %} for most issues, and you can still contact {% data variables.contact.github_support %} to report account, security, and abuse issues. + > [!NOTE] + > You will only see the link to open a support ticket if your account uses a paid {% data variables.product.prodname_dotcom %} product or you are a member of an organization that uses a paid product. If you don't see the link, you can speak to {% data variables.product.prodname_dotcom %} users and staff on the {% data variables.contact.community_support_forum %} for most issues, and you can still contact {% data variables.contact.github_support %} to report account, security, and abuse issues. - {% endnote %} {%- endif %} {% ifversion ghec or ghes %} 1. Select the **Select personal account, enterprise account or organization** dropdown menu and click the name of the account your support ticket is regarding. - {% note %} - **Notes:** - * For Premium, Premium Plus, or Engineering Direct support, you need to choose an enterprise account with a {% data variables.contact.premium_support %} plan. If you don't see an Enterprises section in the dropdown menu, you're not entitled to open support tickets on behalf of an enterprise account. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-support#about-support-entitlement)" - * To see a list of your enterprise accounts with a {% data variables.contact.premium_support %} plan, you must be signed into the {% data variables.contact.enterprise_portal %}. For more information, see "[AUTOTITLE](/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal)." + > [!NOTE] + > * For Premium, Premium Plus, or Engineering Direct support, you need to choose an enterprise account with a {% data variables.contact.premium_support %} plan. If you don't see an Enterprises section in the dropdown menu, you're not entitled to open support tickets on behalf of an enterprise account. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-support#about-support-entitlement)" + > * To see a list of your enterprise accounts with a {% data variables.contact.premium_support %} plan, you must be signed into the {% data variables.contact.enterprise_portal %}. For more information, see "[AUTOTITLE](/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal)." - {% endnote %} {% endif %} 1. Select the **From** dropdown menu and click the email address you'd like {% data variables.contact.github_support %} to contact. @@ -50,11 +47,9 @@ {%- ifversion ghes or ghec %} 1. Optionally, if your account includes {% data variables.contact.premium_support %} and your ticket is about a system failure or a critical outage currently blocking business operations in production, you can request a callback in English. Select **Request a callback from {% data variables.contact.github_support %}**, select the country code dropdown menu to choose your country, and enter your phone number. - {% note %} + > [!NOTE] + > You will only receive a callback if required for ticket resolution. - **Note:** You will only receive a callback if required for ticket resolution. - - {% endnote %} {%- endif %} 1. Under "Subject", type a descriptive title for the issue you're having. 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. @@ -66,11 +61,8 @@ You can attach files up to 50MB.{% ifversion ghes %} For larger attachments, such as support bundles, see "[AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)."{% endif %} - {% warning %} - - **Warning:** When you upload an image or video to a pull request or issue comment, or upload a file to a ticket in the {% data variables.contact.landing_page_portal %}, anyone can view the anonymized URL without authentication, even if the pull request or issue is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. To keep sensitive media files private, serve them from a private network or server that requires authentication. {% ifversion fpt or ghec %}For more information on anonymized URLs see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-anonymized-urls)."{% endif %} - - {% endwarning %} + > [!WARNING] + > When you upload an image or video to a pull request or issue comment, or upload a file to a ticket in the {% data variables.contact.landing_page_portal %}, anyone can view the anonymized URL without authentication, even if the pull request or issue is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. To keep sensitive media files private, serve them from a private network or server that requires authentication. {% ifversion fpt or ghec %}For more information on anonymized URLs see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-anonymized-urls)."{% endif %} {%- ifversion ghes %} 1. Optionally, attach diagnostics files and other files by dragging and dropping, uploading, or pasting from the clipboard. diff --git a/data/reusables/support/support-portal-notes.md b/data/reusables/support/support-portal-notes.md index afa27b265ea2..5bdad0f71ca6 100644 --- a/data/reusables/support/support-portal-notes.md +++ b/data/reusables/support/support-portal-notes.md @@ -1,8 +1,3 @@ -{% note %} - -**Notes:** - -* Urgent priority and {% data variables.contact.premium_support %} SLAs only apply to tickets associated with your enterprise account. -* Tickets associated with an enterprise account can only be opened by owners, billing managers, and support-entitled members. - -{% endnote %} +> [!NOTE] +> * Urgent priority and {% data variables.contact.premium_support %} SLAs only apply to tickets associated with your enterprise account. +> * Tickets associated with an enterprise account can only be opened by owners, billing managers, and support-entitled members. diff --git a/data/reusables/support/zendesk-old-tickets.md b/data/reusables/support/zendesk-old-tickets.md index ae32b953b8eb..a19c27b4927f 100644 --- a/data/reusables/support/zendesk-old-tickets.md +++ b/data/reusables/support/zendesk-old-tickets.md @@ -1,7 +1,6 @@ {% ifversion ghes %} -{% note %} -**Note**: If you have previously contacted {% data variables.contact.enterprise_support %} through the GitHub Enterprise Support portal, which is {% data variables.release-phases.closing_down %}, you should use the {% data variables.contact.contact_enterprise_portal %} to open new tickets. +> [!NOTE] +> If you have previously contacted {% data variables.contact.enterprise_support %} through the GitHub Enterprise Support portal, which is {% data variables.release-phases.closing_down %}, you should use the {% data variables.contact.contact_enterprise_portal %} to open new tickets. -{% endnote %} {% endif %} diff --git a/data/reusables/two_fa/mandatory-2fa-contributors-2023.md b/data/reusables/two_fa/mandatory-2fa-contributors-2023.md index e4d9ddcfa2c9..2b235c250bf0 100644 --- a/data/reusables/two_fa/mandatory-2fa-contributors-2023.md +++ b/data/reusables/two_fa/mandatory-2fa-contributors-2023.md @@ -1,7 +1,4 @@ -{% note %} - -**Note:** {% data reusables.two_fa.mandatory-2fa-contributors-2023-nested %} - -For more information about the 2FA enrollment rollout, see [this blog post](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13). - -{% endnote %} +> [!NOTE] +> {% data reusables.two_fa.mandatory-2fa-contributors-2023-nested %} +> +> For more information about the 2FA enrollment rollout, see [this blog post](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13). diff --git a/data/reusables/two_fa/sms-warning.md b/data/reusables/two_fa/sms-warning.md index ebf38c0a14bc..a1f9ae80048a 100644 --- a/data/reusables/two_fa/sms-warning.md +++ b/data/reusables/two_fa/sms-warning.md @@ -1,7 +1,4 @@ Before using this method, be sure that you can receive text messages. Carrier rates may apply. -{% warning %} - -**Warning:** We **strongly recommend** using a TOTP application for two-factor authentication instead of SMS, and security keys as backup methods instead of SMS. {% data variables.product.product_name %} doesn't support sending SMS messages to phones in every country. Before configuring authentication via text message, review the list of countries where {% data variables.product.product_name %} supports authentication via SMS. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported)." - -{% endwarning %} +> [!WARNING] +> We **strongly recommend** using a TOTP application for two-factor authentication instead of SMS, and security keys as backup methods instead of SMS. {% data variables.product.product_name %} doesn't support sending SMS messages to phones in every country. Before configuring authentication via text message, review the list of countries where {% data variables.product.product_name %} supports authentication via SMS. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported)." diff --git a/data/reusables/user-settings/marketplace_apps.md b/data/reusables/user-settings/marketplace_apps.md index 7f3a9d0159b1..be6c4b502288 100644 --- a/data/reusables/user-settings/marketplace_apps.md +++ b/data/reusables/user-settings/marketplace_apps.md @@ -1,11 +1,8 @@ {% ifversion fpt or ghec %} 1. In the left sidebar, click either **OAuth Apps** or **GitHub Apps** depending on the {% data variables.product.prodname_marketplace %} listing you'd like to manage. - {% note %} - - **Note:** You can also manage your listing by navigating to https://github.com/marketplace/manage. - - {% endnote %} + > [!NOTE] + > You can also manage your listing by navigating to https://github.com/marketplace/manage. ![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) diff --git a/data/reusables/user-settings/password-authentication-deprecation-desktop.md b/data/reusables/user-settings/password-authentication-deprecation-desktop.md index 44e5c67efaf6..4908686b7ce7 100644 --- a/data/reusables/user-settings/password-authentication-deprecation-desktop.md +++ b/data/reusables/user-settings/password-authentication-deprecation-desktop.md @@ -1,5 +1,2 @@ -{% warning %} - -**Warning**: Authenticating to {% data variables.product.prodname_dotcom %} using your username and password is not supported. We require authenticating using the browser instead. - -{% endwarning %} +> [!WARNING] +> Authenticating to {% data variables.product.prodname_dotcom %} using your username and password is not supported. We require authenticating using the browser instead. diff --git a/data/reusables/user-settings/pat-v2-org-opt-in.md b/data/reusables/user-settings/pat-v2-org-opt-in.md index a98cf08bbf70..3bb75fd1d137 100644 --- a/data/reusables/user-settings/pat-v2-org-opt-in.md +++ b/data/reusables/user-settings/pat-v2-org-opt-in.md @@ -1,7 +1,4 @@ -{% note %} - -**Note**: {% data reusables.user-settings.pat-v2-beta %} - -During the {% data variables.release-phases.public_preview %}, organizations must opt in to {% data variables.product.pat_v2 %}s. {% ifversion ghec or ghes %}If your organization is owned by an enterprise, and the enterprise has opted in to {% data variables.product.pat_v2 %}s, then your organization is opted in by default. {% endif %}If your organization has not already opted-in, then you will be prompted to opt-in and set policies when you follow the steps below. - -{% endnote %} +> [!NOTE] +> {% data reusables.user-settings.pat-v2-beta %} +> +> During the {% data variables.release-phases.public_preview %}, organizations must opt in to {% data variables.product.pat_v2 %}s. {% ifversion ghec or ghes %}If your organization is owned by an enterprise, and the enterprise has opted in to {% data variables.product.pat_v2 %}s, then your organization is opted in by default. {% endif %}If your organization has not already opted-in, then you will be prompted to opt-in and set policies when you follow the steps below. diff --git a/data/reusables/webhooks/discussions-webhooks-beta.md b/data/reusables/webhooks/discussions-webhooks-beta.md index cff8d25c5137..5405a5afd497 100644 --- a/data/reusables/webhooks/discussions-webhooks-beta.md +++ b/data/reusables/webhooks/discussions-webhooks-beta.md @@ -1,5 +1,2 @@ -{% note %} - -**Note:** Webhook events for {% data variables.product.prodname_discussions %} are currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Webhook events for {% data variables.product.prodname_discussions %} are currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/webhooks/webhooks-ipv6.md b/data/reusables/webhooks/webhooks-ipv6.md index f77c6e658b5b..b40f40a0af60 100644 --- a/data/reusables/webhooks/webhooks-ipv6.md +++ b/data/reusables/webhooks/webhooks-ipv6.md @@ -1,5 +1,2 @@ -{% note %} - -**Note**: {% data variables.product.company_short %} webhooks do not currently support IPv6 but will in the future. The `/meta` REST API endpoint returns IPv6 ranges to enable that transition. - -{% endnote %} +> [!NOTE] +> {% data variables.product.company_short %} webhooks do not currently support IPv6 but will in the future. The `/meta` REST API endpoint returns IPv6 ranges to enable that transition.