From 74534576f16515d6e9ddd3c4176d6c668dcbb593 Mon Sep 17 00:00:00 2001 From: Artur Kordowski <9746197+akordowski@users.noreply.github.com> Date: Tue, 12 Nov 2024 01:08:22 +0100 Subject: [PATCH] Fix inconsistent alerts by using the markdown notation - part 3 (#35222) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../accessing-your-organizations-settings.md | 7 +-- ...s-for-dependencies-in-your-organization.md | 14 ++--- .../about-team-discussions.md | 7 +-- ...rvice-accounts-with-saml-single-sign-on.md | 7 +-- ...embers-saml-access-to-your-organization.md | 13 ++--- .../audit-log-events-for-your-organization.md | 13 ++--- ...-in-the-audit-log-for-your-organization.md | 7 +-- ...owed-ip-addresses-for-your-organization.md | 16 ++---- ...analysis-settings-for-your-organization.md | 36 ++++-------- ...ail-notifications-for-your-organization.md | 5 +- ...ing-the-audit-log-for-your-organization.md | 21 ++----- ...accounts-with-two-factor-authentication.md | 13 ++--- ...tor-authentication-in-your-organization.md | 24 +++----- ...s-in-your-organization-have-2fa-enabled.md | 7 +-- ...-project-board-for-organization-members.md | 7 +-- ...access-to-an-organization-project-board.md | 7 +-- ...access-to-an-organization-project-board.md | 17 ++---- .../about-ssh-certificate-authorities.md | 13 ++--- ...nviting-users-to-join-your-organization.md | 11 ++-- ...emoving-a-member-from-your-organization.md | 30 ++++------ .../about-oauth-app-access-restrictions.md | 7 +-- ...cess-restrictions-for-your-organization.md | 7 +-- ...cess-restrictions-for-your-organization.md | 12 ++-- .../archiving-an-organization.md | 7 +-- ...hub-hosted-runners-in-your-organization.md | 14 ++--- .../converting-an-organization-into-a-user.md | 7 +-- ...nouncement-banner-for-your-organization.md | 11 ++-- .../deleting-an-organization-account.md | 11 ++-- ...ng-github-actions-for-your-organization.md | 14 ++--- .../managing-base-permissions-for-projects.md | 7 +-- .../renaming-an-organization.md | 7 +-- ...epository-creation-in-your-organization.md | 12 ++-- ...visibility-changes-in-your-organization.md | 7 +-- ...ssions-for-adding-outside-collaborators.md | 5 +- .../transferring-organization-ownership.md | 13 ++--- ...pproving-a-domain-for-your-organization.md | 5 +- ...-a-billing-manager-to-your-organization.md | 19 ++----- ...ership-continuity-for-your-organization.md | 7 +-- ...-billing-manager-from-your-organization.md | 7 +-- ...onal-access-tokens-in-your-organization.md | 7 +-- ...ess-management-with-saml-single-sign-on.md | 7 +-- .../about-scim-for-organizations.md | 7 +-- ...saml-single-sign-on-and-scim-using-okta.md | 7 +-- ...-identity-provider-to-your-organization.md | 11 ++-- ...ml-single-sign-on-for-your-organization.md | 6 +- ...ions-saml-single-sign-on-recovery-codes.md | 7 +-- ...ml-single-sign-on-for-your-organization.md | 19 ++----- ...ml-single-sign-on-for-your-organization.md | 7 +-- ...m-synchronization-for-your-organization.md | 7 +-- ...ation-member-to-an-outside-collaborator.md | 7 +-- ...llaborators-access-to-your-organization.md | 25 +++------ ...borator-from-an-organization-repository.md | 11 +--- ...am-access-to-an-organization-repository.md | 10 +--- .../repository-roles-for-an-organization.md | 21 ++----- ...ng-base-permissions-for-an-organization.md | 11 +--- ...g-people-with-access-to-your-repository.md | 5 +- ...am-to-improved-organization-permissions.md | 12 ++-- ...am-to-improved-organization-permissions.md | 14 ++--- ...ms-to-improved-organization-permissions.md | 7 +-- ...e-team-maintainer-role-to-a-team-member.md | 7 +-- .../changing-team-visibility.md | 7 +-- .../configuring-team-notifications.md | 7 +-- .../creating-a-team.md | 12 ++-- .../deleting-a-team.md | 7 +-- ...-a-team-in-your-organizations-hierarchy.md | 10 +--- ...-packages-access-control-and-visibility.md | 36 ++++-------- .../deleting-and-restoring-a-package.md | 10 +--- .../introduction-to-github-packages.md | 9 ++- ...nstalling-a-package-with-github-actions.md | 16 ++---- ...ainer-registry-from-the-docker-registry.md | 7 +-- .../working-with-the-docker-registry.md | 20 ++----- .../working-with-the-gradle-registry.md | 7 +-- .../working-with-the-npm-registry.md | 14 ++--- .../working-with-the-rubygems-registry.md | 7 +-- .../about-custom-domains-and-github-pages.md | 7 +-- ...ustom-domain-for-your-github-pages-site.md | 32 ++++------- ...shing-source-for-your-github-pages-site.md | 5 +- ...uring-your-github-pages-site-with-https.md | 14 ++--- .../about-github-pages-and-jekyll.md | 7 +-- ...yll-build-errors-for-github-pages-sites.md | 7 +-- ...r-github-pages-site-locally-with-jekyll.md | 24 ++++---- .../resolving-a-merge-conflict-on-github.md | 14 ++--- ...a-merge-conflict-using-the-command-line.md | 7 +-- .../about-status-checks.md | 14 ++--- .../troubleshooting-required-status-checks.md | 46 ++++++--------- .../about-collaborative-development-models.md | 7 +-- .../automatically-merging-a-pull-request.md | 10 ++-- .../closing-a-pull-request.md | 6 +- ...rging-a-pull-request-with-a-merge-queue.md | 14 ++--- .../merging-a-pull-request.md | 21 +++---- .../reverting-a-pull-request.md | 17 +++--- .../about-branches.md | 7 +-- ...out-comparing-branches-in-pull-requests.md | 13 ++--- .../about-pull-requests.md | 21 +++---- ...nging-the-base-branch-of-a-pull-request.md | 13 ++--- .../changing-the-stage-of-a-pull-request.md | 7 +-- ...pull-request-branch-created-from-a-fork.md | 24 +++----- .../creating-a-pull-request.md | 10 +--- ...eleting-branches-within-your-repository.md | 14 ++--- .../requesting-a-pull-request-review.md | 7 +-- ...ery-parameters-to-create-a-pull-request.md | 7 +-- .../about-pull-request-reviews.md | 7 +-- ...ng-a-pull-request-with-required-reviews.md | 7 +-- .../checking-out-pull-requests-locally.md | 13 ++--- .../commenting-on-a-pull-request.md | 17 ++---- .../filtering-files-in-a-pull-request.md | 14 ++--- ...methods-and-functions-in-a-pull-request.md | 7 +-- ...ng-dependency-changes-in-a-pull-request.md | 7 +-- .../working-with-forks/about-forks.md | 7 +-- .../working-with-forks/detaching-a-fork.md | 25 +++------ .../working-with-forks/fork-a-repo.md | 5 +- .../working-with-forks/syncing-a-fork.md | 7 +-- .../about-commits.md | 7 +-- ...g-a-commit-on-behalf-of-an-organization.md | 7 +-- ...creating-a-commit-with-multiple-authors.md | 18 ++---- ...sts-on-github-but-not-in-my-local-clone.md | 7 +-- ...are-my-commits-linked-to-the-wrong-user.md | 6 +- .../comparing-commits.md | 7 +-- .../archiving-repositories.md | 10 ++-- .../backing-up-a-repository.md | 14 ++--- .../referencing-and-citing-content.md | 12 ++-- .../about-merge-methods-on-github.md | 5 +- .../managing-a-merge-queue.md | 34 ++++------- .../changing-the-default-branch.md | 5 +- .../about-protected-branches.md | 26 +++------ .../managing-a-branch-protection-rule.md | 12 ++-- .../managing-rulesets-for-a-repository.md | 10 ++-- .../about-repositories.md | 10 ++-- .../creating-a-new-repository.md | 13 ++--- .../creating-a-repository-from-a-template.md | 13 ++--- .../creating-a-template-repository.md | 12 ++-- .../deleting-a-repository.md | 11 +--- .../duplicating-a-repository.md | 7 +-- .../renaming-a-repository.md | 14 ++--- .../transferring-a-repository.md | 6 +- .../troubleshooting-cloning-errors.md | 7 +-- .../about-code-owners.md | 32 +++++------ ...classifying-your-repository-with-topics.md | 7 +-- ...g-your-repositorys-social-media-preview.md | 13 ++--- ...ing-a-sponsor-button-in-your-repository.md | 7 +-- .../licensing-a-repository.md | 7 +-- ...d-analysis-settings-for-your-repository.md | 13 ++--- ...ing-the-push-policy-for-your-repository.md | 7 +-- .../setting-repository-visibility.md | 21 +++---- ...wing-your-repositorys-releases-and-tags.md | 6 +- ...anding-connections-between-repositories.md | 7 +-- .../viewing-a-projects-contributors.md | 7 +-- ...deployment-activity-for-your-repository.md | 6 +- .../viewing-traffic-to-a-repository.md | 7 +-- .../adding-a-file-to-a-repository.md | 7 +-- .../managing-files/editing-files.md | 14 ++--- .../moving-a-file-to-a-new-location.md | 13 ++--- .../managing-files/renaming-a-file.md | 13 ++--- .../about-git-large-file-storage.md | 10 +--- .../about-large-files-on-github.md | 14 ++--- .../about-storage-and-bandwidth-usage.md | 10 +--- ...llaboration-with-git-large-file-storage.md | 7 +-- .../configuring-git-large-file-storage.md | 22 +++----- .../installing-git-large-file-storage.md | 36 ++++-------- ...ur-repository-to-git-large-file-storage.md | 7 +-- ...oving-files-from-git-large-file-storage.md | 13 ++--- .../downloading-source-code-archives.md | 7 +-- .../getting-permanent-links-to-files.md | 13 ++--- .../using-files/viewing-a-file.md | 7 +-- .../working-with-non-code-files.md | 24 +++----- .../authenticating-to-the-rest-api.md | 7 +-- content/rest/checks/runs.md | 7 +-- content/rest/checks/suites.md | 14 ++--- .../rest/codespaces/organization-secrets.md | 7 +-- content/rest/dependabot/alerts.md | 7 +-- content/rest/enterprise-admin/index.md | 7 +-- content/rest/enterprise-admin/scim.md | 21 +++---- content/rest/guides/building-a-ci-server.md | 5 +- content/rest/guides/delivering-deployments.md | 5 +- ...ipting-with-the-rest-api-and-javascript.md | 21 ++++--- .../scripting-with-the-rest-api-and-ruby.md | 28 ++++------ ...-api-to-interact-with-your-git-database.md | 7 +-- content/rest/migrations/source-imports.md | 7 +-- content/rest/orgs/personal-access-tokens.md | 7 +-- content/rest/quickstart.md | 56 ++++++++----------- content/rest/releases/releases.md | 7 +-- content/rest/scim/scim.md | 25 +++------ .../security-advisories/global-advisories.md | 7 +-- content/rest/teams/external-groups.md | 9 +-- content/rest/teams/members.md | 7 +-- content/rest/teams/team-sync.md | 7 +-- .../best-practices-for-using-the-rest-api.md | 7 +-- .../getting-started-with-the-rest-api.md | 35 ++++-------- .../rate-limits-for-the-rest-api.md | 7 +-- .../about-searching-on-github.md | 15 ++--- .../sorting-search-results.md | 5 +- .../understanding-the-search-syntax.md | 5 +- ...understanding-github-code-search-syntax.md | 14 ++--- .../finding-files-on-github.md | 10 +--- .../searching-on-github/searching-code.md | 9 ++- .../searching-on-github/searching-in-forks.md | 7 +-- .../searching-issues-and-pull-requests.md | 22 ++++---- .../github-corporate-terms-of-service.md | 7 +-- .../github-educational-use-agreement.md | 7 +-- .../about-github-sponsors.md | 7 +-- .../managing-your-sponsorship-tiers.md | 6 +- .../tax-information-for-github-sponsors.md | 10 ++-- ...count-from-your-github-sponsors-profile.md | 7 +-- .../about-sponsorships-fees-and-taxes.md | 21 ++----- .../paying-for-github-sponsors-by-invoice.md | 7 +-- ...-open-source-contributor-through-github.md | 7 +-- ...inking-your-patreon-account-from-github.md | 7 +-- .../creating-a-support-ticket.md | 7 +-- .../providing-data-to-github-support.md | 7 +-- .../about-github-premium-support.md | 19 ++----- .../about-github-support.md | 7 +-- content/webhooks/about-webhooks.md | 7 +-- ...hub-cli-to-forward-webhooks-for-testing.md | 14 ++--- .../best-practices-for-using-webhooks.md | 7 +-- .../using-webhooks/creating-webhooks.md | 7 +-- 215 files changed, 810 insertions(+), 1714 deletions(-) diff --git a/content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md b/content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md index e15c4e20fd5d..3dd2140c590e 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md +++ b/content/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings.md @@ -21,11 +21,8 @@ shortTitle: Access organization settings --- {% ifversion fpt or ghec %} -{% tip %} - -**Tip:** Only organization owners and billing managers can see and change the billing information and the full set of account settings for an organization. Organization moderators only see moderation settings. {% data reusables.organizations.new-org-permissions-more-info %} - -{% endtip %} +> [!TIP] +> Only organization owners and billing managers can see and change the billing information and the full set of account settings for an organization. Organization moderators only see moderation settings. {% data reusables.organizations.new-org-permissions-more-info %} {% endif %} diff --git a/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md b/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md index a2e2c388b4c1..094a555cd4bd 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md +++ b/content/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization.md @@ -14,21 +14,15 @@ shortTitle: Dependency insights permissions: '{% data reusables.permissions.dependency-graph-view-org-insights %}' --- -{% note %} - -**Note:** To view organization dependency insights, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} - -{% endnote %} +> [!NOTE] +> To view organization dependency insights, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} ## Viewing organization dependency insights Dependency insights can help you track, report, and act on your organization's open source usage. -{% note %} - -**Note:** Please make sure you have enabled the [Dependency Graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph). - -{% endnote %} +> [!NOTE] +> Please make sure you have enabled the [Dependency Graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph). With dependency insights you can view vulnerabilities, licenses, and other important information for the open source projects your organization depends on. diff --git a/content/organizations/collaborating-with-your-team/about-team-discussions.md b/content/organizations/collaborating-with-your-team/about-team-discussions.md index 5f571bfe3e46..96220e0f651a 100644 --- a/content/organizations/collaborating-with-your-team/about-team-discussions.md +++ b/content/organizations/collaborating-with-your-team/about-team-discussions.md @@ -26,11 +26,8 @@ You can link to any team discussion to reference it elsewhere. You can pin impor When someone posts or replies to a public discussion on a team's page, members of the team and members of any child teams receive email or web notifications. When someone posts or replies to a private discussion on a team's page, only members of the team receive notifications. -{% tip %} - -**Tip:** Depending on your notification settings, you'll receive updates by email, the web notifications page on {% data variables.product.product_name %}, or both. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications)." - -{% endtip %} +> [!TIP] +> Depending on your notification settings, you'll receive updates by email, the web notifications page on {% data variables.product.product_name %}, or both. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications)." By default, if your username is mentioned in a team discussion, you'll receive notifications for the post mentioning your username and any replies to that post. Also, by default, if you reply to a post, you will receive notifications for other replies to the post. diff --git a/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md index 8d6c4c2ca01e..eed77534722f 100644 --- a/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md +++ b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/managing-bots-and-service-accounts-with-saml-single-sign-on.md @@ -14,11 +14,8 @@ shortTitle: Manage bots & service accounts To retain access for bots and service accounts, organization administrators can [enable](/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization), but **not** [enforce](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization) SAML single sign-on for their organization. If you need to enforce SAML single sign-on for your organization, you can create an external identity for the bot or service account with your identity provider (IdP). -{% warning %} - -**Note:** If you enforce SAML single sign-on for your organization and **do not** have external identities set up for bots and service accounts with your IdP, they will be removed from your organization. - -{% endwarning %} +> [!NOTE] +> If you enforce SAML single sign-on for your organization and **do not** have external identities set up for bots and service accounts with your IdP, they will be removed from your organization. ## Further reading diff --git a/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md index 02d4b6e3cc2d..74497a6abd5b 100644 --- a/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md +++ b/content/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization.md @@ -26,14 +26,11 @@ You can view and revoke each member's linked identity, active sessions, and auth When available, the entry will include SCIM data. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." -{% warning %} - -**Warning:** For organizations using SCIM: -* Revoking a linked user identity on {% data variables.product.product_name %} will also remove the SAML and SCIM metadata. As a result, the identity provider will not be able to synchronize or deprovision the linked user identity. -* An admin must revoke a linked identity through the identity provider. -* To revoke a linked identity and link a different account through the identity provider, an admin can remove and re-assign the user to the {% data variables.product.product_name %} application. For more information, see your identity provider's documentation. - -{% endwarning %} +> [!WARNING] +> For organizations using SCIM: +> * Revoking a linked user identity on {% data variables.product.product_name %} will also remove the SAML and SCIM metadata. As a result, the identity provider will not be able to synchronize or deprovision the linked user identity. +> * An admin must revoke a linked identity through the identity provider. +> * To revoke a linked identity and link a different account through the identity provider, an admin can remove and re-assign the user to the {% data variables.product.product_name %} application. For more information, see your identity provider's documentation. {% data reusables.identity-and-permissions.revoking-identity-team-sync %} diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md index 39addcf3e86a..59c4f8aedd51 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md @@ -12,15 +12,12 @@ shortTitle: Audit log events autogenerated: audit-logs --- -{% note %} - -**Notes**: +> [!NOTE] {% ifversion ghes %} -* This article contains the events available in the latest version of {% data variables.product.prodname_ghe_server %}. Some of the events may not be available in previous versions.{% endif %} -* This article contains the events that may appear in your organization's audit log. For the events that can appear in a user account's security log{% ifversion ghec or ghes %} or the audit log for an enterprise{% endif %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/security-log-events){% ifversion ghec or ghes %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)."{% else %}."{% endif %} -* {% data reusables.webhooks.webhooks-as-audit-log-alternative %} - -{% endnote %} +> * This article contains the events available in the latest version of {% data variables.product.prodname_ghe_server %}. Some of the events may not be available in previous versions. +{% endif %} +> * This article contains the events that may appear in your organization's audit log. For the events that can appear in a user account's security log{% ifversion ghec or ghes %} or the audit log for an enterprise{% endif %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/security-log-events){% ifversion ghec or ghes %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)."{% else %}."{% endif %} +> * {% data reusables.webhooks.webhooks-as-audit-log-alternative %} ## About audit log events for your organization diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization.md index 32a2572423c7..3f067543c0c5 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/displaying-ip-addresses-in-the-audit-log-for-your-organization.md @@ -13,11 +13,8 @@ topics: - Security --- -{% note %} - -**Note:** Displaying IP addresses in the audit log for an organization is in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> Displaying IP addresses in the audit log for an organization is in {% data variables.release-phases.public_preview %} and subject to change. ## About display of IP addresses in the audit log diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 64c0f0a4ac3e..6da93117d5b7 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -20,14 +20,11 @@ By default, authorized users can access your organization's resources from any I {% data reusables.identity-and-permissions.ip-allow-lists-cidr-notation %} {% ifversion ghec %} -{% note %} -**Notes:** +> [!NOTE] +> * Only organizations that use {% data variables.product.prodname_ghe_cloud %} can use IP allow lists. {% data reusables.enterprise.link-to-ghec-trial %} +> * If you configure 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. -* Only organizations that use {% data variables.product.prodname_ghe_cloud %} can use IP allow lists. {% data reusables.enterprise.link-to-ghec-trial %} -* If you configure 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 %} {% data reusables.identity-and-permissions.ip-allow-lists-which-resources-are-protected %} @@ -40,11 +37,8 @@ If you set up an allow list you can also choose to automatically add to your all You can also configure allowed IP addresses at the enterprise account level, and the entries in the enterprise account's allow list are inherited by all the organizations owned by the enterprise. {% data reusables.identity-and-permissions.org-enterprise-allow-list-interaction %} For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)." -{% warning %} - -**Warning:** Losing access to the IP addresses in your IP allow list could result in unintended consequences, such as getting locked out of your enterprise or organization. - -{% endwarning %} +> [!WARNING] +> Losing access to the IP addresses in your IP allow list could result in unintended consequences, such as getting locked out of your enterprise or organization. As a best practice, to ensure both secure and reliable access to your enterprise and organization resources when creating an IP allow list, consider the following: diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md index 2835e69283a3..55be3b1c4ec8 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md @@ -51,19 +51,13 @@ You can use security overview to find a set of repositories and enable or disabl {% data reusables.advanced-security.note-org-enable-uses-seats %} -{% note %} - -**Note:** If you encounter an error that reads "GitHub Advanced Security cannot be enabled because of a policy setting for the organization," contact your enterprise admin and ask them to change the GitHub Advanced Security policy for your enterprise. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." - -{% endnote %} +> [!NOTE] +> If you encounter an error that reads "GitHub Advanced Security cannot be enabled because of a policy setting for the organization," contact your enterprise admin and ask them to change the GitHub Advanced Security policy for your enterprise. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." {% ifversion dependabot-alerts-enterprise-enablement %} -{% note %} - -**Note:** When {% data variables.product.prodname_dependabot_alerts %} are enabled or disabled at the enterprise level, it overrides the organization level settings for {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts#managing-dependabot-alerts-for-your-enterprise)." - -{% endnote %} +> [!NOTE] +> When {% data variables.product.prodname_dependabot_alerts %} are enabled or disabled at the enterprise level, it overrides the organization level settings for {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts#managing-dependabot-alerts-for-your-enterprise)." {% endif %} @@ -79,13 +73,9 @@ You can use security overview to find a set of repositories and enable or disabl * Automatic enablement for a specific type of repository * Feature-specific settings, such as recommending the extended query suite for {% data variables.product.prodname_code_scanning %} default setup throughout your organization, or automatic secret validation for {% data variables.product.prodname_secret_scanning %} - {% note %} - - **Notes:** - * {% data reusables.code-scanning.limitation-org-enable-all %}{% ifversion bulk-code-scanning-query-suite %} - * Enabling {% data variables.product.prodname_code_scanning %} for all eligible repositories in an organization will not override existing {% data variables.product.prodname_code_scanning %} configurations. For information on configuring default setup with different settings for specific repositories, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning){% ifversion code-security-multi-repo-enablement %}" and "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale#configuring-default-setup-for-a-subset-of-repositories-in-an-organization){% endif %}."{% endif %} - - {% endnote %} + > [!NOTE] + > * {% data reusables.code-scanning.limitation-org-enable-all %}{% ifversion bulk-code-scanning-query-suite %} + > * Enabling {% data variables.product.prodname_code_scanning %} for all eligible repositories in an organization will not override existing {% data variables.product.prodname_code_scanning %} configurations. For information on configuring default setup with different settings for specific repositories, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning){% ifversion code-security-multi-repo-enablement %}" and "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale#configuring-default-setup-for-a-subset-of-repositories-in-an-organization){% endif %}."{% endif %} {% data reusables.security.displayed-information %} @@ -105,11 +95,10 @@ By default, {% data variables.product.prodname_dependabot %} can't update depend If your code depends on packages in a private{% ifversion ghec or ghes %} or internal{% endif %} registry, you can allow {% data variables.product.prodname_dependabot %} to update the versions of these dependencies by configuring this at the repository level. You do this by adding authentication details to the `dependabot.yml` file for the repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#configuration-options-for-private-registries)." {% ifversion ghec %} -{% note %} -**Note:** For the option to grant {% data variables.product.prodname_dependabot %} access to private or internal repositories to be available, you need {% data variables.product.prodname_dependabot_version_updates %} or {% data variables.product.prodname_dependabot_security_updates %} to be enabled on at least one repository within the organization. +> [!NOTE] +> For the option to grant {% data variables.product.prodname_dependabot %} access to private or internal repositories to be available, you need {% data variables.product.prodname_dependabot_version_updates %} or {% data variables.product.prodname_dependabot_security_updates %} to be enabled on at least one repository within the organization. -{% endnote %} {% endif %} {% ifversion security-configurations %} @@ -148,11 +137,8 @@ You can manage access to {% data variables.product.prodname_GH_advanced_security 1. To remove access to {% data variables.product.prodname_GH_advanced_security %} from a repository and free up {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} used by any active committers that are unique to the repository, click the adjacent {% octicon "x" aria-label="X symbol" %}. 1. In the confirmation dialog, click **Remove repository** to remove access to the features of {% data variables.product.prodname_GH_advanced_security %}. -{% note %} - -**Note:** If you remove access to {% data variables.product.prodname_GH_advanced_security %} for a repository, you should communicate with the affected development team so that they know that the change was intended. This ensures that they don't waste time debugging failed runs of code scanning. - -{% endnote %} +> [!NOTE] +> If you remove access to {% data variables.product.prodname_GH_advanced_security %} for a repository, you should communicate with the affected development team so that they know that the change was intended. This ensures that they don't waste time debugging failed runs of code scanning. {% endif %} diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md index b2eab199c70b..abeb7beb8a54 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md @@ -25,11 +25,10 @@ shortTitle: Restrict email notifications When restricted email notifications are enabled in an organization, members can only use an email address associated with a verified or approved domain to receive email notifications about organization activity. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." {% ifversion ghec %} -{% note %} -**Note:** To restrict email notifications, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> To restrict email notifications, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} {% data reusables.notifications.email-restrictions-verification %} diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index 8696c8a6618f..a03ac67b3127 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -17,11 +17,8 @@ shortTitle: Review audit log ## Accessing the audit log -{% note %} - -**Note:** {% data reusables.webhooks.webhooks-as-audit-log-alternative %} - -{% endnote %} +> [!NOTE] +> {% data reusables.webhooks.webhooks-as-audit-log-alternative %} The audit log lists events triggered by activities that affect your organization within the last 180 days. Only owners can access an organization's audit log. @@ -161,11 +158,8 @@ For example: * `created:<=2014-07-08` finds all events that occurred on or before July 8th, 2014. * `created:2014-07-01..2014-07-31` finds all events that occurred in the month of July 2014. -{% note %} - -**Note**: The audit log contains data for the last 180 days. - -{% endnote %} +> [!NOTE] +> The audit log contains data for the last 180 days. ### Search based on location @@ -206,11 +200,8 @@ You can interact with the audit log using the GraphQL API{% ifversion fpt or ghe {% ifversion ghec %} -{% note %} - -**Note:** To use the audit log API, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} - -{% endnote %} +> [!NOTE] +> To use the audit log API, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} ### Using the GraphQL API diff --git a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/managing-bots-and-service-accounts-with-two-factor-authentication.md b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/managing-bots-and-service-accounts-with-two-factor-authentication.md index 1ec2c36bf0c2..9f2450873ce0 100644 --- a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/managing-bots-and-service-accounts-with-two-factor-authentication.md +++ b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/managing-bots-and-service-accounts-with-two-factor-authentication.md @@ -14,11 +14,8 @@ shortTitle: Manage bots & service accounts You should ensure that 2FA is enabled for unattended or shared access accounts in your organization, such as bots and service accounts, so that these accounts stay protected. Enabling 2FA for a bot or service account ensures that users must authenticate with 2FA to sign in to the account on {% data variables.location.product_location %}. It does not affect the account's ability to authenticate with its existing tokens in automations. -{% note %} - -**Note:** When you require use of two-factor authentication for your organization, unattended accounts that do not use 2FA will be removed from the organization and will lose access to its repositories. - -{% endnote %} +> [!NOTE] +> When you require use of two-factor authentication for your organization, unattended accounts that do not use 2FA will be removed from the organization and will lose access to its repositories. ## Managing shared access to bots or service accounts with 2FA @@ -28,11 +25,9 @@ You should ensure that 2FA is enabled for unattended or shared access accounts i 1. Add the new mailing list address as a verified email address in the settings of the shared account. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)." 1. If you haven't already done so, configure 2FA for the bot or service account using an authenticator app (TOTP). For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa)." 1. Store the TOTP secret that's offered during 2FA setup in the password manager used by your organization. - {% note %} - - **Note:** Don't store the password for the shared account in the password manager. You will use the password reset functionality every time you need to sign in to the shared account. - {% endnote %} + > [!NOTE] + > Don't store the password for the shared account in the password manager. You will use the password reset functionality every time you need to sign in to the shared account. If you have already configured 2FA using TOTP and you need to locate the TOTP secret, use the following steps: diff --git a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md index 61ccf274f7c7..aba321fdba5f 100644 --- a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization.md @@ -28,25 +28,17 @@ product: 'Requiring two-factor authentication is available to organizations on a You can also require two-factor authentication for organizations in an enterprise. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise)." -{% note %} - -**Note**: Some of the users in your organization may have been selected for mandatory two-factor authentication enrollment by {% data variables.product.prodname_dotcom %}, but it has no impact on how you enable the 2FA requirement for your organization. If you enable the 2FA requirement in your organization, all users without 2FA currently enabled will be removed from your organization, including those that are required to enable it by {% data variables.product.prodname_dotcom %}. - -{% endnote %} +> [!NOTE] +> Some of the users in your organization may have been selected for mandatory two-factor authentication enrollment by {% data variables.product.prodname_dotcom %}, but it has no impact on how you enable the 2FA requirement for your organization. If you enable the 2FA requirement in your organization, all users without 2FA currently enabled will be removed from your organization, including those that are required to enable it by {% data variables.product.prodname_dotcom %}. {% endif %} -{% warning %} - -**Warnings:** - -* When you require use of two-factor authentication for your organization, {% ifversion fpt or ghec %}members and billing managers{% else %}members{% endif %} who do not use 2FA will not be able to access your organization's resources until they enable 2FA on their account. They will retain membership even without 2FA, including occupying seats in your organization. -* When you require use of two-factor authentication for your organization, outside collaborators who do not use 2FA will be removed from the organization and lose access to its repositories. They will also lose access to their forks of the organization's private repositories. You can reinstate their access privileges and settings if they enable 2FA for their personal account within three months of their removal from your organization. For more information, see "[AUTOTITLE](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." -* You will also need to enable two-factor authentication for unattended or shared access accounts that are outside collaborators, such as bots and service accounts. If you do not configure 2FA for these unattended outside collaborator accounts after you've enabled required 2FA, the accounts will be removed from the organization and lose access to their repositories. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/managing-bots-and-service-accounts-with-two-factor-authentication)." -* If an outside collaborator disables two-factor authentication for their personal account after you've enabled required 2FA, they will automatically be removed from the organization. -* If you're the sole owner of an organization that requires two-factor authentication, you won't be able to disable 2FA for your personal account without disabling required 2FA for the organization. - -{% endwarning %} +> [!WARNING] +> * When you require use of two-factor authentication for your organization, {% ifversion fpt or ghec %}members and billing managers{% else %}members{% endif %} who do not use 2FA will not be able to access your organization's resources until they enable 2FA on their account. They will retain membership even without 2FA, including occupying seats in your organization. +> * When you require use of two-factor authentication for your organization, outside collaborators who do not use 2FA will be removed from the organization and lose access to its repositories. They will also lose access to their forks of the organization's private repositories. You can reinstate their access privileges and settings if they enable 2FA for their personal account within three months of their removal from your organization. For more information, see "[AUTOTITLE](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." +> * You will also need to enable two-factor authentication for unattended or shared access accounts that are outside collaborators, such as bots and service accounts. If you do not configure 2FA for these unattended outside collaborator accounts after you've enabled required 2FA, the accounts will be removed from the organization and lose access to their repositories. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/managing-bots-and-service-accounts-with-two-factor-authentication)." +> * If an outside collaborator disables two-factor authentication for their personal account after you've enabled required 2FA, they will automatically be removed from the organization. +> * If you're the sole owner of an organization that requires two-factor authentication, you won't be able to disable 2FA for your personal account without disabling required 2FA for the organization. {% data reusables.two_fa.auth_methods_2fa %} diff --git a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/viewing-whether-users-in-your-organization-have-2fa-enabled.md b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/viewing-whether-users-in-your-organization-have-2fa-enabled.md index a91f22454818..15943ae70e9e 100644 --- a/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/viewing-whether-users-in-your-organization-have-2fa-enabled.md +++ b/content/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/viewing-whether-users-in-your-organization-have-2fa-enabled.md @@ -15,11 +15,8 @@ topics: shortTitle: View 2FA usage --- -{% note %} - -**Note:** You can require that all members{% ifversion fpt or ghec %}, including, owners, billing managers and{% else %} and{% endif %} outside collaborators in your organization have two-factor authentication enabled. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization)." - -{% endnote %} +> [!NOTE] +> You can require that all members{% ifversion fpt or ghec %}, including, owners, billing managers and{% else %} and{% endif %} outside collaborators in your organization have two-factor authentication enabled. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization)." {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md index d8994159e53b..1f587866babc 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members.md @@ -19,11 +19,8 @@ By default, organization members have write access to their organization's {% da ## Setting a baseline permission level for all organization members -{% tip %} - -**Tip:** You can give an organization member higher permissions to {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." - -{% endtip %} +> [!TIP] +> You can give an organization member higher permissions to {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md index 932312aa1e23..8eb70ffff192 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board.md @@ -16,11 +16,8 @@ allowTitleToDifferFromFilename: true {% data reusables.projects.project_boards_old %} -{% note %} - -**Note:** {% data reusables.project-management.cascading-permissions %} For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." - -{% endnote %} +> [!NOTE] +> {% data reusables.project-management.cascading-permissions %} For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." ## Giving an organization member access to a {% data variables.projects.projects_v1_board %} diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md b/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md index 44213f1de979..a9a191f0dab6 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board.md @@ -15,23 +15,16 @@ allowTitleToDifferFromFilename: true {% data reusables.projects.project_boards_old %} -{% warning %} - -**Warnings:** -* You can change a team's permission level if the team has direct access to a {% data variables.projects.projects_v1_board %}. If the team's access to the {% data variables.projects.projects_v1_board %} is inherited from a parent team, you must change the parent team's access to the {% data variables.projects.projects_v1_board %}. -* If you add or remove {% data variables.projects.projects_v1_board %} access for a parent team, each of that parent's child teams will also receive or lose access to the {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." - -{% endwarning %} +> [!WARNING] +> * You can change a team's permission level if the team has direct access to a {% data variables.projects.projects_v1_board %}. If the team's access to the {% data variables.projects.projects_v1_board %} is inherited from a parent team, you must change the parent team's access to the {% data variables.projects.projects_v1_board %}. +> * If you add or remove {% data variables.projects.projects_v1_board %} access for a parent team, each of that parent's child teams will also receive or lose access to the {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." ## Giving a team access to a {% data variables.projects.projects_v1_board %} You can give an entire team the same permission level to a {% data variables.projects.projects_v1_board %}. -{% note %} - -**Note:** {% data reusables.project-management.cascading-permissions %} For example, if an organization owner has given a team read permissions to a {% data variables.projects.projects_v1_board %}, and a {% data variables.projects.projects_v1_board %} admin gives one of the team members admin permissions to that board as an individual collaborator, that person would have admin permissions to the {% data variables.projects.projects_v1_board %}. For more information see, "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." - -{% endnote %} +> [!NOTE] +> {% data reusables.project-management.cascading-permissions %} For example, if an organization owner has given a team read permissions to a {% data variables.projects.projects_v1_board %}, and a {% data variables.projects.projects_v1_board %} admin gives one of the team members admin permissions to that board as an individual collaborator, that person would have admin permissions to the {% data variables.projects.projects_v1_board %}. For more information see, "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)." {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md index 1519988deb05..e3c3bbf15bea 100644 --- a/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md +++ b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md @@ -49,11 +49,8 @@ If your organization doesn't require SSH certificates, contributors can continue When you issue each certificate, you must include an extension that specifies which {% data variables.product.product_name %} user the certificate is for. You can reference the user using their login handle{% ifversion ssh-ca-expires %} or their user ID{% endif %}. For example, you can use OpenSSH's `ssh-keygen` command, replacing KEY-IDENTITY with your key identity and USERNAME with a {% data variables.product.product_name %} username{% ifversion ssh-ca-expires %} or user ID{% endif %}. The certificate you generate will be authorized to act on behalf of that user for any of your organization's resources. Make sure you validate the user's identity before you issue the certificate. -{% note %} - -**Note:** You must update to OpenSSH 7.6 or later to use these commands. - -{% endnote %} +> [!NOTE] +> You must update to OpenSSH 7.6 or later to use these commands. To use the `login` to identify the user, use `extension:login`: @@ -69,11 +66,9 @@ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:id@{% data variable ``` {% endif %} -{% warning %} - -**Warning**: After a certificate has been signed and issued, the certificate cannot be revoked. -{% endwarning %} +> [!WARNING] +> After a certificate has been signed and issued, the certificate cannot be revoked. For CAs uploaded {% ifversion ghec %}after March 27th, 2024{% elsif ghes %}to {% data variables.product.prodname_ghe_server %} version 3.13 or later{% endif %}, you {% ifversion ghes < 3.13 %}will need to{% else %}must{% endif %} use the `-V` flag to configure a lifetime less than 366 days for the certificate. For CAs uploaded {% ifversion ghec %}before this date{% elsif ghes %}before version 3.13{% endif %}, the `-V` flag is optional, and you can create certificates that are irrevocable and live forever. diff --git a/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md b/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md index 849f2844913e..08e9ba35021f 100644 --- a/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization.md @@ -23,13 +23,10 @@ shortTitle: Invite users to join You can use a person's {% data variables.product.company_short %} username or email address for the invitation. -{% note %} - -**Note:** If you use an email address for the invitation, the invitee will only be able to accept the invitation if the email address matches with a verified email address associated with the invitee's personal account on {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)." - -If an invitee's personal account has been flagged, the invitee won't be able to accept any new or pending invitations to join organizations. - -{% endnote %} +> [!NOTE] +> If you use an email address for the invitation, the invitee will only be able to accept the invitation if the email address matches with a verified email address associated with the invitee's personal account on {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)." +> +> If an invitee's personal account has been flagged, the invitee won't be able to accept any new or pending invitations to join organizations. If your organization has a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/about-per-user-pricing)." diff --git a/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md index 23f00e82d565..e79b53b2ef8a 100644 --- a/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md +++ b/content/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization.md @@ -20,29 +20,23 @@ permissions: Organization owners can remove members from an organization. {% ifversion fpt or ghec %} -{% warning %} - -**Warning:** When you remove members from an organization: -* The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)." -* Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -* When private repositories are forked to other organizations, those organizations are able to control access to the fork network. This means users may retain access to the forks even after losing access to the original organization because they will still have explicit access via a fork. +> [!WARNING] +> When you remove members from an organization: +> * The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)." +> * Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +> * When private repositories are forked to other organizations, those organizations are able to control access to the fork network. This means users may retain access to the forks even after losing access to the original organization because they will still have explicit access via a fork. {%- ifversion ghec %} -* Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)." +> * Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)." {%- endif %} -* Any organization invitations sent by a removed member, that have not been accepted, are canceled and will not be accessible. - -{% endwarning %} +> * Any organization invitations sent by a removed member, that have not been accepted, are canceled and will not be accessible. {% else %} -{% warning %} - -**Warning:** When you remove members from an organization: -* Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -* Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise. -* Any organization invitations sent by the removed user, that have not been accepted, are canceled and will not be accessible. - -{% endwarning %} +> [!WARNING] +> When you remove members from an organization: +> * Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +> * Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise. +> * Any organization invitations sent by the removed user, that have not been accepted, are canceled and will not be accessible. {% endif %} diff --git a/content/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions.md b/content/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions.md index dbb2795d4979..f3183b871b3d 100644 --- a/content/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions.md +++ b/content/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions.md @@ -26,11 +26,8 @@ Even if you restrict {% data variables.product.prodname_oauth_apps %} access in {% data reusables.organizations.oauth_app_restrictions_default %} -{% tip %} - -**Tip**: When an organization has not set up {% data variables.product.prodname_oauth_app %} access restrictions, any {% data variables.product.prodname_oauth_app %} authorized by an organization member can also access the organization's private resources. - -{% endtip %} +> [!TIP] +> When an organization has not set up {% data variables.product.prodname_oauth_app %} access restrictions, any {% data variables.product.prodname_oauth_app %} authorized by an organization member can also access the organization's private resources. {% ifversion fpt %} To further protect your organization's resources, you can upgrade to {% data variables.product.prodname_ghe_cloud %}, which includes security features like SAML single sign-on. {% data reusables.enterprise.link-to-ghec-trial %} diff --git a/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md b/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md index c641197a7b5f..4dc6287277d8 100644 --- a/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/organizations/managing-oauth-access-to-your-organizations-data/disabling-oauth-app-access-restrictions-for-your-organization.md @@ -15,11 +15,8 @@ topics: shortTitle: Unrestrict {% data variables.product.prodname_oauth_apps %} --- -{% danger %} - -**Warning**: When you disable {% data variables.product.prodname_oauth_app %} access restrictions for your organization, any organization member will automatically authorize {% data variables.product.prodname_oauth_app %} access to the organization's private resources when they approve an application for use in their personal account settings. - -{% enddanger %} +> [!WARNING] +> When you disable {% data variables.product.prodname_oauth_app %} access restrictions for your organization, any organization member will automatically authorize {% data variables.product.prodname_oauth_app %} access to the organization's private resources when they approve an application for use in their personal account settings. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} diff --git a/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md b/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md index f4746e623678..0a07d438800d 100644 --- a/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md +++ b/content/organizations/managing-oauth-access-to-your-organizations-data/enabling-oauth-app-access-restrictions-for-your-organization.md @@ -19,14 +19,10 @@ shortTitle: Restrict {% data variables.product.prodname_oauth_apps %} Even if you restrict {% data variables.product.prodname_oauth_apps %} access in your organization, users can still authorize internal {% data variables.product.prodname_oauth_apps %} and use them to access data from the organization. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/internal-oauth-apps)." -{% warning %} - -**Warnings**: -* Enabling {% data variables.product.prodname_oauth_app %} access restrictions will revoke organization access for all previously authorized {% data variables.product.prodname_oauth_apps %} and SSH keys. For more information, see "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)." -* Once you've set up {% data variables.product.prodname_oauth_app %} access restrictions, make sure to reauthorize any {% data variables.product.prodname_oauth_app %} that require access to the organization's private data on an ongoing basis. All organization members will need to create new SSH keys, and the organization will need to create new deploy keys as needed. -* When {% data variables.product.prodname_oauth_app %} access restrictions are enabled, applications can use an OAuth token to access information about {% data variables.product.prodname_marketplace %} transactions. - -{% endwarning %} +> [!WARNING] +> * Enabling {% data variables.product.prodname_oauth_app %} access restrictions will revoke organization access for all previously authorized {% data variables.product.prodname_oauth_apps %} and SSH keys. For more information, see "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)." +> * Once you've set up {% data variables.product.prodname_oauth_app %} access restrictions, make sure to reauthorize any {% data variables.product.prodname_oauth_app %} that require access to the organization's private data on an ongoing basis. All organization members will need to create new SSH keys, and the organization will need to create new deploy keys as needed. +> * When {% data variables.product.prodname_oauth_app %} access restrictions are enabled, applications can use an OAuth token to access information about {% data variables.product.prodname_marketplace %} transactions. {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} diff --git a/content/organizations/managing-organization-settings/archiving-an-organization.md b/content/organizations/managing-organization-settings/archiving-an-organization.md index eddc304e8f5b..1dbe17c7fb42 100644 --- a/content/organizations/managing-organization-settings/archiving-an-organization.md +++ b/content/organizations/managing-organization-settings/archiving-an-organization.md @@ -11,11 +11,8 @@ topics: {% ifversion fpt or ghec %} -{% note %} - -**Note:** You can only archive an organization if it's using {% data variables.product.prodname_free_team %} or if the organization is part of an enterprise. If you want to archive an individually-billed organization, you must downgrade your organization to {% data variables.product.prodname_free_team %} first. For more information, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription)." - -{% endnote %} +> [!NOTE] +> You can only archive an organization if it's using {% data variables.product.prodname_free_team %} or if the organization is part of an enterprise. If you want to archive an individually-billed organization, you must downgrade your organization to {% data variables.product.prodname_free_team %} first. For more information, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription)." {% endif %} diff --git a/content/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization.md b/content/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization.md index 86490a54417a..9c6c2e8268dd 100644 --- a/content/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization.md +++ b/content/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization.md @@ -88,11 +88,8 @@ https://api.github.com/graphql ### 2. Create a runner group for your organization -{% note %} - -**Note:** For the runner group to be accessible by repositories within your organizations, those repositories must have access to that runner group at the organization level. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/controlling-access-to-larger-runners#changing-which-repositories-can-access-a-runner-group)." - -{% endnote %} +> [!NOTE] +> For the runner group to be accessible by repositories within your organizations, those repositories must have access to that runner group at the organization level. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/controlling-access-to-larger-runners#changing-which-repositories-can-access-a-runner-group)." 1. Create a new runner group for your organization. For more information about how to create a runner group, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners#creating-a-runner-group-for-an-organization)." 1. To choose a policy for repository access, select the **Repository access** dropdown menu and click a policy. You can configure a runner group to be accessible to a specific list of repositories, or all repositories in the organization. @@ -101,11 +98,8 @@ https://api.github.com/graphql ### 3. Add the {% data variables.product.company_short %}-hosted runner to the organization runner group -{% note %} - -**Note:** When adding your {% data variables.product.company_short %}-hosted runner to a runner group, select the runner group you created in the previous procedures. - -{% endnote %} +> [!NOTE] +> When adding your {% data variables.product.company_short %}-hosted runner to a runner group, select the runner group you created in the previous procedures. 1. Add the {% data variables.product.company_short %}-hosted runner to the runner group. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/managing-larger-runners#adding-a-larger-runner-to-an-organization)." diff --git a/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md index 1352147f9e66..a12431bb411e 100644 --- a/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md +++ b/content/organizations/managing-organization-settings/converting-an-organization-into-a-user.md @@ -16,11 +16,8 @@ shortTitle: Convert organization to user {% ifversion fpt or ghec %} -{% note %} - -**Note**: After an account is deleted, the username at the time of deletion becomes unavailable for reuse for 90 days. To reuse an organization's username immediately, you must change the username before you delete the organization. - - {% endnote %} +> [!NOTE] +> After an account is deleted, the username at the time of deletion becomes unavailable for reuse for 90 days. To reuse an organization's username immediately, you must change the username before you delete the organization. 1. [Sign up](/get-started/start-your-journey/creating-an-account-on-github) for a new account on GitHub. 1. [Have the user's role changed to an owner](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization). diff --git a/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md b/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md index 88360b7db668..9a3f1323f5c2 100644 --- a/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md +++ b/content/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization.md @@ -10,11 +10,10 @@ topics: --- {% ifversion ghec %} -{% note %} -**Note:** To create an announcement banner, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> To create an announcement banner, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} You can create an announcement banner that will be displayed to all organization members at the top of every page in the organization. @@ -29,10 +28,8 @@ You can also set announcement banners at the enterprise level. For more informat 1. Under "Announcement", in the text field, type the announcement you want displayed in a banner. 1. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date. - {% note %} + > [!NOTE] + > Announcements must either have an expiration date, be user dismissible, or both. - **Note:** Announcements must either have an expiration date, be user dismissible, or both. - - {% endnote %} 1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**. {% data reusables.enterprise_site_admin_settings.message-preview-save %} diff --git a/content/organizations/managing-organization-settings/deleting-an-organization-account.md b/content/organizations/managing-organization-settings/deleting-an-organization-account.md index cd60fb2a31a9..d35ce825996b 100644 --- a/content/organizations/managing-organization-settings/deleting-an-organization-account.md +++ b/content/organizations/managing-organization-settings/deleting-an-organization-account.md @@ -18,11 +18,9 @@ shortTitle: Delete organization ## About deletion of your organization account {% ifversion fpt or ghec %} -{% tip %} -**Tip**: If you want to cancel your paid subscription, you can [downgrade your organization to {% data variables.product.prodname_free_team %}](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan) instead of deleting the organization and its content. - -{% endtip %} +> [!TIP] +> If you want to cancel your paid subscription, you can [downgrade your organization to {% data variables.product.prodname_free_team %}](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan) instead of deleting the organization and its content. {% endif %} Deleting your organization account removes all repositories, forks of private repositories, wikis, issues, pull requests, and project or organization pages. {% ifversion fpt or ghec %}Your billing will end and, after 90 days, the organization name becomes available for use on a new user or organization account. @@ -46,11 +44,10 @@ You can also archive an organization, instead of deleting it. Archiving an organ {% ifversion not ghes %} After you delete an organization, {% data variables.product.company_short %} **cannot restore your content**. Therefore, before{% else %}Before{% endif %} you delete your organization, make sure you have a copy of all repositories, wikis, issues, and projects from the account. {% ifversion ghes %} -{% note %} -**Note:** If necessary, a site administrator for {% data variables.location.product_location %} may be able to partially restore a deleted organization. For more information, see "[AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/restoring-a-deleted-organization)." +> [!NOTE] +> If necessary, a site administrator for {% data variables.location.product_location %} may be able to partially restore a deleted organization. For more information, see "[AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/restoring-a-deleted-organization)." -{% endnote %} {% endif %} ## Deleting your organization account diff --git a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index 2313ffac546c..7d6b0845494d 100644 --- a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -28,11 +28,8 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} for You can choose to disable {% data variables.product.prodname_actions %} for all repositories in your organization, or only allow specific repositories. You can also limit the use of public actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}, so that people can only use local actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} that exist in your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %}. -{% note %} - -**Note:** You might not be able to manage these settings if your organization is managed by an enterprise that has overriding policy. For more information, see "[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 is managed by an enterprise that has overriding policy. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -56,11 +53,8 @@ You can choose to disable {% data variables.product.prodname_actions %} for all {% ifversion ghec or ghes %} -{% note %} - -**Note**: If your organization belongs to an enterprise, creation of self-hosted runners at the repository level may have been disabled as an enterprise-wide setting. If this has been done, you cannot enable repository-level self-hosted runners in your organization settings. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." - -{% endnote %} +> [!NOTE] +> If your organization belongs to an enterprise, creation of self-hosted runners at the repository level may have been disabled as an enterprise-wide setting. If this has been done, you cannot enable repository-level self-hosted runners in your organization settings. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." {% endif %} diff --git a/content/organizations/managing-organization-settings/managing-base-permissions-for-projects.md b/content/organizations/managing-organization-settings/managing-base-permissions-for-projects.md index cd6b3838836b..5a8e6b72947d 100644 --- a/content/organizations/managing-organization-settings/managing-base-permissions-for-projects.md +++ b/content/organizations/managing-organization-settings/managing-base-permissions-for-projects.md @@ -15,11 +15,8 @@ You can set a project's base permission to control the level of access for all m When you set the base permission for projects in your organization's settings, the base permission will apply to any new projects created by organization members and existing projects that do not currently have a base permission configured in the project's settings. -{% note %} - -**Note:** {% data reusables.projects.migration-permissions-warning %} - -{% endnote %} +> [!NOTE] +> {% data reusables.projects.migration-permissions-warning %} ## Setting a base permission for {% data variables.projects.projects_v2 %} in your organization diff --git a/content/organizations/managing-organization-settings/renaming-an-organization.md b/content/organizations/managing-organization-settings/renaming-an-organization.md index 3c720b4d3965..cd82c0bc4903 100644 --- a/content/organizations/managing-organization-settings/renaming-an-organization.md +++ b/content/organizations/managing-organization-settings/renaming-an-organization.md @@ -14,11 +14,8 @@ topics: - Teams --- -{% tip %} - -**Tip:** Only organization owners can rename an organization. {% data reusables.organizations.new-org-permissions-more-info %} - -{% endtip %} +> [!TIP] +> Only organization owners can rename an organization. {% data reusables.organizations.new-org-permissions-more-info %} ## What happens when I change my organization's name? diff --git a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index 567560f515bb..d9a3c50e2e31 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -26,11 +26,8 @@ Enterprise owners can restrict the options you have available for your organizat Organization owners can restrict the type of repositories members can create to private {% ifversion ghec or ghes %}or internal{% endif %} to help prevent sensitive information from being exposed. For more information, see "[AUTOTITLE](/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization)." -{% warning %} - -**Warning**: This setting restricts the visibility options available when repositories are _created_, but does not prevent changing the visibility of _existing_ repositories. For more information about restricting changes to existing repositories' visibilities, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." - -{% endwarning %} +> [!WARNING] +> This setting restricts the visibility options available when repositories are _created_, but does not prevent changing the visibility of _existing_ repositories. For more information about restricting changes to existing repositories' visibilities, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -38,11 +35,10 @@ Organization owners can restrict the type of repositories members can create to 1. Under "Repository creation", select one or more options.

{% ifversion fpt or ghec %} - {% note %} - **Note:** To restrict members to creating private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} + > [!NOTE] + > To restrict members to creating private repositories only, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} - {% endnote %} {%- endif %} 1. Click **Save**. diff --git a/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md index e0adf84d124d..6839927dae34 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization.md @@ -21,11 +21,8 @@ You can restrict the ability to change repository visibility to organization own Restricting who has the ability to change the visibility of repositories in your organization helps prevent sensitive information from being exposed. For more information, see "[AUTOTITLE](/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization)." -{% warning %} - -**Warning**: If this setting is enabled, individuals or {% data variables.product.prodname_github_apps %} with admin access can _modify_ the visibility of an existing repository even if the ability to _create_ a repository with that specific visibility has been disabled. For more information about restricting the visibility of repositories during creation, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)." - -{% endwarning %} +> [!WARNING] +> If this setting is enabled, individuals or {% data variables.product.prodname_github_apps %} with admin access can _modify_ the visibility of an existing repository even if the ability to _create_ a repository with that specific visibility has been disabled. For more information about restricting the visibility of repositories during creation, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} diff --git a/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md b/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md index bf6144ea1541..9f30a5f908f1 100644 --- a/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md +++ b/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md @@ -21,11 +21,10 @@ shortTitle: Set collaborator policy By default, anyone with admin access to a repository can invite outside collaborators to work on the repository. You can choose to restrict the ability to add outside collaborators to organization owners only. {% ifversion ghec %} -{% note %} -**Note:** Only organizations that use {% data variables.product.prodname_ghe_cloud %} can restrict the ability to invite outside collaborators to organization owners. {% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> Only organizations that use {% data variables.product.prodname_ghe_cloud %} can restrict the ability to invite outside collaborators to organization owners. {% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} {% ifversion ghec %}If your organization is owned by an enterprise account, you{% else %}You{% endif %} may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see "[Enforcing repository management policies in your enterprise]{% ifversion ghec %}(/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-collaborators-to-repositories)"{% else %}(/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories){% endif %}." diff --git a/content/organizations/managing-organization-settings/transferring-organization-ownership.md b/content/organizations/managing-organization-settings/transferring-organization-ownership.md index 1758c26076c9..8195108d6b6e 100644 --- a/content/organizations/managing-organization-settings/transferring-organization-ownership.md +++ b/content/organizations/managing-organization-settings/transferring-organization-ownership.md @@ -15,22 +15,19 @@ topics: shortTitle: Transfer ownership --- {% ifversion ghec %} -{% note %} -**Note:** {% data reusables.enterprise-accounts.invite-organization %} +> [!NOTE] +> {% data reusables.enterprise-accounts.invite-organization %} -{% endnote %}{% endif %} +{% endif %} 1. If you're the only member with _owner_ privileges, give another organization member the owner role. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)." 1. Contact the new owner and make sure they are able to [access the organization's settings](/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings). {% ifversion fpt or ghec %} 1. If you are currently responsible for paying for GitHub in your organization, you'll also need to have the new owner or a [billing manager](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization) update the organization's payment information. For more information, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)." - {% warning %} - - **Warning**: Removing yourself from the organization **does not** update the billing information on file for the organization account. The new owner or a billing manager must update the billing information on file to remove your credit card or PayPal information. - - {% endwarning %} + > [!WARNING] + > Removing yourself from the organization **does not** update the billing information on file for the organization account. The new owner or a billing manager must update the billing information on file to remove your credit card or PayPal information. {% endif %} 1. [Remove yourself](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization) from the organization. diff --git a/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md b/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md index a32154611d85..522c8aa76012 100644 --- a/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md +++ b/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md @@ -35,11 +35,10 @@ After verifying ownership of your organization's domain, you can restrict email {% endif %} {% ifversion ghec %} -{% note %} -**Note:** To restrict email notifications to a verified domain, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> To restrict email notifications to a verified domain, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} {% ifversion ghec %}You can also verify custom domains used for {% data variables.product.prodname_pages %} to prevent domain takeovers when a custom domain remains configured but your {% data variables.product.prodname_pages %} site is either disabled or no longer uses the domain. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)."{% endif %} diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md index 160b4e186f6a..0ff5a365018e 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md @@ -16,11 +16,8 @@ shortTitle: Add a billing manager Members of your organization's Owners team can give _billing manager_ permissions to people. Once a person accepts their invitation to become a billing manager for your organization, they can invite additional people to be billing managers. -{% note %} - -**Note:** Billing managers do not use paid licenses in your organization's subscription. - -{% endnote %} +> [!NOTE] +> Billing managers do not use paid licenses in your organization's subscription. ## Permissions for billing managers @@ -44,20 +41,16 @@ Billing managers **are not** able to: * Purchase, edit, or cancel subscriptions for {% data variables.product.prodname_marketplace %} apps * Purchase, edit, or cancel subscriptions for {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} -{% tip %} - -**Tip:** If your organization [requires members, billing managers, and outside collaborators to use two-factor authentication](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization), the user must enable two-factor authentication before they can accept your invitation to become a billing manager for the organization. - -{% endtip %} +> [!TIP] +> If your organization [requires members, billing managers, and outside collaborators to use two-factor authentication](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization), the user must enable two-factor authentication before they can accept your invitation to become a billing manager for the organization. ## Inviting a billing manager {% ifversion ghec %} -{% note %} -**Note:** If your organization is owned by an enterprise account, you cannot invite billing managers at the organization level. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)." +> [!NOTE] +> If your organization is owned by an enterprise account, you cannot invite billing managers at the organization level. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)." -{% endnote %} {% endif %} The invited person will receive an invitation email asking them to become a billing manager for your organization. Once the invited person clicks the accept link in their invitation email, they will automatically be added to the organization as a billing manager. If they don't already have a GitHub account, they will be directed to sign up for one, and they will be automatically added to the organization as a billing manager after they create an account. diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization.md index 16ed77054923..389fe17af9f2 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization.md @@ -24,11 +24,8 @@ shortTitle: Maintain ownership continuity Organization owners have full administrative access to the organization. {% data reusables.organizations.new-org-permissions-more-info %} -{% note %} - -**Note**: As an organization owner, you can change the role of other organization members and owners. You can't change your own role. - -{% endnote %} +> [!NOTE] +> As an organization owner, you can change the role of other organization members and owners. You can't change your own role. {% ifversion enterprise-owner-join-org %} If your organization is owned by an enterprise account, any enterprise owner can make themselves an owner of your organization. For more information, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)." diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization.md index 51bc63f9a0a7..8f673ef520d9 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/removing-a-billing-manager-from-your-organization.md @@ -14,11 +14,8 @@ topics: shortTitle: Remove billing manager --- -{% warning %} - -**Note:** {% data reusables.dotcom_billing.org-billing-perms %} - -{% endwarning %} +> [!NOTE] +> {% data reusables.dotcom_billing.org-billing-perms %} {% data reusables.organizations.billing-settings %} 1. Under "Billing management", in the "Billing managers" list, next to the name of the person you want to remove, click **Remove**. diff --git a/content/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization.md index 573e20086ab4..7a11943e861c 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/managing-requests-for-personal-access-tokens-in-your-organization.md @@ -16,11 +16,8 @@ When organization members create a {% data variables.product.pat_v2 %} to access {% data variables.product.company_short %} will notify organization owners with a daily email about all {% data variables.product.pat_v2 %}s that are awaiting approval. When a token is denied or approved, the user who created the token will receive an email notification. -{% note %} - -**Note**: Only {% data variables.product.pat_v2 %}s, not {% data variables.product.pat_v1_plural %}, are subject to approval. Unless the organization has restricted access by {% data variables.product.pat_v1_plural %}, any {% data variables.product.pat_v1 %} can access organization resources without prior approval. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)." - -{% endnote %} +> [!NOTE] +> Only {% data variables.product.pat_v2 %}s, not {% data variables.product.pat_v1_plural %}, are subject to approval. Unless the organization has restricted access by {% data variables.product.pat_v1_plural %}, any {% data variables.product.pat_v1 %} can access organization resources without prior approval. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)." {% ifversion pat-v2-org-admin-api %} diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md index 836f7a775228..493156bd6802 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on.md @@ -56,11 +56,8 @@ After you enable SAML SSO, there are multiple ways you can add new members to yo To provision new users without an invitation from an organization owner, you can use the URL `https://github.com/orgs/ORGANIZATION/sso/sign_up`, replacing ORGANIZATION with the name of your organization. For example, you can configure your IdP so that anyone with access to the IdP can click a link on the IdP's dashboard to join your {% data variables.product.prodname_dotcom %} organization. -{% note %} - -**Note:** Provisioning new users via `https://github.com/orgs/ORGANIZATION/sso/sign_up` is only supported when SAML SSO is configured at the organization level, not when SAML SSO is configured at the enterprise account level. For more information about SAML SSO for enterprise accounts, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)." - -{% endnote %} +> [!NOTE] +> Provisioning new users via `https://github.com/orgs/ORGANIZATION/sso/sign_up` is only supported when SAML SSO is configured at the organization level, not when SAML SSO is configured at the enterprise account level. For more information about SAML SSO for enterprise accounts, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)." If your IdP supports SCIM, {% data variables.product.prodname_dotcom %} can automatically invite members to join your organization when you grant access on your IdP. If you remove a member's access to your {% data variables.product.prodname_dotcom %} organization on your SAML IdP, the member will be automatically removed from the {% data variables.product.prodname_dotcom %} organization. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md index 88d7dc1819d2..8b6cf3953b64 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations.md @@ -37,11 +37,8 @@ These identity providers (IdPs) are compatible with the {% data variables.produc Before you authorize the {% data variables.product.prodname_oauth_app %}, you must have an active SAML session. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on#about-oauth-apps-github-apps-and-saml-sso)." -{% note %} - -**Note:** {% data reusables.scim.nameid-and-username-must-match %} - -{% endnote %} +> [!NOTE] +> {% data reusables.scim.nameid-and-username-must-match %} ## Further reading diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md index c356a4b4bae6..ba55157a8ba2 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta.md @@ -57,11 +57,8 @@ Alternatively, you can configure SAML SSO for an enterprise using Okta. SCIM for 1. Click **Authenticate with {% data variables.product.prodname_ghe_cloud %} - Organization**. 1. To the right of your organization's name, click **Grant**. - {% note %} - - **Note:** If you cannot see your organization, this may be because {% data variables.product.prodname_oauth_app %} access restrictions are enabled for the organization. To continue, you will need to approve the "OKTA SCIM Integration" app for the organization. For more information, see "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization)." - - {% endnote %} + > [!NOTE] + > If you cannot see your organization, this may be because {% data variables.product.prodname_oauth_app %} access restrictions are enabled for the organization. To continue, you will need to approve the "OKTA SCIM Integration" app for the organization. For more information, see "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization)." 1. Click **Authorize OktaOAN**. {% data reusables.saml.okta-save-provisioning %} diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md index 26c1a0ff48cb..e9e77caf53ec 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/connecting-your-identity-provider-to-your-organization.md @@ -27,13 +27,10 @@ You can find the SAML and SCIM implementation details for your IdP in the IdP's * PingOne [SAML](https://support.pingidentity.com/s/marketplace-integration/a7i1W0000004ID3QAM/github-connector) * Shibboleth [SAML](https://shibboleth.atlassian.net/wiki/spaces/IDP4/overview) -{% note %} - -**Note:** {% data variables.product.product_name %} supported identity providers for SCIM are Entra ID, Okta, and OneLogin. For more information about SCIM, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." - -{% data reusables.scim.enterprise-account-scim %} - -{% endnote %} +> [!NOTE] +> {% data variables.product.product_name %} supported identity providers for SCIM are Entra ID, Okta, and OneLogin. For more information about SCIM, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." +> +> {% data reusables.scim.enterprise-account-scim %} ## SAML metadata diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/disabling-saml-single-sign-on-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/disabling-saml-single-sign-on-for-your-organization.md index e62a6195f3a6..3b2e607e62b6 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/disabling-saml-single-sign-on-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/disabling-saml-single-sign-on-for-your-organization.md @@ -15,11 +15,9 @@ After you disable SAML SSO for your organization, all external identities for yo {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} - {% note %} + > [!NOTE] + > If you're unable to access the organization because your identity provider (IdP) is unavailable, you can use a recovery code to bypass SSO. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable)." - **Note:** If you're unable to access the organization because your identity provider (IdP) is unavailable, you can use a recovery code to bypass SSO. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/accessing-your-organization-if-your-identity-provider-is-unavailable)." - - {% endnote %} {% data reusables.organizations.security %} 1. Under "SAML single sign-on", deselect **Enable SAML authentication**. 1. Click **Save**. diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md index 67f0e6c44810..9d6ffec8ac27 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes.md @@ -22,11 +22,8 @@ Recovery codes should not be shared or distributed. We recommend saving them wit ![Screenshot of the "SAML single sign-on" section. A link, labeled "Save your recovery codes," is highlighted with an orange outline.](/assets/images/help/saml/saml-recovery-codes.png) 1. To save your recovery codes, click **Download**, **Print**, or **Copy**. - {% note %} - - **Note:** Your recovery codes will help get you back into {% data variables.product.product_name %} if your IdP is unavailable. If you generate new recovery codes the recovery codes displayed on the "Single sign-on recovery codes" page are automatically updated. - - {% endnote %} + > [!NOTE] + > Your recovery codes will help get you back into {% data variables.product.product_name %} if your IdP is unavailable. If you generate new recovery codes the recovery codes displayed on the "Single sign-on recovery codes" page are automatically updated. 1. Once you use a recovery code to regain access to {% data variables.product.product_name %}, it cannot be reused. Access to {% data variables.product.product_name %} will only be available for 24 hours before you'll be asked to sign in using single sign-on. diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md index 4820f186149e..8ba1f5fd1f5e 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md @@ -37,29 +37,22 @@ For more information about the identity providers (IdPs) that {% data variables. {% data reusables.organizations.security %} 1. Under "SAML single sign-on", select **Enable SAML authentication**. - {% note %} - - **Note:** After enabling SAML SSO, you can download your single sign-on recovery codes so that you can access your organization even if your IdP is unavailable. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes)." - - {% endnote %} + > [!NOTE] + > After enabling SAML SSO, you can download your single sign-on recovery codes so that you can access your organization even if your IdP is unavailable. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes)." 1. In the "Sign on URL" field, type the HTTPS endpoint of your IdP for single sign-on requests. This value is available in your IdP configuration. 1. Optionally, in the "Issuer" field, type your SAML issuer's name. This verifies the authenticity of sent messages. - {% note %} - - **Note:** If you want to enable team synchronization for your organization, the "Issuer" field is a required. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." - - {% endnote %} + > [!NOTE] + > If you want to enable team synchronization for your organization, the "Issuer" field is a required. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." 1. Under "Public Certificate," paste a certificate to verify SAML responses. {% data reusables.saml.edit-signature-and-digest-methods %} 1. Before enabling SAML SSO for your organization, to ensure that the information you've entered is correct, click **Test SAML configuration**. {% data reusables.saml.test-must-succeed %} - {% tip %} - **Tip:** {% data reusables.saml.testing-saml-sso %} + > [!TIP] + > {% data reusables.saml.testing-saml-sso %} - {% endtip %} 1. To enforce SAML SSO and remove all organization members who haven't authenticated via your IdP, select **Require SAML SSO authentication for all members of the _organization name_ organization**. For more information on enforcing SAML SSO, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization)." 1. Click **Save**. diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md index 5b3dad2f022e..02e57f22e0ee 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/enforcing-saml-single-sign-on-for-your-organization.md @@ -26,11 +26,8 @@ Bots and service accounts that do not have external identities set up in your or If your organization is owned by an enterprise account, requiring SAML for the enterprise account will override your organization-level SAML configuration and enforce SAML SSO for every organization in the enterprise. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise)." -{% tip %} - -**Tip:** {% data reusables.saml.testing-saml-sso %} - -{% endtip %} +> [!TIP] +> {% data reusables.saml.testing-saml-sso %} ## Enforcing SAML SSO for your organization diff --git a/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md b/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md index eb1fa47e7da7..ca47284044e9 100644 --- a/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md +++ b/content/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization.md @@ -53,11 +53,8 @@ You must enable SAML single sign-on for your organization and your supported IdP You must have a linked SAML identity. To create a linked identity, you must authenticate to your organization using SAML SSO and the supported IdP at least once. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on)." -{% note %} - -**Note**: For team synchronization to work, your SAML settings must contain a valid IdP URL for the "Issuer" field. For more information, see "[Enabling and testing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization#enabling-and-testing-saml-single-sign-on-for-your-organization)." - -{% endnote %} +> [!NOTE] +> For team synchronization to work, your SAML settings must contain a valid IdP URL for the "Issuer" field. For more information, see "[Enabling and testing SAML single sign-on for your organization](/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization#enabling-and-testing-saml-single-sign-on-for-your-organization)." ### Enabling team synchronization for Entra ID diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md index 107755836b92..f1956875aea5 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md @@ -42,11 +42,8 @@ When you convert an organization member to an outside collaborator, their privil ## Converting an organization member to an outside collaborator -{% note %} - -**Note:** You may not be able to convert an organization member to an outside collaborator, if an organization owner{% ifversion not fpt %} or enterprise owner{% endif %} has restricted your ability to add outside collaborators. - -{% endnote %} +> [!NOTE] +> You may not be able to convert an organization member to an outside collaborator, if an organization owner{% ifversion not fpt %} or enterprise owner{% endif %} has restricted your ability to add outside collaborators. {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/reinstating-a-former-outside-collaborators-access-to-your-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/reinstating-a-former-outside-collaborators-access-to-your-organization.md index ab43f526c763..a168260dd0aa 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/reinstating-a-former-outside-collaborators-access-to-your-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/reinstating-a-former-outside-collaborators-access-to-your-organization.md @@ -32,15 +32,10 @@ When you reinstate a former outside collaborator, you can restore: * Issue assignments in the organization * Repository subscriptions (notification settings for watching, not watching, or ignoring a repository's activity) -{% tip %} - -**Tips**: - -* Only organization owners can reinstate outside collaborators' access to an organization.{% ifversion prevent-org-admin-add-outside-collaborator %} Enterprise owners may further restrict the ability to reinstate outside collaborators' access to enterprise owners only.{% endif %} For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -* The reinstating a member flow on {% data variables.location.product_location %} may use the term "member" to describe reinstating an outside collaborator but if you reinstate this person and keep their previous privileges, they will only have their previous [outside collaborator permissions](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators).{% ifversion fpt or ghec %} -* If your organization has a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/about-per-user-pricing)."{% endif %} - -{% endtip %} +> [!TIP] +> * Only organization owners can reinstate outside collaborators' access to an organization.{% ifversion prevent-org-admin-add-outside-collaborator %} Enterprise owners may further restrict the ability to reinstate outside collaborators' access to enterprise owners only.{% endif %} For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." +> * The reinstating a member flow on {% data variables.location.product_location %} may use the term "member" to describe reinstating an outside collaborator but if you reinstate this person and keep their previous privileges, they will only have their previous [outside collaborator permissions](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators).{% ifversion fpt or ghec %} +> * If your organization has a paid per-user subscription, an unused license must be available before you can invite a new member to join the organization or reinstate a former organization member. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/about-per-user-pricing)."{% endif %} {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} @@ -50,19 +45,15 @@ When you reinstate a former outside collaborator, you can restore: {% ifversion fpt or ghec %} 1. Select whether to restore the outside collaborator's previous privileges in the organization by clicking **Invite and reinstate** or choose to clear their previous privileges and set new access permissions by clicking **Invite and start fresh**. - {% warning %} + > [!WARNING] + > If you want to upgrade the outside collaborator to a member of your organization, then choose **Invite and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization _and_ keep their private forks, choose **Invite and reinstate** instead. Once this person accepts the invitation, you can convert them to an organization member by [inviting them to join the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-outside-collaborator-to-an-organization-member). - **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Invite and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization _and_ keep their private forks, choose **Invite and reinstate** instead. Once this person accepts the invitation, you can convert them to an organization member by [inviting them to join the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-outside-collaborator-to-an-organization-member). - - {% endwarning %} {% else %} 1. Select whether to restore the outside collaborator's previous privileges in the organization by clicking **Add and reinstate** or choose to clear their previous privileges and set new access permissions by clicking **Add and start fresh**. - {% warning %} - - **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Add and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization _and_ keep their private forks, choose **Add and reinstate** instead. Then, you can convert them to an organization member by [adding them to the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-outside-collaborator-to-an-organization-member). + > [!WARNING] + > If you want to upgrade the outside collaborator to a member of your organization, then choose **Add and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization _and_ keep their private forks, choose **Add and reinstate** instead. Then, you can convert them to an organization member by [adding them to the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-outside-collaborator-to-an-organization-member). - {% endwarning %} {% endif %} {% ifversion fpt or ghec %} 1. If you cleared the previous privileges for a former outside collaborator, choose a role for the user and optionally add them to some teams, then click **Send invitation**. diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/removing-an-outside-collaborator-from-an-organization-repository.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/removing-an-outside-collaborator-from-an-organization-repository.md index 0c3831cf7282..f7e370ef67df 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/removing-an-outside-collaborator-from-an-organization-repository.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/removing-an-outside-collaborator-from-an-organization-repository.md @@ -20,14 +20,9 @@ shortTitle: Remove collaborator {% ifversion fpt or ghec %} -{% warning %} - -**Warning:** -* When removing an outside collaborator from a private repository, the paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)." - -* You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. - -{% endwarning %} +> [!WARNING] +> * When removing an outside collaborator from a private repository, the paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/downgrading-your-accounts-plan)." +> * You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. {% endif %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository.md index 915c840fa681..3f2a9d62e7d1 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-team-access-to-an-organization-repository.md @@ -19,13 +19,9 @@ shortTitle: Manage team access People with admin access to a repository can manage team access to the repository. Team maintainers can remove a team's access to a repository if the team has direct access to it. If the team's access to the repository is inherited from a parent team, maintainers can choose to reset the current permission to match the parent team's permission. -{% warning %} - -**Warnings:** -* You can change a team's permission level if the team has direct access to a repository. If the team's access to the repository is inherited from a parent team, you must change the parent team's access to the repository. -* If you add or remove repository access for a parent team, each of that parent's child teams will also receive or lose access to the repository. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." - -{% endwarning %} +> [!WARNING] +> * You can change a team's permission level if the team has direct access to a repository. If the team's access to the repository is inherited from a parent team, you must change the parent team's access to the repository. +> * If you add or remove repository access for a parent team, each of that parent's child teams will also receive or lose access to the repository. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." ## Giving a team access to a repository diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md index aa51518f8965..3458024bb8ad 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md @@ -41,11 +41,8 @@ Organization owners can also choose to further limit access to certain settings In addition to managing organization-level settings, organization owners have admin access to every repository owned by the organization. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -{% warning %} - -**Warning:** When someone adds a deploy key to a repository, any user who has the private key can read from or write to the repository (depending on the key settings), even if they're later removed from the organization. - -{% endwarning %} +> [!WARNING] +> When someone adds a deploy key to a repository, any user who has the private key can read from or write to the repository (depending on the key settings), even if they're later removed from the organization. ## Permissions for each role @@ -53,11 +50,8 @@ In addition to managing organization-level settings, organization owners have ad Some of the features listed below are limited to organizations using {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} {% endif %} -{% note %} - -**Note:** The roles required to use security features are listed in "[Access requirements for security features](#access-requirements-for-security-features)" below. - -{% endnote %} +> [!NOTE] +> The roles required to use security features are listed in "[Access requirements for security features](#access-requirements-for-security-features)" below. {% rowheaders %} @@ -177,11 +171,8 @@ Some of the features listed below are limited to organizations using {% data var In this section, you can find the access required for security features, such as {% data variables.product.prodname_advanced_security %} features. -{% note %} - -**Note:** Repository writers and maintainers can only see secret scanning alert information for their own commits. - -{% endnote %} +> [!NOTE] +> Repository writers and maintainers can only see secret scanning alert information for their own commits. {% rowheaders %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md index efb4cf11f6b2..b524ecac01b6 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization.md @@ -28,14 +28,9 @@ If someone with admin access to an organization's repository grants a member a h If you've created a custom repository role with an inherited role that is lower access than your organization's base permissions, any members assigned to that role will default to the organization's base permissions rather than the inherited role. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization)." {% endif %} -{% note %} - -**Notes:** - -* All changes to base permissions will affect both new and existing members. -* {% data reusables.repositories.org-base-permissions-private-forks %} - -{% endnote %} +> [!NOTE] +> * All changes to base permissions will affect both new and existing members. +> * {% data reusables.repositories.org-base-permissions-private-forks %} ## Setting base permissions diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md index e71a900c33ac..e93680417c54 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md @@ -34,11 +34,10 @@ You can see a combined overview of teams and people with access to your reposito ## Exporting a list of people with access to your repository {% ifversion ghec %} -{% note %} -**Note:** Only organizations that use {% data variables.product.prodname_ghe_cloud %} can export a list of people with access to a repository. {% data reusables.enterprise.link-to-ghec-trial %} +> [!NOTE] +> Only organizations that use {% data variables.product.prodname_ghe_cloud %} can export a list of people with access to a repository. {% data reusables.enterprise.link-to-ghec-trial %} -{% endnote %} {% endif %} {% data reusables.repositories.navigate-to-repo %} diff --git a/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md index 6b27b6f00de0..874a7d050208 100644 --- a/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/converting-an-admin-team-to-improved-organization-permissions.md @@ -19,14 +19,10 @@ You can remove the ability for members of legacy admin teams to create repositor For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." -{% warning %} - -**Warnings:** -* If there are members of your legacy Admin team who are not members of other teams, deleting the team will remove those members from the organization. Before deleting the team, ensure members are already direct members of the organization, or have collaborator access to necessary repositories. -* To prevent the loss of private forks made by members of the legacy Admin team, you must follow steps 1-3 below before deleting the legacy Admin team. -* Because "admin" is a term for organization members with specific [access to certain repositories](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization) in the organization, we recommend you avoid that term in any team name you decide on. - -{% endwarning %} +> [!WARNING] +> * If there are members of your legacy Admin team who are not members of other teams, deleting the team will remove those members from the organization. Before deleting the team, ensure members are already direct members of the organization, or have collaborator access to necessary repositories. +> * To prevent the loss of private forks made by members of the legacy Admin team, you must follow steps 1-3 below before deleting the legacy Admin team. +> * Because "admin" is a term for organization members with specific [access to certain repositories](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization) in the organization, we recommend you avoid that term in any team name you decide on. 1. [Create a new team](/organizations/organizing-members-into-teams/creating-a-team). 1. [Add each of the members](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team) of your legacy admin team to the new team. diff --git a/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md index 4f6dacafbc15..c8caf05f5ead 100644 --- a/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/converting-an-owners-team-to-improved-organization-permissions.md @@ -23,11 +23,8 @@ You have a few options to convert your legacy Owners team: ## Give the Owners team a new name -{% tip %} - - **Note:** Because "admin" is a term for organization members with specific access to certain repositories in the organization, we recommend you avoid that term in any team name you decide on. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." - -{% endtip %} +> [!NOTE] +> Because "admin" is a term for organization members with specific access to certain repositories in the organization, we recommend you avoid that term in any team name you decide on. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} @@ -41,11 +38,8 @@ You have a few options to convert your legacy Owners team: ## Delete the legacy Owners team -{% warning %} - -**Warning:** If there are members of your Owners team who are not members of other teams, deleting the team will remove those members from the organization. Before deleting the team, ensure members are already direct members of the organization, or have collaborator access to necessary repositories. - -{% endwarning %} +> [!WARNING] +> If there are members of your Owners team who are not members of other teams, deleting the team will remove those members from the organization. Before deleting the team, ensure members are already direct members of the organization, or have collaborator access to necessary repositories. {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md b/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md index 1d340fd29bb7..ef1d5c1b9070 100644 --- a/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md +++ b/content/organizations/migrating-to-improved-organization-permissions/migrating-admin-teams-to-improved-organization-permissions.md @@ -25,11 +25,8 @@ You can remove this ability by migrating your legacy admin teams to the improved For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." -{% warning %} - -**Warning:** If your organization has disabled [repository creation permissions](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization) for all members, some members of legacy admin teams may lose repository creation permissions. If your organization has enabled member repository creation, migrating legacy admin teams to improved organization permissions will not affect team members' ability to create repositories. - -{% endwarning %} +> [!WARNING] +> If your organization has disabled [repository creation permissions](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization) for all members, some members of legacy admin teams may lose repository creation permissions. If your organization has enabled member repository creation, migrating legacy admin teams to improved organization permissions will not affect team members' ability to create repositories. ## Migrating all of your organization's legacy admin teams diff --git a/content/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member.md b/content/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member.md index 838279c682ad..95a34ea377bd 100644 --- a/content/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member.md +++ b/content/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member.md @@ -36,11 +36,8 @@ People with the team maintainer role can manage team membership and settings. {% ifversion ghec %} -{% note %} - -**Note** If your enterprise uses {% data variables.enterprise.prodname_managed_users %} and manages a team's membership with an identity provider (IdP) group, you cannot assign the team maintainer role manually for that team. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." - -{% endnote %} +> [!NOTE] +> If your enterprise uses {% data variables.enterprise.prodname_managed_users %} and manages a team's membership with an identity provider (IdP) group, you cannot assign the team maintainer role manually for that team. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." {% endif %} diff --git a/content/organizations/organizing-members-into-teams/changing-team-visibility.md b/content/organizations/organizing-members-into-teams/changing-team-visibility.md index 19b078402c10..28098193dcce 100644 --- a/content/organizations/organizing-members-into-teams/changing-team-visibility.md +++ b/content/organizations/organizing-members-into-teams/changing-team-visibility.md @@ -15,11 +15,8 @@ topics: {% data reusables.organizations.types-of-team-visibility %} -{% tip %} - -**Tip:** If a team has [child or parent teams](/organizations/organizing-members-into-teams/about-teams), you cannot make it a secret team. - -{% endtip %} +> [!TIP] +> If a team has [child or parent teams](/organizations/organizing-members-into-teams/about-teams), you cannot make it a secret team. {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/organizing-members-into-teams/configuring-team-notifications.md b/content/organizations/organizing-members-into-teams/configuring-team-notifications.md index e9751dd4429f..c4eaf67cd269 100644 --- a/content/organizations/organizing-members-into-teams/configuring-team-notifications.md +++ b/content/organizations/organizing-members-into-teams/configuring-team-notifications.md @@ -12,11 +12,8 @@ Team maintainers and organization owners can enable or disable notifications for Disabling team notifications won't unsubscribe people that are already subscribed to threads. -{% note %} - -**Note:** This setting does not affect notifications for reviews requested from the team. - -{% endnote %} +> [!NOTE] +> This setting does not affect notifications for reviews requested from the team. {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/organizing-members-into-teams/creating-a-team.md b/content/organizations/organizing-members-into-teams/creating-a-team.md index 22e38721d186..d7756ab445bd 100644 --- a/content/organizations/organizing-members-into-teams/creating-a-team.md +++ b/content/organizations/organizing-members-into-teams/creating-a-team.md @@ -52,14 +52,10 @@ You must be a site admin and an organization owner to create a team with LDAP sy {% data reusables.enterprise_user_management.ldap-sync-nested-teams %} -{% warning %} - -**Notes:** -* LDAP Sync only manages the team's member list. You must manage the team's repositories and permissions from within {% data variables.product.prodname_ghe_server %}. -* If an LDAP group mapping to a DN is removed, such as if the LDAP group is deleted, then every member is removed from the synced {% data variables.product.prodname_ghe_server %} team. To fix this, map the team to a new DN, add the team members back, and [manually sync the mapping](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#manually-syncing-ldap-accounts). -* When LDAP Sync is enabled, if a person is removed 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. - -{% endwarning %} +> [!NOTE] +> * LDAP Sync only manages the team's member list. You must manage the team's repositories and permissions from within {% data variables.product.prodname_ghe_server %}. +> * If an LDAP group mapping to a DN is removed, such as if the LDAP group is deleted, then every member is removed from the synced {% data variables.product.prodname_ghe_server %} team. To fix this, map the team to a new DN, add the team members back, and [manually sync the mapping](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#manually-syncing-ldap-accounts). +> * When LDAP Sync is enabled, if a person is removed 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. 1. Ensure that [LDAP Sync is enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync). {% data reusables.profile.access_org %} diff --git a/content/organizations/organizing-members-into-teams/deleting-a-team.md b/content/organizations/organizing-members-into-teams/deleting-a-team.md index bddb7feb3d8c..c96c4d6ceb40 100644 --- a/content/organizations/organizing-members-into-teams/deleting-a-team.md +++ b/content/organizations/organizing-members-into-teams/deleting-a-team.md @@ -13,11 +13,8 @@ topics: - Teams --- -{% tip %} - -**Tip:** Only organization owners can delete parent teams. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." - -{% endtip %} +> [!TIP] +> Only organization owners can delete parent teams. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md b/content/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md index 6280970011df..5b0cbe51b87b 100644 --- a/content/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md +++ b/content/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy.md @@ -20,13 +20,9 @@ Organization owners can change the parent of any team. Team maintainers can chan {% data reusables.organizations.child-team-inherits-permissions %} -{% tip %} - -**Tips:** -* You cannot change a team's parent to a secret team. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." -* You cannot nest a parent team beneath one of its child teams. - -{% endtip %} +> [!TIP] +> * You cannot change a team's parent to a secret team. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." +> * You cannot nest a parent team beneath one of its child teams. {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} diff --git a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 8ab1b9397466..a191451fd676 100644 --- a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -66,11 +66,8 @@ When a package inherits permissions from a repository, to grant or remove access {% ifversion packages-inherit-permissions %}If you want to configure a package's access settings on a granular level, separately from the linked repository, you must remove the inherited permissions from the package.{% endif %} -{% note %} - -**Note:** If you change how a package gets its access permissions, any existing permissions for the package are overwritten. - -{% endnote %} +> [!NOTE] +> If you change how a package gets its access permissions, any existing permissions for the package are overwritten. ### Selecting the inheritance setting for packages scoped to your personal account @@ -81,11 +78,10 @@ When a package inherits permissions from a repository, to grant or remove access ### Selecting the inheritance setting for packages scoped to an organization {% ifversion packages-inherit-permissions %} -{% tip %} -**Tip:** If you're the owner of an organization, you can prevent all new packages scoped to your organization from automatically inheriting permissions from a linked repository. For more information, see "[Disabling automatic inheritance of access permissions in an organization](#disabling-automatic-inheritance-of-access-permissions-in-an-organization)" below. +> [!TIP] +> If you're the owner of an organization, you can prevent all new packages scoped to your organization from automatically inheriting permissions from a linked repository. For more information, see "[Disabling automatic inheritance of access permissions in an organization](#disabling-automatic-inheritance-of-access-permissions-in-an-organization)" below. -{% endtip %} {% endif %} {% data reusables.package_registry.package-settings-from-org-level %} @@ -118,14 +114,10 @@ The specified repository does not need to be the repository where the source cod If you publish a package that is linked to a repository, {% data variables.product.prodname_actions %} workflows in the linked repository automatically get access to the package, unless your organization has disabled the automatic inheritance of access permissions. For more information, see "[About inheritance of access permissions](#about-inheritance-of-access-permissions)" above. {% endif %} -{% note %} - -**Notes:** -* Syncing your package with a repository {% data variables.package_registry.package-settings-actions-access-menu %} is different than connecting your package to a repository. For more information about linking a repository to your package, see "[AUTOTITLE](/packages/learn-github-packages/connecting-a-repository-to-a-package)." -* You can choose to limit permissions to workflow jobs usings the `permissions` key and `packages` scope. For more information, see "[AUTOTITLE](/actions/using-jobs/assigning-permissions-to-jobs)." -* {% data reusables.package_registry.public-forks-private-packages %} - -{% endnote %} +> [!NOTE] +> * Syncing your package with a repository {% data variables.package_registry.package-settings-actions-access-menu %} is different than connecting your package to a repository. For more information about linking a repository to your package, see "[AUTOTITLE](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +> * You can choose to limit permissions to workflow jobs usings the `permissions` key and `packages` scope. For more information, see "[AUTOTITLE](/actions/using-jobs/assigning-permissions-to-jobs)." +> * {% data reusables.package_registry.public-forks-private-packages %} ### {% data variables.product.prodname_actions %} access for packages scoped to personal accounts @@ -182,11 +174,10 @@ When you first publish a package that is scoped to your personal account, the de 1. At the bottom of the page, under "Danger Zone", click **Change visibility**. 1. Select a visibility setting: * To make the package visible to anyone, select **Public**. - {% warning %} - **Warning:** Once you make a package public, you cannot make it private again. + > [!WARNING] + > Once you make a package public, you cannot make it private again. - {% endwarning %} * To make the package visible to a custom selection of people, select **Private**. 1. To confirm, type the name of the package, then click **I understand the consequences, change package visibility**. @@ -211,11 +202,8 @@ When you first publish a package, the default visibility is private and only you 1. At the bottom of the page, under "Danger Zone", click **Change visibility** and choose a visibility setting: * To make the package visible to anyone, click **Public**. - {% warning %} - - **Warning:** Once you make a package public, you cannot make it private again. - - {% endwarning %} + > [!WARNING] + > Once you make a package public, you cannot make it private again. * To make the package visible to a custom selection of people in your organization, click **Private**.{% ifversion not fpt %} * To make the package visible to all organization members, click **Internal**. If the organization belongs to an enterprise, the packages will be visible to all enterprise members.{% endif %} diff --git a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index 2500e40b4e55..66a67baadc30 100644 --- a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -24,13 +24,9 @@ On {% data variables.product.prodname_dotcom %} if you have the required access, * a specific version of a private package * a specific version of a public package, if the package version doesn't have more than 5,000 downloads -{% note %} - -**Note:** -* You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact us through the {% data variables.contact.contact_support_portal %} for further assistance. -* When deleting public packages, be aware that you may break projects that depend on your package. - -{% endnote %} +> [!NOTE] +> * You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact us through the {% data variables.contact.contact_support_portal %} for further assistance. +> * When deleting public packages, be aware that you may break projects that depend on your package. On {% data variables.product.prodname_dotcom %}, you can also restore an entire package or package version, if: * You restore the package within 30 days of its deletion. diff --git a/content/packages/learn-github-packages/introduction-to-github-packages.md b/content/packages/learn-github-packages/introduction-to-github-packages.md index e5bc5a65e19d..31edb51c7908 100644 --- a/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -68,17 +68,16 @@ The permissions for a package are either inherited from the repository where the | N/A | Docker container management | `Dockerfile` | `Docker` | {% ifversion ghes %} -{% note %} -**Note:** When enabling the Docker registry, we highly recommend also enabling subdomain isolation. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation)." - -{% endnote %} +> [!NOTE] +> When enabling the Docker registry, we highly recommend also enabling subdomain isolation. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation)." {% endif %} {% ifversion ghec %} -> [!NOTE] The Apache Maven and Gradle registries are not available for {% data variables.enterprise.data_residency %}. +> [!NOTE] +> The Apache Maven and Gradle registries are not available for {% data variables.enterprise.data_residency %}. {% endif %} diff --git a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index 43a8bc0ed7f4..bfdbe11a7432 100644 --- a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -95,14 +95,9 @@ Create a new workflow file in your repository (such as `.github/workflows/deploy {% else %} -{% 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 # @@ -210,11 +205,10 @@ Using the `GITHUB_TOKEN`, instead of a {% data variables.product.pat_v1 %} with 1. Navigate to your package landing page. {% data reusables.package_registry.package-settings-actions-access %} 1. To ensure your package has access to your workflow, you must add the repository where the workflow is stored to your package. {% data reusables.package_registry.package-settings-add-repo %} - {% note %} - **Note:** Adding a repository to your package {% data variables.package_registry.package-settings-actions-access-menu %} is different than connecting your package to a repository. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)" and "[AUTOTITLE](/packages/learn-github-packages/connecting-a-repository-to-a-package)." + > [!NOTE] + > Adding a repository to your package {% data variables.package_registry.package-settings-actions-access-menu %} is different than connecting your package to a repository. For more information, see "[AUTOTITLE](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)" and "[AUTOTITLE](/packages/learn-github-packages/connecting-a-repository-to-a-package)." - {% endnote %} 1. Optionally, use {% data variables.package_registry.package-settings-actions-access-role-dropdown %} 1. Open your workflow file. On the line where you log in to the registry, replace your {% data variables.product.pat_generic %} with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. diff --git a/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md index 0c39b805b59d..aea2a1f600b3 100644 --- a/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md @@ -29,11 +29,8 @@ topics: {% ifversion docker-ghcr-enterprise-migration %} -{% note %} - -**Note**: {% data reusables.package_registry.container-registry-ghes-migration-availability %} For more information about finding the version of {% data variables.product.product_name %} that you use, see "[AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)." - -{% endnote %} +> [!NOTE] +> {% data reusables.package_registry.container-registry-ghes-migration-availability %} For more information about finding the version of {% data variables.product.product_name %} that you use, see "[AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)." {% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index b8cf515b02b1..7211bca0a7d4 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -93,11 +93,8 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen {% data reusables.package_registry.docker_registry_deprecation_status %} -{% note %} - -**Note:** Image names must only use lowercase letters. - -{% endnote %} +> [!NOTE] +> Image names must only use lowercase letters. {% data variables.product.prodname_registry %} supports multiple top-level Docker images per repository. A repository can have any number of image tags. You may experience degraded service publishing or installing Docker images larger than 10GB, layers are capped at 5GB each. For more information, see "[Docker tag](https://docs.docker.com/engine/reference/commandline/tag/)" in the Docker documentation. @@ -187,11 +184,9 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen {% endif %} {% endif %} - {% note %} - - **Note:** You must push your image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. - {% endnote %} + > [!NOTE] + > You must push your image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. ### Example publishing a Docker image @@ -291,11 +286,8 @@ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME {% endif %} {% endif %} -{% note %} - -**Note:** You must pull the image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. - -{% endnote %} +> [!NOTE] +> You must pull the image using `IMAGE_NAME:VERSION` and not using `IMAGE_NAME:SHA`. ## Further reading diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md index cfc5484ec7cb..71429bad86d5 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -43,11 +43,8 @@ Replace REGISTRY_URL with the URL for your instance's Maven registry. If your in Replace USERNAME with your {% data variables.product.prodname_dotcom %} username, TOKEN with your {% data variables.product.pat_v1 %}, REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the personal account or organization on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. -{% note %} - -**Note:** {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} For an example, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)." - -{% endnote %} +> [!NOTE] +> {% data reusables.package_registry.apache-maven-snapshot-versions-supported %} For an example, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)." #### Example using Gradle Groovy for a single package in a repository diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index d21f181d2367..a41c73031789 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -109,21 +109,15 @@ $ npm login --scope=@NAMESPACE --auth-type=legacy --registry=https://HOSTNAME/_r ## Publishing a package +> [!NOTE] {% ifversion packages-npm-v2 %} -{% note %} -**Note:** +> * Package names and scopes must only use lowercase letters. +> * The tarball for an npm version must be smaller than 256MB in size. -* Package names and scopes must only use lowercase letters. -* The tarball for an npm version must be smaller than 256MB in size. - -{% endnote %} {% else %} -{% note %} - -**Note:** Package names and scopes must only use lowercase letters. -{% endnote %} +> Package names and scopes must only use lowercase letters. {% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index 03af9c951ade..f5c3a1ba548e 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -108,11 +108,8 @@ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else 1. Publish a package to {% data variables.product.prodname_registry %}, replacing `NAMESPACE` with the name of the personal account or organization {% ifversion packages-rubygems-v2 %}to which the package will be scoped{% else %}that owns the repository containing your project{% endif %} and `GEM_NAME` with the name of your gem package.{% ifversion ghes %} Replace `REGISTRY_URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace `HOSTNAME` with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} - {% note %} - - **Note:** The maximum uncompressed size of a gem's `metadata.gz` file must be less than {% data variables.package_registry.limit_rubygems_max_metadata_size %}. Requests to push gems that exceed that limit will fail. - - {% endnote %} + > [!NOTE] + > The maximum uncompressed size of a gem's `metadata.gz` file must be less than {% data variables.package_registry.limit_rubygems_max_metadata_size %}. Requests to push gems that exceed that limit will fail. ```shell $ gem push --key github \ diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md index 484d498cdb0f..2270725d2090 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md @@ -40,11 +40,8 @@ For example, if the custom domain for your user site is `www.octocat.com`, and y You can override the default custom domain by adding a custom domain to the individual repository. -{% note %} - -**Note:** The URLs for project sites that are privately published are not affected by the custom domain for your user or organization site. For more information about privately published sites, see "[AUTOTITLE](/enterprise-cloud@latest/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} - -{% endnote %} +> [!NOTE] +> The URLs for project sites that are privately published are not affected by the custom domain for your user or organization site. For more information about privately published sites, see "[AUTOTITLE](/enterprise-cloud@latest/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} To remove the default custom domain, you must remove the custom domain from your user or organization site. diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index bb874816d622..531858edd00b 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -34,11 +34,8 @@ The `dig` command, which can be used to verify correct configuration of DNS reco {% endwindows %} -{% note %} - -**Note:** DNS changes can take up to 24 hours to propagate. - -{% endnote %} +> [!NOTE] +> DNS changes can take up to 24 hours to propagate. ## Configuring an apex domain @@ -97,11 +94,8 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom ### Configuring an apex domain and the `www` subdomain variant -{% note %} - -**Note:** Setting up a `www` subdomain alongside an apex domain is recommended for HTTPS secured websites. - -{% endnote %} +> [!NOTE] +> Setting up a `www` subdomain alongside an apex domain is recommended for HTTPS secured websites. {% data reusables.pages.www-and-apex-domain-recommendation %} For more information, see "[Configuring a subdomain](#configuring-a-subdomain)." @@ -118,13 +112,10 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.sidebar-pages %} 1. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file directly to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow, no `CNAME` file is created, so you need to create one manually (containing only a line of text with your custom domain). For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." - {% note %} - - **Note:** If your custom domain is an internationalized domain name, you must enter the Punycode encoded version. - - For more information on Punycodes, see [Internationalized domain name](https://en.wikipedia.org/wiki/Internationalized_domain_name). - - {% endnote %} + > [!NOTE] + > If your custom domain is an internationalized domain name, you must enter the Punycode encoded version. + > + > For more information on Punycodes, see [Internationalized domain name](https://en.wikipedia.org/wiki/Internationalized_domain_name). 1. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} @@ -143,11 +134,8 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} - {% note %} - - **Note:** If you point your custom subdomain to your apex domain, you will encounter issues with enforcing HTTPS to your website, and you may encounter issues where your subdomain does not reach your {% data variables.product.prodname_pages %} site at all. - - {% endnote %} + > [!NOTE] + > If you point your custom subdomain to your apex domain, you will encounter issues with enforcing HTTPS to your website, and you may encounter issues where your subdomain does not reach your {% data variables.product.prodname_pages %} site at all. ## DNS records for your custom domain diff --git a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index c9f7d625f46a..2801f3a7a365 100644 --- a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -78,11 +78,10 @@ When you configure your site to publish with {% data variables.product.prodname_ The workflow templates use a deployment environment called `github-pages`. If your repository does not already include an environment called `github-pages`, the environment will be created automatically. We recommend that you add a deployment protection rule so that only the default branch can deploy to this environment. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)." {% ifversion fpt or ghec %} -{% note %} -**Note**: A `CNAME` file in your repository file does not automatically add or remove a custom domain. Instead, you must configure the custom domain through your repository settings or through the API. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" and "[AUTOTITLE](/rest/pages#update-information-about-a-github-pages-site)." +> [!NOTE] +> A `CNAME` file in your repository file does not automatically add or remove a custom domain. Instead, you must configure the custom domain through your repository settings or through the API. For more information, see "[AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" and "[AUTOTITLE](/rest/pages#update-information-about-a-github-pages-site)." -{% endnote %} {% endif %} ### Troubleshooting publishing with a custom {% data variables.product.prodname_actions %} workflow diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index 13c5bcdbde4c..0161dd609924 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -23,11 +23,8 @@ All {% data variables.product.prodname_pages %} sites, including sites that are {% data reusables.pages.private_pages_are_public_warning %} -{% note %} - -**Note:** RFC3280 states that the maximum length of the common name should be 64 characters. Therefore, the entire domain name of your {% data variables.product.prodname_pages %} site must be less than 64 characters long for a certificate to be successfully created. - -{% endnote %} +> [!NOTE] +> RFC3280 states that the maximum length of the common name should be 64 characters. Therefore, the entire domain name of your {% data variables.product.prodname_pages %} site must be less than 64 characters long for a certificate to be successfully created. ## Enforcing HTTPS for your {% data variables.product.prodname_pages %} site @@ -54,11 +51,8 @@ Assets are commonly found in the following locations: * JavaScript is usually found in the `` section or just before the closing `` tag. * Images are often found in the `` section. -{% tip %} - -**Tip:** If you can't find your assets in your site's source files, try searching your site's source files for `http` in your text editor or on {% data variables.product.product_name %}. - -{% endtip %} +> [!TIP] +> If you can't find your assets in your site's source files, try searching your site's source files for `http` in your text editor or on {% data variables.product.product_name %}. ### Examples of assets referenced in an HTML file diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 5641e8a4a833..0700709435e1 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -99,11 +99,8 @@ You can enable additional plugins by adding the plugin's gem to the `plugins` se For a list of supported plugins, see "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. For usage information for a specific plugin, see the plugin's documentation. -{% tip %} - -**Tip:** You can make sure you're using the latest version of all plugins by keeping the {% data variables.product.prodname_pages %} gem updated. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)" and "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. - -{% endtip %} +> [!TIP] +> You can make sure you're using the latest version of all plugins by keeping the {% data variables.product.prodname_pages %} gem updated. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem)" and "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. {% data variables.product.prodname_pages %} cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to {% data variables.product.product_name %}. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 0dd777b20532..207b41f37803 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -23,11 +23,8 @@ If you are publishing from a branch, sometimes {% data variables.product.prodnam * You're pushing with a deploy key. If you want to automate pushes to your site's repository, you can set up a machine user instead. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#machine-users)." * You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see "[Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" on Travis CI, or your CI service's documentation. -{% note %} - -**Note:** It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. - -{% endnote %} +> [!NOTE] +> It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. {% ifversion build-pages-with-actions %} If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md index 90ca33e3657f..12964ce92387 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md @@ -49,20 +49,16 @@ Before you can use Jekyll to test a site, you must: > Server running... press ctrl-c to stop. ``` - {% note %} - - **Notes:** - * If you've installed Ruby 3.0 or later (which you may have if you installed the default version via Homebrew), you might get an error at this step. That's because these versions of Ruby no longer come with `webrick` installed. - - To fix the error, try running `bundle add webrick`, then re-running `bundle exec jekyll serve`. - - * If your `_config.yml` file's `baseurl` field contains your GitHub repository's link, you can use the following command when building locally to ignore that value and serve the site on `localhost:4000/`: - - ```shell - bundle exec jekyll serve --baseurl="" - ``` - - {% endnote %} + > [!NOTE] + > * If you've installed Ruby 3.0 or later (which you may have if you installed the default version via Homebrew), you might get an error at this step. That's because these versions of Ruby no longer come with `webrick` installed. + > + > To fix the error, try running `bundle add webrick`, then re-running `bundle exec jekyll serve`. + > + > * If your `_config.yml` file's `baseurl` field contains your GitHub repository's link, you can use the following command when building locally to ignore that value and serve the site on `localhost:4000/`: + > + > ```shell + > bundle exec jekyll serve --baseurl="" + > ``` 1. To preview your site, in your web browser, navigate to `http://localhost:4000`. diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md index 5fbad0ccff22..88785e1f55d8 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md @@ -21,11 +21,8 @@ You can only resolve merge conflicts on {% data variables.product.product_name % If a site administrator disables the merge conflict editor for pull requests between repositories, you cannot use the conflict editor on {% data variables.product.product_name %} and must resolve merge conflicts on the command line. For example, if the merge conflict editor is disabled, you cannot use it on a pull request between a fork and upstream repository. {% endif %} -{% warning %} - -**Warning:** When you resolve a merge conflict on {% data variables.product.product_name %}, the entire [base branch](/get-started/learning-about-github/github-glossary#base-branch) of your pull request is merged into the [head branch](/get-started/learning-about-github/github-glossary#head-branch). Make sure you really want to commit to this branch. If the head branch is the default branch of your repository, you'll be given the option of creating a new branch to serve as the head branch for your pull request. If the head branch is protected you won't be able to merge your conflict resolution into it, so you'll be prompted to create a new head branch. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." - -{% endwarning %} +> [!WARNING] +> When you resolve a merge conflict on {% data variables.product.product_name %}, the entire [base branch](/get-started/learning-about-github/github-glossary#base-branch) of your pull request is merged into the [head branch](/get-started/learning-about-github/github-glossary#head-branch). Make sure you really want to commit to this branch. If the head branch is the default branch of your repository, you'll be given the option of creating a new branch to serve as the head branch for your pull request. If the head branch is protected you won't be able to merge your conflict resolution into it, so you'll be prompted to create a new head branch. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." {% data reusables.repositories.sidebar-pr %} 1. In the "Pull Requests" list, click the pull request with a merge conflict that you'd like to resolve. @@ -33,11 +30,8 @@ If a site administrator disables the merge conflict editor for pull requests bet ![Screenshot of a warning that a pull request has a merge conflict. The "Resolve merge conflicts" button is outlined in dark orange.](/assets/images/help/pull_requests/resolve-merge-conflicts-button.png) - {% note %} - - **Note:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% ifversion ghes %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." - - {% endnote %} + > [!NOTE] + > If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% ifversion ghes %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." {% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} 1. If you have more than one merge conflict in your file, scroll down to the next set of conflict markers and repeat steps four and five to resolve your merge conflict. diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index 21a6ab1e43a4..994721e13670 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -17,11 +17,8 @@ shortTitle: Resolve merge conflicts in Git --- Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)." -{% tip %} - -**Tip:** You can use the conflict editor on {% data variables.product.product_name %} to resolve competing line change merge conflicts between branches that are part of a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." - -{% endtip %} +> [!TIP] +> You can use the conflict editor on {% data variables.product.product_name %} to resolve competing line change merge conflicts between branches that are part of a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." ## Competing line change merge conflicts diff --git a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md index 0687fb1fcdd5..2aa839375f3c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md +++ b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md @@ -35,11 +35,8 @@ There are two types of status checks on {% data variables.product.product_name % _Checks_ are different from _commit statuses_ in that they provide line annotations, more detailed messaging, and are only available for use with {% data variables.product.prodname_github_apps %}. -{% note %} - -**Note:** {% data variables.product.prodname_actions %} generates checks, not commit statuses, when workflows are run. - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_actions %} generates checks, not commit statuses, when workflows are run. Organization owners and users with push access to a repository can create checks and commit statuses with {% data variables.product.product_name %}'s API. For more information, see "[AUTOTITLE](/rest/checks)" and "[AUTOTITLE](/rest/commits/statuses)." @@ -47,11 +44,8 @@ Organization owners and users with push access to a repository can create checks When _checks_ are set up in a repository, pull requests have a **Checks** tab where you can view detailed build output from checks and rerun failed checks. -{% note %} - -**Note:** The **Checks** tab only gets populated for pull requests if you set up _checks_, not _commit statuses_, for the repository. - -{% endnote %} +> [!NOTE] +> The **Checks** tab only gets populated for pull requests if you set up _checks_, not _commit statuses_, for the repository. When a specific line in a commit causes a check to fail, you will see details about the failure, warning, or notice next to the relevant code in the **Files** tab of the pull request. diff --git a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks.md b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks.md index 35208b4eb16d..c90f8cbf1e28 100644 --- a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks.md +++ b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/troubleshooting-required-status-checks.md @@ -16,19 +16,13 @@ shortTitle: Required status checks --- If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[AUTOTITLE](/rest/checks)." -{% note %} - -**Note:** To be required, status checks must have completed successfully within the chosen repository during the past seven days. - -{% endnote %} +> [!NOTE] +> To be required, status checks must have completed successfully within the chosen repository during the past seven days. After you enable required status checks, your branch may need to be up-to-date with the base branch before merging. This ensures that your branch has been tested with the latest code from the base branch. If your branch is out of date, you'll need to merge the base branch into your branch. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging)." -{% note %} - -**Note:** You can also bring your branch up to date with the base branch using Git rebase. For more information, see "[AUTOTITLE](/get-started/using-git/about-git-rebase)." - -{% endnote %} +> [!NOTE] +> You can also bring your branch up to date with the base branch using Git rebase. For more information, see "[AUTOTITLE](/get-started/using-git/about-git-rebase)." You won't be able to push local changes to a protected branch until all required status checks pass. Instead, you'll receive an error message similar to the following. @@ -37,11 +31,8 @@ remote: error: GH006: Protected branch update failed for refs/heads/main. remote: error: Required status check "ci-build" is failing ``` -{% note %} - -**Note:** Pull requests that are up-to-date and pass required status checks can be merged locally and pushed to the protected branch. This can be done without status checks running on the merge commit itself. - -{% endnote %} +> [!NOTE] +> Pull requests that are up-to-date and pass required status checks can be merged locally and pushed to the protected branch. This can be done without status checks running on the merge commit itself. ## Required check needs to succeed against the latest commit SHA @@ -55,16 +46,14 @@ If there is a conflict between the test merge commit and head commit, the checks ## Handling skipped but required checks -{% warning %} - -**Warning:** If a workflow is skipped due to [path filtering](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), [branch filtering](/actions/using-workflows/workflow-syntax-for-github-actions#onpull_requestpull_request_targetbranchesbranches-ignore) or a [commit message](/actions/managing-workflow-runs/skipping-workflow-runs), then checks associated with that workflow will remain in a "Pending" state. A pull request that requires those checks to be successful will be blocked from merging. - -{% data reusables.pull_requests.path-filtering-required-workflows %} - -If, however, a job within a workflow is skipped due to a conditional, it will report its status as "Success". For more information, see "[AUTOTITLE](/actions/using-jobs/using-conditions-to-control-job-execution)." - -When a job fails, any jobs that depend on the failed job are skipped and do not report a failure. A pull request that requires the check may not be blocked. To use a required check on a job that depends on other jobs, use the `always()` conditional expression in addition to `needs`, see "[AUTOTITLE](/actions/using-jobs/using-jobs-in-a-workflow#defining-prerequisite-jobs)." -{% endwarning %} +> [!WARNING] +> If a workflow is skipped due to [path filtering](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), [branch filtering](/actions/using-workflows/workflow-syntax-for-github-actions#onpull_requestpull_request_targetbranchesbranches-ignore) or a [commit message](/actions/managing-workflow-runs/skipping-workflow-runs), then checks associated with that workflow will remain in a "Pending" state. A pull request that requires those checks to be successful will be blocked from merging. +> +> {% data reusables.pull_requests.path-filtering-required-workflows %} +> +> If, however, a job within a workflow is skipped due to a conditional, it will report its status as "Success". For more information, see "[AUTOTITLE](/actions/using-jobs/using-conditions-to-control-job-execution)." +> +> When a job fails, any jobs that depend on the failed job are skipped and do not report a failure. A pull request that requires the check may not be blocked. To use a required check on a job that depends on other jobs, use the `always()` conditional expression in addition to `needs`, see "[AUTOTITLE](/actions/using-jobs/using-jobs-in-a-workflow#defining-prerequisite-jobs)." ### Example @@ -104,11 +93,8 @@ Due to [path filtering](/actions/using-workflows/workflow-syntax-for-github-acti You **must** use the `merge_group` event to trigger your {% data variables.product.prodname_actions %} workflow when a pull request is added to a merge queue. -{% note %} - -**Note:** {% data reusables.actions.merge-group-event-with-required-checks %} - -{% endnote %} +> [!NOTE] +> {% data reusables.actions.merge-group-event-with-required-checks %} A workflow that reports a check which is required by the target branch's protections would look like this: diff --git a/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md b/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md index 8e2a434b2340..d2843c60d02c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md +++ b/content/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models.md @@ -19,11 +19,8 @@ shortTitle: Collaborative development In the fork and pull model, anyone can fork an existing ("upstream") repository to which they have read access and the owner of the upstream repository allows it. Be aware that a fork and its upstream share the same git data. This means that all content uploaded to a fork is accessible from the upstream and all other forks of that upstream. You do not need permission from the upstream repository to push to a fork of it you created. You can optionally allow anyone with push access to the upstream repository to make changes to your pull request branch. This model is popular with open-source projects as it reduces the amount of friction for new contributors and allows people to work independently without upfront coordination. -{% tip %} - -**Tip:** {% data reusables.open-source.open-source-guide-general %} {% data reusables.open-source.open-source-learning %} - -{% endtip %} +> [!TIP] +> {% data reusables.open-source.open-source-guide-general %} {% data reusables.open-source.open-source-learning %} ## Shared repository model diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md index 3f8077b5cf9c..623c0a588538 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md @@ -41,13 +41,11 @@ People with write permissions to a repository can enable auto-merge for a pull r {% ifversion fpt %} 1. If you chose the merge or squash and merge methods, type a commit message and description and choose the email address you want to author the merge commit. - {% note %} + > [!NOTE] + > The email dropdown menu is not available if you have email privacy enabled or if you only have one verified and visible email associated with your {% data variables.product.company_short %} account. - **Note:** The email dropdown menu is not available if you have email privacy enabled or if you only have one verified and visible email associated with your {% data variables.product.company_short %} account. - - {% endnote %} - {% endif %} - {% ifversion ghes or ghec %} + {% endif %} + {% ifversion ghes or ghec %} 1. If you chose the merge or squash and merge methods, type a commit message and description. {% endif %} 1. Click **Confirm auto-merge**. diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request.md index 5cf1952bc207..0828a3cfa487 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request.md @@ -13,11 +13,9 @@ versions: topics: - Pull requests --- -{% tip %} -**Tip**: If you opened a pull request with the wrong base branch, rather than closing it out and opening a new one, you can instead change the base branch. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)." - -{% endtip %} +> [!TIP] +> If you opened a pull request with the wrong base branch, rather than closing it out and opening a new one, you can instead change the base branch. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request)." {% data reusables.repositories.sidebar-pr %} 1. In the "Pull Requests" list, click the pull request you'd like to close. diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md index 590fd0544eb2..84a06d99a21f 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md @@ -22,11 +22,8 @@ product: '{% data reusables.gated-features.merge-queue %}' {% webui %} -{% note %} - -**Note:** You can use {% data variables.product.prodname_cli %} to add a pull request to a merge queue. For more information, click the "{% data variables.product.prodname_cli %}" tab at the top of this article. - -{% endnote %} +> [!NOTE] +> You can use {% data variables.product.prodname_cli %} to add a pull request to a merge queue. For more information, click the "{% data variables.product.prodname_cli %}" tab at the top of this article. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-pr %} @@ -39,11 +36,8 @@ product: '{% data reusables.gated-features.merge-queue %}' ![Screenshot of the merge queue options for a pull request.](/assets/images/help/pull_requests/merge-queue-options.png) - {% note %} - - **Note:** You can click **Merge when ready** whenever you're ready to merge your proposed changes. {% data variables.product.product_name %} will automatically add the pull request to the merge queue once required approval and status checks conditions are met. - - {% endnote %} + > [!NOTE] + > You can click **Merge when ready** whenever you're ready to merge your proposed changes. {% data variables.product.product_name %} will automatically add the pull request to the merge queue once required approval and status checks conditions are met. 1. Confirm you want to add the pull request to the merge queue by clicking **Confirm merge when ready**. diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md index 91b0cb43a186..d54fd9c6911a 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md @@ -31,12 +31,9 @@ You can't merge a draft pull request. For more information about draft pull requ The repository may be configured so that the head branch for a pull request is automatically deleted when you merge a pull request. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches)." -{% note %} - -**Note:** {% data reusables.pull_requests.retargeted-on-branch-deletion %} -For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#working-with-branches)." - -{% endnote %} +> [!NOTE] +> {% data reusables.pull_requests.retargeted-on-branch-deletion %} +> For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#working-with-branches)." Pull requests are merged using [the `--no-ff` option](https://git-scm.com/docs/git-merge#_fast_forward_merge), except for [pull requests with squashed or rebased commits](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges), which are merged using the fast-forward option. @@ -60,21 +57,17 @@ If you decide you don't want the changes in a topic branch to be merged to the u * [Rebase the commits individually onto the base branch](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#rebase-and-merge-your-pull-request-commits) by clicking the merge dropdown menu, selecting **Rebase and merge** and then clicking **Rebase and merge**. - {% note %} + > [!NOTE] + > Rebase and merge will always update the committer information and create new commit SHAs. For more information, see "[About pull request merges](/articles/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)." - **Note:** Rebase and merge will always update the committer information and create new commit SHAs. For more information, see "[About pull request merges](/articles/about-pull-request-merges#rebase-and-merge-your-pull-request-commits)." - - {% endnote %} 1. If prompted, type a commit message, or accept the default message. {% data reusables.pull_requests.default-commit-message-squash-merge %} {% data reusables.files.choose-commit-email %} - {% note %} - - **Note:** The email selector is not available for rebase merges, which do not create a merge commit{% ifversion squash-merge-email %}. For squash merges, the email selector is only shown if you are the pull request author and you have more than one email address associated with your account.{% else %}, or for squash merges, which credit the user who created the pull request as the author of the squashed commit.{% endif %} + > [!NOTE] + > The email selector is not available for rebase merges, which do not create a merge commit{% ifversion squash-merge-email %}. For squash merges, the email selector is only shown if you are the pull request author and you have more than one email address associated with your account.{% else %}, or for squash merges, which credit the user who created the pull request as the author of the squashed commit.{% endif %} - {% endnote %} 1. Click **Confirm merge**, **Confirm squash and merge**, or **Confirm rebase and merge**. 1. Optionally, [delete the branch](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request). This keeps the list of branches in your repository tidy. diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md index 8bed600b6c53..4ab2cf643266 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request.md @@ -19,16 +19,13 @@ Reverting a pull request on {% data variables.product.product_name %} creates a ## Reverting a pull request -{% note %} - -**Note:** You may need to revert the individual commits in your pull request if either of the following is true. - -* Reverting the pull request causes merge conflicts -* The original pull request was not originally merged on {% data variables.product.product_name %}. For example, someone could have merged the pull request using a fast-forward merge on the command line. - -For more information about using Git to manually revert individual commits, see [Git revert](https://git-scm.com/docs/git-revert.html) in the Git documentation. - -{% endnote %} +> [!NOTE] +> You may need to revert the individual commits in your pull request if either of the following is true. +> +> * Reverting the pull request causes merge conflicts +> * The original pull request was not originally merged on {% data variables.product.product_name %}. For example, someone could have merged the pull request using a fast-forward merge on the command line. +> +> For more information about using Git to manually revert individual commits, see [Git revert](https://git-scm.com/docs/git-revert.html) in the Git documentation. {% data reusables.repositories.sidebar-pr %} 1. In the "Pull Requests" list, click the pull request you'd like to revert. diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md index 658dbfe19ac6..b049a2d5ee92 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md @@ -57,11 +57,8 @@ Now when you merge the `feature2` pull request, it'll be merged into the `main` Repository administrators {% ifversion edit-repository-rules %}or custom roles with the "edit repository rules" permission {% endif %}can enable protections on a branch. If you're working on a branch that's protected, you won't be able to delete or force push to the branch. Repository administrators can additionally enable several other protected branch settings to enforce various workflows before a branch can be merged. -{% note %} - -**Note:** If you're a repository administrator, you can merge pull requests on branches with branch protections enabled even if the pull request does not meet the requirements, unless branch protections have been set to "Include administrators." - -{% endnote %} +> [!NOTE] +> If you're a repository administrator, you can merge pull requests on branches with branch protections enabled even if the pull request does not meet the requirements, unless branch protections have been set to "Include administrators." To see if your pull request can be merged, look in the merge box at the bottom of the pull request's **Conversation** tab. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md index 233042fdf956..747752f070fa 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md @@ -14,11 +14,9 @@ topics: - Pull requests shortTitle: Compare branches --- -{% note %} -**Note:** When creating your pull request, you can change the base branch that you're comparing your changes against. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)." - -{% endnote %} +> [!NOTE] +> When creating your pull request, you can change the base branch that you're comparing your changes against. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)." You can view proposed changes in a pull request in the Files changed tab. ![Screenshot of the tabs for a pull request. The "Files changed" tab is outlined in dark orange.](/assets/images/help/pull_requests/pull-request-tabs-changed-files.png) @@ -27,11 +25,8 @@ Rather than viewing the commits themselves, you can view the proposed changes as ## Diff view options -{% tip %} - -**Tip:** If you're having a hard time understanding the context of a change, you can click **View** in the Files changed tab to view the whole file with the proposed changes. - -{% endtip %} +> [!TIP] +> If you're having a hard time understanding the context of a change, you can click **View** in the Files changed tab to view the whole file with the proposed changes. You have several options for viewing a diff: * The unified view shows updated and existing content together in a linear view. diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 6c2424d99ad5..cd738e20d5f5 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -19,13 +19,10 @@ topics: A pull request is a proposal to merge a set of changes from one branch into another. In a pull request, collaborators can review and discuss the proposed set of changes before they integrate the changes into the main codebase. Pull requests display the differences, or diffs, between the content in the source branch and the content in the target branch. -{% note %} - -**Note:** When working with pull requests, keep the following in mind: -* If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes. -* Be very careful when force pushing commits to a pull request. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on. - -{% endnote %} +> [!NOTE] +> When working with pull requests, keep the following in mind: +> * If you're working in the [shared repository model](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), we recommend that you use a topic branch for your pull request. While you can send pull requests from any branch or commit, with a topic branch you can push follow-up commits if you need to update your proposed changes. +> * Be very careful when force pushing commits to a pull request. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on. You can create pull requests on {% data variables.product.prodname_dotcom_the_website %}, with {% data variables.product.prodname_desktop %}{% ifversion fpt or ghec %}, in {% data variables.product.prodname_github_codespaces %}{% endif %}, on {% data variables.product.prodname_mobile %}, and when using GitHub CLI. @@ -45,13 +42,9 @@ After you're happy with the proposed changes, you can merge the pull request. If {% data reusables.pull_requests.close-issues-using-keywords %} -{% tip %} - -**Tips:** -* To toggle between collapsing and expanding all outdated review comments in a pull request, hold down OptionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." -* You can squash commits when merging a pull request to gain a more streamlined view of changes. See "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." - -{% endtip %} +> [!TIP] +> * To toggle between collapsing and expanding all outdated review comments in a pull request, hold down OptionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." +> * You can squash commits when merging a pull request to gain a more streamlined view of changes. See "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." You can visit your dashboard to quickly find links to recently updated pull requests you're working on or subscribed to. See "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard)." diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md index 30c568be5777..0127d45aecba 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request.md @@ -14,11 +14,9 @@ topics: - Pull requests shortTitle: Change the base branch --- -{% warning %} -**Warning**: When you change the base branch of your pull request, some commits may be removed from the timeline. Review comments may also become outdated, as the line of code that the comment referenced may no longer be part of the changes in the pull request. - -{% endwarning %} +> [!WARNING] +> When you change the base branch of your pull request, some commits may be removed from the timeline. Review comments may also become outdated, as the line of code that the comment referenced may no longer be part of the changes in the pull request. {% data reusables.repositories.sidebar-pr %} 1. In the "Pull Requests" list, click the pull request you'd like to modify. @@ -32,11 +30,8 @@ shortTitle: Change the base branch 1. Read the information about changing the base branch and click **Change base**. -{% tip %} - -**Tip:** When you open a pull request, {% data variables.product.product_name %} will set the base to the commit that branch references. If the branch is updated in the future, {% data variables.product.product_name %} will not update the base branch's commit. - -{% endtip %} +> [!TIP] +> When you open a pull request, {% data variables.product.product_name %} will set the base to the commit that branch references. If the branch is updated in the future, {% data variables.product.product_name %} will not update the base branch's commit. ## Further reading diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md index fa4902c0f0c0..e63c600a2b94 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md @@ -20,11 +20,8 @@ shortTitle: Change the state {% data reusables.pull_requests.mark-ready-review %} -{% tip %} - -**Tip**: You can also mark a pull request as ready for review using the {% data variables.product.prodname_cli %}. For more information, see "[`gh pr ready`](https://cli.github.com/manual/gh_pr_ready)" in the {% data variables.product.prodname_cli %} documentation. - -{% endtip %} +> [!TIP] +> You can also mark a pull request as ready for review using the {% data variables.product.prodname_cli %}. For more information, see "[`gh pr ready`](https://cli.github.com/manual/gh_pr_ready)" in the {% data variables.product.prodname_cli %} documentation. {% data reusables.repositories.sidebar-pr %} 1. In the "Pull requests" list, click the pull request you'd like to mark as ready for review. diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md index 2fbe918b8023..7e2ec51b1cfb 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -22,20 +22,16 @@ You can only make commits on pull request branches that: Only the user who created the pull request can give you permission to push commits to the user-owned fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)." -{% note %} - -**Note:** You can also make commits to a pull request branch from a fork of your repository through {% data variables.location.product_location %} by creating your own copy (or fork) of the fork of your repository and committing changes to the same head branch that the original pull request changes were created on. For some general guidelines, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)." - -{% endnote %} +> [!NOTE] +> You can also make commits to a pull request branch from a fork of your repository through {% data variables.location.product_location %} by creating your own copy (or fork) of the fork of your repository and committing changes to the same head branch that the original pull request changes were created on. For some general guidelines, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)." 1. On {% data variables.product.product_name %}, navigate to the main page of the fork (or copy of your repository) where the pull request branch was created. {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} - {% tip %} - **Tip:** If you prefer to clone the fork using {% data variables.product.prodname_desktop %}, then see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository#cloning-a-repository-to-github-desktop)." + > [!TIP] + > If you prefer to clone the fork using {% data variables.product.prodname_desktop %}, then see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository#cloning-a-repository-to-github-desktop)." - {% endtip %} 1. Change the current working directory to the location where you want to download the cloned directory. ```shell @@ -59,11 +55,9 @@ Only the user who created the pull request can give you permission to push commi > Unpacking objects: 100% (10/10), done. ``` - {% tip %} + > [!TIP] + > The error message "fatal: destination path 'REPOSITORY-NAME' already exists and is not an empty directory" means that your current working directory already contains a repository with the same name. To resolve the error, you must clone the fork in a different directory. - **Tip:** The error message "fatal: destination path 'REPOSITORY-NAME' already exists and is not an empty directory" means that your current working directory already contains a repository with the same name. To resolve the error, you must clone the fork in a different directory. - - {% endtip %} 1. Navigate into your new cloned repository. ```shell @@ -78,11 +72,9 @@ Only the user who created the pull request can give you permission to push commi git checkout TEST-BRANCH ``` - {% tip %} - - **Tip:** For more information about pull request branches, including examples, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)." + > [!TIP] + > For more information about pull request branches, including examples, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository)." - {% endtip %} 1. At this point, you can do anything you want with this branch. You can push new commits to it, run some local tests, or merge other branches into the branch. Make modifications as you like. 1. After you commit your changes to the head branch of the pull request you can push your changes up to the original pull request directly. In this example, the head branch is `test-branch`: diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md index 7305a67a49f3..d790ecc502cc 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md @@ -36,13 +36,9 @@ When you change the base repository, you also change notifications for the pull When you change any of the information in the branch range, the Commit and Files changed preview areas will update to show your new range. -{% tip %} - -**Tips**: -* Using the compare view, you can set up comparisons across any timeframe. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits)." -* Project maintainers can add a pull request template for a repository. Templates include prompts for information in the body of a pull request. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." - -{% endtip %} +> [!TIP] +> * Using the compare view, you can set up comparisons across any timeframe. For more information, see "[AUTOTITLE](/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits)." +> * Project maintainers can add a pull request template for a repository. Templates include prompts for information in the body of a pull request. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." ## Creating the pull request diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md index 71c2b915bb99..415a1dc0b4fa 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md @@ -19,11 +19,8 @@ shortTitle: Create & delete branches You can create a branch in different ways on {% data variables.product.product_name %}. -{% note %} - -**Note:** You can only create a branch in a repository to which you have push access. - -{% endnote %} +> [!NOTE] +> You can only create a branch in a repository to which you have push access. ### Creating a branch via the branches overview @@ -71,11 +68,8 @@ You can create a branch to work on an issue directly from the issue page and get {% data reusables.pull_requests.automatically-delete-branches %} -{% note %} - -**Note:** If the branch you want to delete is the repository's default branch, you must choose a new default branch before deleting the branch. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch)." - -{% endnote %} +> [!NOTE] +> If the branch you want to delete is the repository's default branch, you must choose a new default branch before deleting the branch. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch)." If the branch you want to delete is associated with an open pull request, you must merge or close the pull request before deleting the branch. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" or "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/closing-a-pull-request)." diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md index b9ba962c8e8a..2ebc007b51b9 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md @@ -22,11 +22,8 @@ To assign a reviewer to a pull request, you will need write access to the reposi Organization members with write access can also assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)." -{% note %} - -**Note:** Pull request authors can't request reviews unless they are either a repository owner or collaborator with write access to the repository. - -{% endnote %} +> [!NOTE] +> Pull request authors can't request reviews unless they are either a repository owner or collaborator with write access to the repository. {% ifversion copilot-hadron %} diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md index 9a3a09c2489b..5732462aaa4e 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md @@ -13,11 +13,8 @@ topics: You can use query parameters to open pull requests. Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results or a pull request template on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair. -{% tip %} - -**Tip:** You can also create pull request templates that open with default labels, assignees, and a pull request title. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)." - -{% endtip %} +> [!TIP] +> You can also create pull request templates that open with default labels, assignees, and a pull request title. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)." You must have the proper permissions for any action to use the equivalent query parameter. For example, you must have permission to add a label to a pull request to use the `labels` query parameter. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md index 5c68871fa13b..f83439462e30 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md @@ -51,11 +51,8 @@ You can view all of the reviews a pull request has received in the Conversation {% data reusables.pull_requests.required-reviews-for-prs-summary %} For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-pull-request-reviews-before-merging)." -{% tip %} - -**Tip**: If necessary, people with _admin_ or _write_ access to a repository can dismiss a pull request review. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." - -{% endtip %} +> [!TIP] +> If necessary, people with _admin_ or _write_ access to a repository can dismiss a pull request review. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." ## Further reading diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md index 1bc941808288..0f532f0a80c0 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews.md @@ -20,11 +20,8 @@ You can comment on a pull request, approve the changes, or request improvements {% data reusables.search.requested_reviews_search %} -{% tip %} - -**Tip**: If a pull request you approved has changed significantly, you can dismiss your review. The pull request will need a new review before it can be merged. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." - -{% endtip %} +> [!TIP] +> If a pull request you approved has changed significantly, you can dismiss your review. The pull request will need a new review before it can be merged. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." {% data reusables.repositories.sidebar-pr %} {% data reusables.repositories.choose-pr-review %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md index 13976dc4b849..28e7166cae4b 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md @@ -15,11 +15,9 @@ topics: - Pull requests shortTitle: Check out a PR locally --- -{% note %} - **Note:** Pull request authors can give upstream repository maintainers, or those with push access to the upstream repository, permission to make commits to their pull request's compare branch in a user-owned fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)." - - {% endnote %} +> [!NOTE] +> Pull request authors can give upstream repository maintainers, or those with push access to the upstream repository, permission to make commits to their pull request's compare branch in a user-owned fork. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)." ## Modifying an active pull request locally @@ -106,8 +104,5 @@ The remote `refs/pull/` namespace is _read-only_. If you try to push any commits error: failed to push some refs to 'git@github.local:USERNAME/REPOSITORY.git' ``` -{% tip %} - -**Tip:** When you remove or rename a remote reference, your local `refs/pull/origin/` namespace will not be affected by calls to `git-remote`. - -{% endtip %} +> [!TIP] +> When you remove or rename a remote reference, your local `refs/pull/origin/` namespace will not be affected by calls to `git-remote`. diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index 569cf2c55842..5f1963d37776 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -25,21 +25,14 @@ You can also comment on specific {% ifversion pull-request-comment-on-file %}fil For more information on adding line {% ifversion pull-request-comment-on-file %}or file {% endif %}comments to a pull request review, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." -{% note %} - -**Note:** If you reply to a pull request via email, your comment will be added on the **Conversation** tab and will not be part of a pull request review. - -{% endnote %} +> [!NOTE] +> If you reply to a pull request via email, your comment will be added on the **Conversation** tab and will not be part of a pull request review. To reply to an existing line {% ifversion pull-request-comment-on-file %}or file {% endif %}comment, you'll need to navigate to the comment on either the **Conversation** tab or **Files changed** tab and add an additional comment below it. -{% tip %} - -**Tips:** -* Pull request comments support the same [formatting](/get-started/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references. -* You can add reactions to comments in pull requests in the **Files changed** tab. - -{% endtip %} +> [!TIP] +> * Pull request comments support the same [formatting](/get-started/writing-on-github) as regular comments on {% data variables.product.product_name %}, such as @mentions, emoji, and references. +> * You can add reactions to comments in pull requests in the **Files changed** tab. ## Adding comments to a pull request diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md index 2b2897f817fd..952f099835f9 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request.md @@ -19,11 +19,8 @@ You can filter files in a pull request by file extension type, such as `.html` o ## Using the file filter dropdown -{% tip %} - -**Tip:** To simplify your pull request diff view, you can also temporarily hide deleted files or files you have already viewed in the pull request diff from the file filter drop-down menu. - -{% endtip %} +> [!TIP] +> To simplify your pull request diff view, you can also temporarily hide deleted files or files you have already viewed in the pull request diff from the file filter drop-down menu. {% data reusables.repositories.sidebar-pr %} 1. In the list of pull requests, click the pull request you'd like to filter. @@ -46,11 +43,8 @@ You can filter files in a pull request by file extension type, such as `.html` o 1. Click on a file in the file tree to view the corresponding file diff. If the file tree is hidden, click {% octicon "sidebar-collapse" aria-label="The sidebar collapse icon" %} to display the file tree. - {% note %} - - **Note**: The file tree will not display if your screen width is too narrow or if the pull request only includes one file. - - {% endnote %} + > [!NOTE] + > The file tree will not display if your screen width is too narrow or if the pull request only includes one file. ![Screenshot of the "Files changed" tab of a pull request. In the left sidebar, the file tree is outlined in dark orange.](/assets/images/help/repository/file-tree.png) 1. To filter by file path, enter part or all of the file path in the **Filter changed files** search box. Alternatively, use the file filter dropdown. For more information, see "[Using the file filter dropdown](#using-the-file-filter-dropdown)." diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md index b778f98c8149..04669dc13ee0 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md @@ -32,11 +32,8 @@ The summary list of methods and functions is created from these supported file t 1. Select the changed function or method from the drop-down menu. You can also enter the name of the function or method to filter results. - {% note %} - - **Note:** If you don't see the functions or methods you expected, confirm that your code compiles and doesn't contain errors. Only functions and methods changed in this pull request and found in _.go_, _.js_, _.ts_, _.py_, _.php_, and _.rb_ files appear in the drop-down menu. - - {% endnote %} + > [!NOTE] + > If you don't see the functions or methods you expected, confirm that your code compiles and doesn't contain errors. Only functions and methods changed in this pull request and found in _.go_, _.js_, _.ts_, _.py_, _.php_, and _.rb_ files appear in the drop-down menu. 1. You'll be redirected to the first line of the function or method you selected. diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index 8b233d2176e5..d02258476b9d 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -46,11 +46,8 @@ You can configure the {% data variables.dependency-review.action_name %} to bett ![Screenshot of the "Changed files" tab. A dropdown labeled "File filter" is expanded, displaying a list of file types with checkboxes.](/assets/images/help/pull_requests/file-filter-menu-json.png) The dependency review provides a clearer view of what has changed in large lock files, where the source diff is not rendered by default. - {% note %} - - **Note:** Dependency review rich diffs are not available for committed static JavaScript files like `jquery.js`. - - {% endnote %} + > [!NOTE] + > Dependency review rich diffs are not available for committed static JavaScript files like `jquery.js`. 1. On the right of the header for a manifest or lock file, display the dependency review by clicking **{% octicon "file" aria-label="Display the rich diff" %}**. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md index 3214f9bee49c..34294afe1b1a 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks.md @@ -34,11 +34,8 @@ Deleting a fork will not delete the original upstream repository. Code pushed to For instructions for forking a repository, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)." For more information about when you can create forks, and the permission and visibility settings of forks, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)." -{% tip %} - -**Tip:** {% data reusables.repositories.desktop-fork %} - -{% endtip %} +> [!TIP] +> {% data reusables.repositories.desktop-fork %} ## Forking a repository versus duplicating a repository diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md index daceb936241b..c90c21e04037 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md @@ -16,22 +16,14 @@ To turn your fork into a standalone repository, you can clone the fork, use the The new repository will no longer automatically sync with changes from the original repository. -{% note %} - -**Notes:** - -* The new repository will not retain any of its issues, pull requests, wikis, stars, watchers, comments, child forks, or other metadata that may currently be associated with your current fork. -* All commit metadata will be preserved. Commits may become eligible to be counted as contributions, if they meet certain criteria. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)." - -{% endnote %} +> [!NOTE] +> * The new repository will not retain any of its issues, pull requests, wikis, stars, watchers, comments, child forks, or other metadata that may currently be associated with your current fork. +> * All commit metadata will be preserved. Commits may become eligible to be counted as contributions, if they meet certain criteria. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)." {% ifversion ghes %} -{% note %} - -**Note:** If you are unable to detach a fork, contact your site administrator. - -{% endnote %} +> [!NOTE] +> If you are unable to detach a fork, contact your site administrator. {% endif %} @@ -48,11 +40,8 @@ You can delete a fork and recreate the same repository, without the connection t 1. Delete the forked repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)."

- {% warning %} - - **Warning**: Deleting a fork will **permanently** delete any associated pull requests and configurations. This action **cannot** be undone. - - {% endwarning %} + > [!WARNING] + > Deleting a fork will **permanently** delete any associated pull requests and configurations. This action **cannot** be undone. 1. Create a new repository with the same name in the same location. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)." 1. Mirror-push the repository back to the same remote URL. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md index a7c7939de73e..7119d629a632 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md @@ -64,9 +64,8 @@ You might fork a project to propose changes to the upstream repository. In this For many forking scenarios, such as contributing to open-source projects, you only need to copy the default branch. If you do not select this option, all branches will be copied into the new fork. 1. Click **Create fork**. -{% note %} - -**Note:** If you want to copy additional branches from the upstream repository, you can do so from the **Branches** page. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)."{% endnote %} +> [!NOTE] +> If you want to copy additional branches from the upstream repository, you can do so from the **Branches** page. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)." {% endwebui %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md index 75d6431e9b48..240f6ffa5dad 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md @@ -100,8 +100,5 @@ Before you can sync your fork with an upstream repository, you must configure a If your local branch had unique commits, you may need to resolve conflicts. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)." -{% tip %} - -**Tip**: Syncing your fork only updates your local copy of the repository. To update your fork on {% data variables.location.product_location %}, you must [push your changes](/get-started/using-git/pushing-commits-to-a-remote-repository). - -{% endtip %} +> [!TIP] +> Syncing your fork only updates your local copy of the repository. To update your fork on {% data variables.location.product_location %}, you must [push your changes](/get-started/using-git/pushing-commits-to-a-remote-repository). diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md index 987019888e98..8964810d98c9 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md @@ -54,11 +54,8 @@ You can use the file tree to navigate between files in a commit. {% data reusables.repositories.navigate-to-commit %} 1. Click on a file in the file tree to view the corresponding file diff. If the file tree is hidden, click {% octicon "sidebar-collapse" aria-label="The sidebar collapse icon" %} to display the file tree. - {% note %} - - **Note**: The file tree will not display if your screen width is too narrow or if the commit only includes one file. - - {% endnote %} + > [!NOTE] + > The file tree will not display if your screen width is too narrow or if the commit only includes one file. ![Screenshot of the "Files changed" tab of a pull request. In the left sidebar, the file tree is outlined in dark orange.](/assets/images/help/repository/file-tree.png) 1. To filter by file path, enter part or all of the file path in the **Filter changed files** search box. diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index 98f935c7c852..65b28e5a8b13 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -32,11 +32,8 @@ Organizations can use the `name@organization.com` email as a public point of con > ``` - {% tip %} - - **Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer. - - {% endtip %} + > [!TIP] + > If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `on-behalf-of:` commit trailer. 1. On the next line of the commit message, type `on-behalf-of: @org `, then a closing quotation mark. diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md index dd60e7639b78..67393df683b3 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md @@ -21,13 +21,10 @@ If a person chooses to keep their email address private, you should use their {% For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)." - {% tip %} - - **Tip:** You can help a co-author find their preferred email address by sharing this information: -* To find your {% data variables.product.product_name %}-provided `no-reply` email, navigate to your email settings page under "Keep my email address private." -* To find the email you used to configure Git on your computer, run `git config user.email` on the command line. - - {% endtip %} +> [!TIP] +> You can help a co-author find their preferred email address by sharing this information: +> * To find your {% data variables.product.product_name %}-provided `no-reply` email, navigate to your email settings page under "Keep my email address private." +> * To find the email you used to configure Git on your computer, run `git config user.email` on the command line. {% endif %} @@ -47,11 +44,8 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit > ``` - {% tip %} - - **Tip:** If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `Co-authored-by:` commit trailer. - - {% endtip %} + > [!TIP] + > If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the `Co-authored-by:` commit trailer. 1. On the next line of the commit message, type `Co-authored-by: name ` with specific information for each co-author. After the co-author information, add a closing quotation mark. diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md index e22125bc79a3..181020015be0 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md @@ -41,11 +41,8 @@ git fetch REMOTE This safely copies information from the remote repository to your local clone without making any changes to the files you have checked out. You can use `git fetch upstream` to get information from a repository you've forked, or `git fetch origin` to get information from a repository you've only cloned. -{% tip %} - -**Tip**: For more information, read about [managing remotes and fetching data](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) in the [Pro Git](https://git-scm.com/book) book. - -{% endtip %} +> [!TIP] +> For more information, read about [managing remotes and fetching data](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) in the [Pro Git](https://git-scm.com/book) book. ## The branch that contained the commit was deleted diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md index f6bbea8f9235..542f88ba203a 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md @@ -12,11 +12,9 @@ versions: ghec: '*' shortTitle: Linked to wrong user --- -{% tip %} -**Note**: If your commits are linked to another user, that does not mean the user can access your repository. A user can only access a repository you own if you add them as a collaborator or add them to a team that has access to the repository. - -{% endtip %} +> [!NOTE] +> If your commits are linked to another user, that does not mean the user can access your repository. A user can only access a repository you own if you add them as a collaborator or add them to a team that has access to the repository. ## Commits are linked to another user diff --git a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md index e8735054ed1c..87ae5878fd87 100644 --- a/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md +++ b/content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md @@ -36,11 +36,8 @@ To compare tags, you can select a tag name from the `compare` drop-down menu at Here's an example of a [comparison between two tags](https://github.com/octocat/linguist/compare/v2.2.0...octocat:v2.3.3). -{% note %} - -**Note:** If a branch and a tag have the same name, the branch will be used when comparing commits. You can compare the tag specifically by adding `tags/` to the tag name. - -{% endnote %} +> [!NOTE] +> If a branch and a tag have the same name, the branch will be used when comparing commits. You can compare the tag specifically by adding `tags/` to the tag name. ## Comparing commits diff --git a/content/repositories/archiving-a-github-repository/archiving-repositories.md b/content/repositories/archiving-a-github-repository/archiving-repositories.md index cb3bbc108cd9..7d43152c531d 100644 --- a/content/repositories/archiving-a-github-repository/archiving-repositories.md +++ b/content/repositories/archiving-a-github-repository/archiving-repositories.md @@ -19,19 +19,17 @@ topics: ## About repository archival {% ifversion fpt or ghec %} -{% note %} -**Note:** If you have a legacy per-repository billing plan, you will still be charged for your archived repository. If you don't want to be charged for an archived repository, you must upgrade to a new product. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)." +> [!NOTE] +> If you have a legacy per-repository billing plan, you will still be charged for your archived repository. If you don't want to be charged for an archived repository, you must upgrade to a new product. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)." -{% endnote %} {% endif %} {% ifversion ghec or ghes %} -{% note %} -**Note:** Customers who use {% data variables.product.prodname_GH_advanced_security %} can enable {% data variables.product.prodname_secret_scanning %} on archived repositories. For more information, see "[AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning)." +> [!NOTE] +> Customers who use {% data variables.product.prodname_GH_advanced_security %} can enable {% data variables.product.prodname_secret_scanning %} on archived repositories. For more information, see "[AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning)." -{% endnote %} {% endif %} {% data reusables.repositories.archiving-repositories-recommendation %} diff --git a/content/repositories/archiving-a-github-repository/backing-up-a-repository.md b/content/repositories/archiving-a-github-repository/backing-up-a-repository.md index eb4b2df0b583..70d1fff8f248 100644 --- a/content/repositories/archiving-a-github-repository/backing-up-a-repository.md +++ b/content/repositories/archiving-a-github-repository/backing-up-a-repository.md @@ -55,22 +55,16 @@ You can use the REST API to generate a migration archive for a repository. For m These archives are designed for moving data between {% data variables.product.prodname_dotcom %} products, but they can also be used {% ifversion fpt or ghec %}to back up a repository for archiving purposes{% else %} as backups.{% endif %} -{% warning %} - -**Warning:** Migration archives do not include all data related to a repository. For example, {% data variables.large_files.product_name_long %} objects, discussions, or packages are not included. For more information on what is included in migration archives, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/about-migrations-between-github-products)." - -{% endwarning %} +> [!WARNING] +> Migration archives do not include all data related to a repository. For example, {% data variables.large_files.product_name_long %} objects, discussions, or packages are not included. For more information on what is included in migration archives, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/about-migrations-between-github-products)." Once you have generated an archive, you can move it to a location of your choice for safe-keeping. {% ifversion ghes %} Migration archives can be restored to your {% data variables.product.prodname_ghe_server %} instance using the `ghe-migrator` tool, which is accessible over SSH. For more information, see "[AUTOTITLE](/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)." -{% warning %} - -**Warning:** Migration archives are not designed to be used as backups, and it is not guaranteed that a migration archive generated today will be restorable in future versions of {% data variables.product.prodname_ghe_server %}. - -{% endwarning %} +> [!WARNING] +> Migration archives are not designed to be used as backups, and it is not guaranteed that a migration archive generated today will be restorable in future versions of {% data variables.product.prodname_ghe_server %}. {% else %} There is no supported, documented way to restore migration archives on {% data variables.product.prodname_dotcom %}, so these backups are only suitable for archiving purposes. diff --git a/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md index e7520d4e464d..08f3a5a493d3 100644 --- a/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md +++ b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md @@ -16,14 +16,10 @@ shortTitle: Reference & cite content To make your repositories easier to reference in academic literature, you can create persistent identifiers, also known as Digital Object Identifiers (DOIs). You can use the data archiving tool [Zenodo](https://about.zenodo.org/) to archive a repository on {% data variables.product.prodname_dotcom %} and issue a DOI for the archive. -{% tip %} - -**Tips:** -* Zenodo can only access public repositories, so make sure the repository you want to archive is [public](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility). -* If you want to archive a repository that belongs to an organization, the organization owner may need to [approve access](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) for the Zenodo application. -* Make sure to include a [license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) in your repository so readers know how they can reuse your work. - -{% endtip %} +> [!TIP] +> * Zenodo can only access public repositories, so make sure the repository you want to archive is [public](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility). +> * If you want to archive a repository that belongs to an organization, the organization owner may need to [approve access](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) for the Zenodo application. +> * Make sure to include a [license](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) in your repository so readers know how they can reuse your work. 1. Navigate to the [login page](https://zenodo.org/login) for Zenodo. 1. Click **Log in with {% data variables.product.prodname_dotcom %}**. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md index 10c24542c564..9d596d630a61 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md @@ -16,11 +16,10 @@ shortTitle: About merge methods {% data reusables.pull_requests.configure_pull_request_merges_intro %} You can enforce one type of merge method, such as commit squashing or rebasing, by only enabling the desired method for your repository. {% ifversion merge-queue %} -{% note %} -**Note:** When using the merge queue, you no longer get to choose the merge method, as this is controlled by the queue. {% data reusables.pull_requests.merge-queue-references %} +> [!NOTE] +> When using the merge queue, you no longer get to choose the merge method, as this is controlled by the queue. {% data reusables.pull_requests.merge-queue-references %} -{% endnote %} {% endif %} {% data reusables.pull_requests.default_merge_option %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index 2a0f34d1ebb0..cbc15707a6a9 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -21,25 +21,17 @@ For more information on merging a pull request using a merge queue, see "[AUTOTI ## Configuring continuous integration (CI) workflows for merge queues -{% note %} - -**Notes:** - -* A merge queue cannot be enabled with branch protection rules that use wildcard characters (`*`) in the branch name pattern. -* A merge queue will wait for required checks to be reported before it can proceed with merging. You must update your CI configuration to trigger and report on merge group events when requiring a merge queue. -* Merge queue and pull requests checks are coupled and configured under branch protection rules or rulesets. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#managing-a-merge-queue)." - -{% endnote %} +> [!NOTE] +> * A merge queue cannot be enabled with branch protection rules that use wildcard characters (`*`) in the branch name pattern. +> * A merge queue will wait for required checks to be reported before it can proceed with merging. You must update your CI configuration to trigger and report on merge group events when requiring a merge queue. +> * Merge queue and pull requests checks are coupled and configured under branch protection rules or rulesets. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#managing-a-merge-queue)." ### Triggering merge group checks with {% data variables.product.prodname_actions %} You **must** use the `merge_group` event to trigger your {% data variables.product.prodname_actions %} workflow when a pull request is added to a merge queue. -{% note %} - -**Note:** {% data reusables.actions.merge-group-event-with-required-checks %} - -{% endnote %} +> [!NOTE] +> {% data reusables.actions.merge-group-event-with-required-checks %} A workflow that reports a check which is required by the target branch's protections would look like this: @@ -75,11 +67,8 @@ Once you have enabled the "Require merge queue" setting, you can also access the * **Merge limits**: Select the minimum and maximum number of pull requests to merge into the base branch at the same time (between `1` and `100`), and a timeout after which the queue should stop waiting for more entries and merge with fewer than the minimum number. -{% note %} - -**Note:** Merge limits do not combine `merge_group` **builds**. Merge limits only affect merges to the base branch once one or more `merge_group` has satisfied build checks. - -{% endnote %} + > [!NOTE] + > Merge limits do not combine `merge_group` **builds**. Merge limits only affect merges to the base branch once one or more `merge_group` has satisfied build checks. | Merge Limit | Use Case | | ----------- | -------- | @@ -125,11 +114,8 @@ The following scenario outlines what happens when a CI reports a failing status When adding a pull request to a merge queue, there is an option to move your pull request to the top of the queue. -{% note %} - -**Note:** Be aware that jumping to the top of a merge queue will cause a full rebuild of all in-progress pull requests, as the reordering of the queue introduces a break in the commit graph. Heavily utilizing this feature can slow down the velocity of merges for your target branch. - -{% endnote %} +> [!NOTE] +> Be aware that jumping to the top of a merge queue will cause a full rebuild of all in-progress pull requests, as the reordering of the queue introduces a break in the commit graph. Heavily utilizing this feature can slow down the velocity of merges for your target branch. The following scenario outlines what happens when a user jumps the queue. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md index fbf76212666f..16c268b4dabe 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch.md @@ -20,11 +20,10 @@ shortTitle: Change the default branch You can choose the default branch for a repository. The default branch is the base branch for pull requests and code commits. For more information about the default branch, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch)." {% ifversion ghes < 3.13 %} -{% note %} -**Note**: If you use the Git-Subversion bridge, changing the default branch will affect your `trunk` branch contents and the `HEAD` you see when you list references for the remote repository. For more information, see "[AUTOTITLE](/get-started/working-with-subversion-on-github/support-for-subversion-clients)" and [git-ls-remote](https://git-scm.com/docs/git-ls-remote.html) in the Git documentation. +> [!NOTE] +> If you use the Git-Subversion bridge, changing the default branch will affect your `trunk` branch contents and the `HEAD` you see when you list references for the remote repository. For more information, see "[AUTOTITLE](/get-started/working-with-subversion-on-github/support-for-subversion-clients)" and [git-ls-remote](https://git-scm.com/docs/git-ls-remote.html) in the Git documentation. -{% endnote %} {% endif %} You can also rename the default branch. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch)." diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md index 28c3467fede1..e54306c41b62 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md @@ -38,11 +38,10 @@ By default, the restrictions of a branch protection rule don't apply to people w {% data reusables.pull_requests.you-can-auto-merge %} {% ifversion repo-rules %} -{% note %} -**Note:** Only a single branch protection rule can apply at a time, which means it can be difficult to know which rule will apply when multiple versions of a rule target the same branch. {% ifversion repo-rules-enterprise %}Additionally, you may want to create a single set of rules that applies to multiple repositories in an organization. {% endif %}For information about an alternative to branch protection rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." +> [!NOTE] +> Only a single branch protection rule can apply at a time, which means it can be difficult to know which rule will apply when multiple versions of a rule target the same branch. {% ifversion repo-rules-enterprise %}Additionally, you may want to create a single set of rules that applies to multiple repositories in an organization. {% endif %}For information about an alternative to branch protection rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." -{% endnote %} {% endif %} ## About branch protection settings @@ -130,20 +129,14 @@ Requires all comments on the pull request to be resolved before it can be merged When you enable required commit signing on a branch, contributors {% ifversion fpt or ghec %}and bots{% endif %} can only push commits that have been signed and verified to the branch. For more information, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)." -{% note %} - +> [!NOTE] {% ifversion fpt or ghec %} -**Notes:** - -* If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)." -* If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. - +> * If you have enabled vigilant mode, which indicates that your commits will always be signed, any commits that {% data variables.product.prodname_dotcom %} identifies as "Partially verified" are permitted on branches that require signed commits. For more information about vigilant mode, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits)." +> * If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% else %} -**Note:** If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. +> If a collaborator pushes an unsigned commit to a branch that requires commit signatures, the collaborator will need to rebase the commit to include a verified signature, then force push the rewritten commit to the branch. {% endif %} -{% endnote %} - You can always push local commits to the branch if the commits are signed and verified. {% ifversion fpt or ghec %}You can also merge signed and verified commits into the branch using a pull request on {% data variables.product.product_name %}. However, you cannot squash and merge a pull request into the branch on {% data variables.product.product_name %} unless you are the author of the pull request.{% else %} However, you cannot merge pull requests into the branch on {% data variables.product.product_name %}.{% endif %} You can {% ifversion fpt or ghec %}squash and {% endif %}merge pull requests locally. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally)." {% ifversion fpt or ghec %} For more information about merge methods, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github)."{% endif %} @@ -217,8 +210,5 @@ If a site administrator has blocked force pushes to the default branch only, you By default, you cannot delete a protected branch. When you enable deletion of a protected branch, anyone with at least write permissions to the repository can delete the branch. -{% note %} - -**Note:** If the branch is locked, you cannot delete the branch even if you have permission to delete it. - -{% endnote %} +> [!NOTE] +> If the branch is locked, you cannot delete the branch even if you have permission to delete it. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md index 7f7a4dd1a4a0..d596bfbfd874 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule.md @@ -43,22 +43,18 @@ To create an exception to an existing branch rule, you can create a new branch p For more information about each of the available branch protection settings, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." {% ifversion repo-rules %} -{% note %} -**Note:** Only a single branch protection rule can apply at a time, which means it can be difficult to know how which rule will apply when multiple versions of a rule target the same branch. {% ifversion repo-rules-enterprise %}Additionally, you may want to create a single set of rules that applies to multiple repositories in an organization. {% endif %}For information about an alternative to branch protection rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." +> [!NOTE] +> Only a single branch protection rule can apply at a time, which means it can be difficult to know how which rule will apply when multiple versions of a rule target the same branch. {% ifversion repo-rules-enterprise %}Additionally, you may want to create a single set of rules that applies to multiple repositories in an organization. {% endif %}For information about an alternative to branch protection rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." -{% endnote %} {% endif %} ## Creating a branch protection rule When you create a branch rule, the branch you specify doesn't have to exist yet in the repository. -{% note %} - -**Note:** Actors may only be added to bypass lists when the repository belongs to an organization. - -{% endnote %} +> [!NOTE] +> Actors may only be added to bypass lists when the repository belongs to an organization. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md index 7f8ab81adb1b..36cbdb0e3463 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md @@ -15,11 +15,10 @@ After creating a ruleset, you can still make changes to it. For example, you can You can use the REST and GraphQL APIs to manage rulesets. For more information, see "[AUTOTITLE](/rest/repos/rules)" and "[AUTOTITLE](/graphql/reference/mutations#createrepositoryruleset)." {% ifversion repo-rules-enterprise %} -{% tip %} -**Tip:** If you're the owner of an organization, you can create rulesets at the organization level. You can apply these rulesets to specific repositories in your organization, and to specific branches in those repositories. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization)." +> [!TIP] +> If you're the owner of an organization, you can create rulesets at the organization level. You can apply these rulesets to specific repositories in your organization, and to specific branches in those repositories. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization)." -{% endtip %} {% endif %} ## Viewing rulesets for a repository @@ -41,11 +40,10 @@ For push rulesets for forked repositories, the "Rulesets" page will indicate tha ## Editing a ruleset {% ifversion repo-rules-enterprise %} -{% note %} -**Note:** If a ruleset was created at the organization level, you cannot edit the ruleset from the repository's settings. If you have permission to edit the ruleset, you can do so in your organization's settings. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#editing-a-ruleset)." +> [!NOTE] +> If a ruleset was created at the organization level, you cannot edit the ruleset from the repository's settings. If you have permission to edit the ruleset, you can do so in your organization's settings. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#editing-a-ruleset)." -{% endnote %} {% endif %} {% data reusables.repositories.about-editing-rulesets %} diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index 945b589026ad..e4b6caff9f90 100644 --- a/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -91,21 +91,19 @@ People with admin permissions for a repository can change an existing repository {% data reusables.repositories.about-internal-repos %} For more information on innersource, see {% data variables.product.prodname_dotcom %}'s whitepaper "[An introduction to innersource](https://resources.github.com/whitepapers/introduction-to-innersource/)." {% ifversion ghec %} -{% note %} -**Note:** You can only create internal repositories if you use {% data variables.product.prodname_ghe_cloud %} with an enterprise account. An enterprise account is a separate type of account that allows a central point of management for multiple organizations. For more information, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)." +> [!NOTE] +> You can only create internal repositories if you use {% data variables.product.prodname_ghe_cloud %} with an enterprise account. An enterprise account is a separate type of account that allows a central point of management for multiple organizations. For more information, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)." -{% endnote %} {% endif %} All enterprise members have read permissions to the internal repository, but internal repositories are not visible to people {% ifversion fpt or ghec %}outside of the enterprise{% else %}who are not members of any organization{% endif %}, including outside collaborators on organization repositories. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-members)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." {% ifversion ghes %} -{% note %} -**Note:** A user must be part of an organization to be an enterprise member and have access to internal repositories. If a user on {% data variables.location.product_location %} is not a member of any organization, that user will not have access to internal repositories. +> [!NOTE] +> A user must be part of an organization to be an enterprise member and have access to internal repositories. If a user on {% data variables.location.product_location %} is not a member of any organization, that user will not have access to internal repositories. -{% endnote %} {% endif %} {% data reusables.repositories.internal-repo-default %} diff --git a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md index 8314c0ef0cbf..66b1137a007b 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md @@ -18,17 +18,12 @@ versions: topics: - Repositories --- -{% tip %} -**Tip:** Owners can restrict repository creation permissions in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)." +> [!TIP] +> Owners can restrict repository creation permissions in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)." -{% endtip %} - -{% tip %} - -**Tip**: You can also create a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation. - -{% endtip %} +> [!TIP] +> You can also create a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation. {% ifversion create-new-repos-with-query-params %} diff --git a/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md index fa312f7f064d..086bb63a83a2 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md @@ -18,11 +18,8 @@ shortTitle: Create from a template {% data reusables.repositories.about-template-repositories %} For more information about creation of a repository template, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-template-repository)." -{% tip %} - -**Tip**: You can also create a repository from a template using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation. - -{% endtip %} +> [!TIP] +> You can also create a repository from a template using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation. You can choose to include the directory structure and files from only the default branch of the template repository or to include all branches. Branches created from a template have unrelated histories, which means you cannot create pull requests or merge between the branches. @@ -42,11 +39,9 @@ For more information about forks, see "[AUTOTITLE](/pull-requests/collaborating- ![Screenshot of the "Use this template" button and the dropdown menu expanded to show the "Open in a codespace" option.](/assets/images/help/repository/use-this-template-button.png) - {% note %} - - **Note:** Alternatively, you can open the template in a codespace and publish your work to a new repository later. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template)." + > [!NOTE] + > Alternatively, you can open the template in a codespace and publish your work to a new repository later. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template)." - {% endnote %} {% endif %} {% data reusables.repositories.owner-drop-down %} {% data reusables.repositories.repo-name %} diff --git a/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md index 496380d7e531..ab11d090b1c5 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-template-repository.md @@ -25,18 +25,14 @@ To create a template repository, you must create a repository, then make the rep After you make your repository a template, anyone with access to the repository can generate a new repository with the same directory structure and files as your default branch. They can also choose to include all the other branches in your repository. Branches created from a template have unrelated histories, so you cannot create pull requests or merge between the branches. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)." -{% note %} - -**Note**: Your template repository cannot include files stored using {% data variables.large_files.product_name_short %}. - -{% endnote %} +> [!NOTE] +> Your template repository cannot include files stored using {% data variables.large_files.product_name_short %}. {% ifversion fpt %} -{% note %} -**Note:** You can use a template repository as starter code for an assignment on {% data variables.product.prodname_classroom %}. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository)." +> [!NOTE] +> You can use a template repository as starter code for an assignment on {% data variables.product.prodname_classroom %}. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository)." -{% endnote %} {% endif %} {% data reusables.repositories.navigate-to-repo %} diff --git a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index e9bfcc465b50..6b1022c41533 100644 --- a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -18,14 +18,9 @@ topics: Deleting a public repository will not delete any forks of the repository. -{% warning %} - -**Warnings**: - -* Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. -* Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository. - -{% endwarning %} +> [!WARNING] +> * Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. +> * Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository. Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/restoring-a-deleted-repository)."{% endif %} diff --git a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md index e091dbf9b177..752d21028bde 100644 --- a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md @@ -15,11 +15,8 @@ topics: --- {% ifversion fpt or ghec %} -{% note %} - -**Note:** If you have a project hosted on another Git-based hosting service, you can automatically import your project to {% data variables.product.prodname_dotcom %} using the {% data variables.product.prodname_importer %} tool. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer)." - -{% endnote %} +> [!NOTE] +> If you have a project hosted on another Git-based hosting service, you can automatically import your project to {% data variables.product.prodname_dotcom %} using the {% data variables.product.prodname_importer %} tool. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer)." {% endif %} diff --git a/content/repositories/creating-and-managing-repositories/renaming-a-repository.md b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md index cdae6e8d55fb..b5ad227f60b0 100644 --- a/content/repositories/creating-and-managing-repositories/renaming-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md @@ -35,17 +35,11 @@ If you plan to rename a repository that has a {% data variables.product.prodname {% endif %} -{% note %} +> [!NOTE] +> {% data variables.product.prodname_dotcom %} will not redirect calls to an action hosted by a renamed repository. Any workflow that uses that action will fail with the error `repository not found`. Instead, create a new repository and action with the new name and archive the old repository. For more information, see "[AUTOTITLE](/repositories/archiving-a-github-repository/archiving-repositories)." -**Note:** {% data variables.product.prodname_dotcom %} will not redirect calls to an action hosted by a renamed repository. Any workflow that uses that action will fail with the error `repository not found`. Instead, create a new repository and action with the new name and archive the old repository. For more information, see "[AUTOTITLE](/repositories/archiving-a-github-repository/archiving-repositories)." - -{% endnote %} - -{% warning %} - -**Warning**: If you create a new repository under your account in the future, do not reuse the original name of the renamed repository. If you do, redirects to the renamed repository will no longer work. - -{% endwarning %} +> [!WARNING] +> If you create a new repository under your account in the future, do not reuse the original name of the renamed repository. If you do, redirects to the renamed repository will no longer work. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index ed365d70858c..2197215b9d70 100644 --- a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -63,11 +63,9 @@ When you transfer a repository, its issues, pull requests, wiki, stars, and watc git remote set-url origin NEW_URL ``` - {% warning %} + > [!WARNING] + > If you create a new repository or fork at the previous repository location, the redirects to the transferred repository will be deactivated. They can be reactivated by renaming or deleting the new repository or fork. - **Warning**: If you create a new repository or fork at the previous repository location, the redirects to the transferred repository will be deactivated. They can be reactivated by renaming or deleting the new repository or fork. - - {% endwarning %} * When you transfer a repository from an organization to a personal account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a personal account. For more information about repository permission levels, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)."{% ifversion fpt or ghec %} * Sponsors who have access to the repository through a sponsorship tier may be affected. See "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)".{% endif %} * Packages associated with the repository {% ifversion packages-registries-v2 %}may be transferred, or may lose their link to the repository, depending on the registry they belong to{% else %}are transferred as part of the transfer process{% endif %}. See "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-repository-transfers)." diff --git a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md index 83fbe17798eb..bab9b943ffe4 100644 --- a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md +++ b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md @@ -82,11 +82,8 @@ To access {% data variables.product.prodname_dotcom %}, you must authenticate wi When prompted for a username and password, make sure you use an account that has access to the repository. -{% tip %} - -**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/get-started/getting-started-with-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail. - -{% endtip %} +> [!TIP] +> If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/get-started/getting-started-with-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail. ### Use SSH instead diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 6bcaf12bdfcf..71b7533dbfa3 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -55,14 +55,11 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to ## CODEOWNERS syntax -{% warning %} - -**Warning:** There are some syntax rules for gitignore files that _do not work_ in CODEOWNERS files: -* Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment doesn't work -* Using `!` to negate a pattern doesn't work -* Using `[ ]` to define a character range doesn't work - -{% endwarning %} +> [!WARNING] +> There are some syntax rules for gitignore files that _do not work_ in CODEOWNERS files: +> * Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment doesn't work +> * Using `!` to negate a pattern doesn't work +> * Using `[ ]` to define a character range doesn't work A CODEOWNERS file uses a pattern that follows most of the same rules used in [gitignore](https://git-scm.com/docs/gitignore#_pattern_format) files. The pattern is followed by one or more {% data variables.product.prodname_dotcom %} usernames or team names using the standard `@username` or `@org/team-name` format. Users and teams must have explicit `write` access to the repository, even if the team's members already have access. @@ -152,17 +149,14 @@ apps/ @octocat Repository owners can update branch protection rules to ensure that changed code is reviewed by the owners of the changed files. Edit your branch protection rule and enable the option "Require review from Code Owners". For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." -{% note %} - -**Note:** When reviews from code owners are required, an approval from _any_ of the owners is sufficient to meet this requirement. For example, let's say that your CODEOWNERS file contains the following line: - -```text -*.js @global-owner1 @global-owner2 -``` - -This means that changes to JavaScript files could be approved by either `@global-owner1` _or_ `@global-owner2`, but approvals from _both_ are not required. - -{% endnote %} +> [!NOTE] +> When reviews from code owners are required, an approval from _any_ of the owners is sufficient to meet this requirement. For example, let's say that your CODEOWNERS file contains the following line: +> +> ```text +> *.js @global-owner1 @global-owner2 +> ``` +> +> This means that changes to JavaScript files could be approved by either `@global-owner1` _or_ `@global-owner2`, but approvals from _both_ are not required. To protect a repository fully against unauthorized changes, you also need to define an owner for the CODEOWNERS file itself. The most secure method is to define a CODEOWNERS file in the `.github` directory of the repository and define the repository owner as the owner of either the CODEOWNERS file (``/.github/CODEOWNERS @owner_username``) or the whole directory (``/.github/ @owner_username``). diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index 22fc566b2136..6d28627354b0 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -38,11 +38,8 @@ When creating a topic: ## Adding topics to your repository -{% note %} - -**Note:** Topic names are always public, even if you create the topic from within a private repository. - -{% endnote %} +> [!NOTE] +> Topic names are always public, even if you create the topic from within a private repository. {% data reusables.repositories.navigate-to-repo %} 1. In the top right corner of the page, to the right of "About", click {% octicon "gear" aria-label="Edit repository metadata" %}. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md index 86bad53cb18e..e7ffb3efae24 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md @@ -19,11 +19,8 @@ Until you add an image, repository links expand to show basic information about {% ifversion repo-rules %}You can upload an image to a public repository, or to a private repository to which you have previously uploaded an image. Your image can only be shared from a public repository.{% else %}You can upload an image to a private repository, but your image can only be shared from a public repository.{% endif %} -{% tip %} - -**Tip:** Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend a size of at least 640 by 320 pixels (1280 by 640 pixels for best display). - -{% endtip %} +> [!TIP] +> Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend a size of at least 640 by 320 pixels (1280 by 640 pixels for best display). {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} @@ -39,7 +36,5 @@ We support PNG images with transparency. Many communication platforms support a When using an image with transparency, keep in mind how it may look on different color backgrounds or platforms that don't support transparency. -{% tip %} - -**Tip:** If you aren't sure, we recommend using an image with a solid background. -{% endtip %} +> [!TIP] +> If you aren't sure, we recommend using an image with a solid background. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index 66bdc6ec6d51..cb32088ad143 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -54,11 +54,8 @@ tidelift: npm/octo-package custom: ["https://www.paypal.me/octocat", octocat.com] ``` -{% note %} - -**Note:** If a custom URL in an array includes `:`, you must wrap the URL in quotes. For example, `"https://www.paypal.me/octocat"`. - -{% endnote %} +> [!NOTE] +> If a custom URL in an array includes `:`, you must wrap the URL in quotes. For example, `"https://www.paypal.me/octocat"`. You can create a default sponsor button for your organization or personal account. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md index ce739aac7f1b..3f1c9e6f720e 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md @@ -19,11 +19,8 @@ We created [choosealicense.com](https://choosealicense.com), to help you underst You're under no obligation to choose a license. However, without a license, the default copyright laws apply, meaning that you retain all rights to your source code and no one may reproduce, distribute, or create derivative works from your work. If you're creating an open source project, we strongly encourage you to include an open source license. The [Open Source Guide](https://opensource.guide/legal/#which-open-source-license-is-appropriate-for-my-project) provides additional guidance on choosing the correct license for your project. -{% note %} - -**Note:** If you publish your source code in a public repository on {% data variables.product.product_name %}, {% ifversion fpt or ghec %}according to the [Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service), {% endif %}other users of {% data variables.location.product_location %} have the right to view and fork your repository. If you have already created a repository and no longer want users to have access to the repository, you can make the repository private. When you change the visibility of a repository to private, existing forks or local copies created by other users will still exist. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." - -{% endnote %} +> [!NOTE] +> If you publish your source code in a public repository on {% data variables.product.product_name %}, {% ifversion fpt or ghec %}according to the [Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service), {% endif %}other users of {% data variables.location.product_location %} have the right to view and fork your repository. If you have already created a repository and no longer want users to have access to the repository, you can make the repository private. When you change the visibility of a repository to private, existing forks or local copies created by other users will still exist. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." ## Determining the location of your license diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md index e372d1ce3011..be4c7de78ce7 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -26,11 +26,8 @@ shortTitle: Security & analysis {% ifversion dependabot-alerts-enterprise-enablement %} -{% note %} - -**Note:** When {% data variables.product.prodname_dependabot_alerts %} are enabled or disabled at the enterprise level, it overrides the repository level settings for {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts#managing-dependabot-alerts-for-your-enterprise)." - -{% endnote %} +> [!NOTE] +> When {% data variables.product.prodname_dependabot_alerts %} are enabled or disabled at the enterprise level, it overrides the repository level settings for {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts#managing-dependabot-alerts-for-your-enterprise)." {% endif %} @@ -59,10 +56,10 @@ You can manage the security and analysis features for your {% ifversion fpt or g {% data reusables.repositories.navigate-to-code-security-and-analysis %} 1. Under "Code security and analysis", to the right of the feature, click **Disable** or **Enable**. {% ifversion not fpt %}The control for "{% data variables.product.prodname_GH_advanced_security %}" is disabled if your enterprise has no available licenses for {% data variables.product.prodname_advanced_security %}.{% endif %} {% ifversion not fpt %} - {% note %} - **Note:** If you disable {% data variables.product.prodname_GH_advanced_security %}, {% ifversion ghec %}dependency review, {% endif %}{% data variables.secret-scanning.user_alerts %} and {% data variables.product.prodname_code_scanning %} are disabled. Any workflows, SARIF uploads, or API calls for {% data variables.product.prodname_code_scanning %} will fail. If {% data variables.product.prodname_GH_advanced_security %} is re-enabled, {% data variables.product.prodname_code_scanning %} will return to its previous state. - {% endnote %} + > [!NOTE] + > If you disable {% data variables.product.prodname_GH_advanced_security %}, {% ifversion ghec %}dependency review, {% endif %}{% data variables.secret-scanning.user_alerts %} and {% data variables.product.prodname_code_scanning %} are disabled. Any workflows, SARIF uploads, or API calls for {% data variables.product.prodname_code_scanning %} will fail. If {% data variables.product.prodname_GH_advanced_security %} is re-enabled, {% data variables.product.prodname_code_scanning %} will return to its previous state. + {% endif %} ## Granting access to security alerts diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md index 381553240862..01d366f178e8 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md @@ -11,11 +11,8 @@ shortTitle: Manage the push policy ## About the push policy -{% note %} - -**Note:** The push policy is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The push policy is currently in {% data variables.release-phases.public_preview %} and subject to change. By default, there is no limit to the number of branches and tags that can be updated in a single push. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 64cdf01b30d3..29d56cecad1c 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -19,11 +19,8 @@ shortTitle: Repository visibility ## About repository visibility changes -{% note %} - -**Note:** If you can't change a repository's visibility, the organization owner may have restricted the ability to change repository visibility to organization owners only. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." - -{% endnote %} +> [!NOTE] +> If you can't change a repository's visibility, the organization owner may have restricted the ability to change repository visibility to organization owners only. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)." {% ifversion ghec %} @@ -35,15 +32,11 @@ We recommend reviewing the following caveats before you change the visibility of {% ifversion ghes %} -{% warning %} - -**Warning:** Changes to the visibility of a large repository or repository network may affect data integrity. Visibility changes can also have unintended effects on forks. {% data variables.product.company_short %} recommends the following before changing the visibility of a repository network. - -* Wait for a period of reduced activity on {% data variables.location.product_location %}. - -* Contact your site administrator before proceeding. Your site administrator can contact us for further assistance by visiting {% data variables.contact.contact_ent_support %}. - -{% endwarning %} +> [!WARNING] +> Changes to the visibility of a large repository or repository network may affect data integrity. Visibility changes can also have unintended effects on forks. {% data variables.product.company_short %} recommends the following before changing the visibility of a repository network. +> +> * Wait for a period of reduced activity on {% data variables.location.product_location %}. +> * Contact your site administrator before proceeding. Your site administrator can contact us for further assistance by visiting {% data variables.contact.contact_ent_support %}. {% endif %} diff --git a/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md index 90b70ae0ffe8..9d2cbda4fb0f 100644 --- a/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md +++ b/content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md @@ -15,11 +15,9 @@ topics: - Repositories shortTitle: View releases & tags --- -{% tip %} -**Tip**: You can also view a release using the {% data variables.product.prodname_cli %}. For more information, see "[`gh release view`](https://cli.github.com/manual/gh_release_view)" in the {% data variables.product.prodname_cli %} documentation. - -{% endtip %} +> [!TIP] +> You can also view a release using the {% data variables.product.prodname_cli %}. For more information, see "[`gh release view`](https://cli.github.com/manual/gh_release_view)" in the {% data variables.product.prodname_cli %} documentation. ## Viewing releases diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md index 74acb2e09f47..7354abf15004 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories.md @@ -29,11 +29,8 @@ The network graph displays the branch history of the entire repository network, ![Screenshot of the repository network graph.](/assets/images/help/graphs/repo-network-graph.png) -{% tip %} - -**Tip:** To see older branches, click and drag within the graph. - -{% endtip %} +> [!TIP] +> To see older branches, click and drag within the graph. ### Accessing the network graph diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md index 01b31b7a493f..5ad316c5b655 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md @@ -45,11 +45,8 @@ If you don't appear in a repository's contributors graph, it may be because: * Your commits haven't been merged into the default branch. * The email address you used to author the commits isn't connected to your account on {% data variables.product.product_name %}. -{% tip %} - -**Tip:** To list all commit contributors in a repository, see "[AUTOTITLE](/rest/repos/repos#list-repository-contributors)." - -{% endtip %} +> [!TIP] +> To list all commit contributors in a repository, see "[AUTOTITLE](/rest/repos/repos#list-repository-contributors)." If all your commits in the repository are on non-default branches, you won't be in the contributors graph. For example, commits on the `gh-pages` branch aren't included in the graph unless `gh-pages` is the repository's default branch. To have your commits merged into the default branch, you can create a pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md index e2a472ceb382..688364515952 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-deployment-activity-for-your-repository.md @@ -13,11 +13,9 @@ topics: - Repositories shortTitle: View deployment activity --- -{% note %} -**Note:** The deployments dashboard is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The deployments dashboard is currently in {% data variables.release-phases.public_preview %} and subject to change. People with read access to a repository can see an overview of all current deployments and a log of past deployment activity, if the repository's deployment workflow is integrated with {% data variables.product.product_name %} through the Deployments API or an app from [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace/category/deployment). For more information, see "[AUTOTITLE](/rest/repos#deployments)." diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md index 2af110df064d..4b238fd8964f 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository.md @@ -18,11 +18,8 @@ You can navigate to referring sites, excluding search engines and {% data variab Referring sites and popular content are ordered by views and unique visitors. Full clones and visitor information update hourly, while referring sites and popular content sections update daily. All data in the traffic graph uses the UTC+0 timezone, regardless of your location. -{% tip %} - -**Tip:** You can hover over a specific day in the traffic graph to view the exact data for that day. - -{% endtip %} +> [!TIP] +> You can hover over a specific day in the traffic graph to view the exact data for that day. ![Screenshot showing two line graphs for repository traffic. The lines are marked with dots for specific dates.](/assets/images/help/graphs/repo-traffic-graphs-tooltip-dotcom.png) diff --git a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md index ee8fa4dd4cb9..a5ecc9eb0241 100644 --- a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md +++ b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -54,11 +54,8 @@ Your repository may be secured by push protection. With push protection, {% data You can upload an existing file to a repository on {% data variables.product.prodname_dotcom %} using the command line. -{% tip %} - -**Tip:** You can also [add an existing file to a repository from the {% data variables.product.product_name %} website](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository). - -{% endtip %} +> [!TIP] +> You can also [add an existing file to a repository from the {% data variables.product.product_name %} website](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository). {% data reusables.command_line.manipulating_file_prereqs %} diff --git a/content/repositories/working-with-files/managing-files/editing-files.md b/content/repositories/working-with-files/managing-files/editing-files.md index f54714dea43d..778d61534609 100644 --- a/content/repositories/working-with-files/managing-files/editing-files.md +++ b/content/repositories/working-with-files/managing-files/editing-files.md @@ -20,17 +20,11 @@ shortTitle: Edit files ## Editing files in your repository -{% tip %} +> [!TIP] +> {% data reusables.repositories.protected-branches-block-web-edits-uploads %} -**Tip**: {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} - -{% note %} - -**Note:** {% data variables.product.product_name %}'s file editor uses [CodeMirror](https://codemirror.net/). - -{% endnote %} +> [!NOTE] +> {% data variables.product.product_name %}'s file editor uses [CodeMirror](https://codemirror.net/). 1. In your repository, browse to the file you want to edit. {% data reusables.repositories.edit-file %} diff --git a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md index 0262bd031847..4b56ff2316be 100644 --- a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md +++ b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md @@ -20,15 +20,10 @@ In addition to changing the file location, you can also [update the contents of ## Moving a file to a new location on {% data variables.product.product_name %} -{% tip %} - -**Tips**: - -* If you try to move a file in a repository that you don’t have access to, we'll fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. -* Some files, such as images, require that you move them from the command line. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location)". -* {% data reusables.repositories.protected-branches-block-web-edits-uploads %} - -{% endtip %} +> [!TIP] +> * If you try to move a file in a repository that you don’t have access to, we'll fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +> * Some files, such as images, require that you move them from the command line. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location)". +> * {% data reusables.repositories.protected-branches-block-web-edits-uploads %} 1. In your repository, browse to the file you want to move. {% data reusables.repositories.edit-file %} diff --git a/content/repositories/working-with-files/managing-files/renaming-a-file.md b/content/repositories/working-with-files/managing-files/renaming-a-file.md index 02b1874ea156..fff230aeb09d 100644 --- a/content/repositories/working-with-files/managing-files/renaming-a-file.md +++ b/content/repositories/working-with-files/managing-files/renaming-a-file.md @@ -20,15 +20,10 @@ topics: Renaming a file also gives you the opportunity to [move the file to a new location](/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location). -{% tip %} - -**Tips**: - -* If you try to rename a file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. -* File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. -* Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](#renaming-a-file-using-the-command-line)." - -{% endtip %} +> [!TIP] +> * If you try to rename a file in a repository that you don’t have access to, we will fork the project to your personal account and help you send [a pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) to the original repository after you commit your change. +> * File names created via the web interface can only contain alphanumeric characters and hyphens (`-`). To use other characters, create and commit the files locally and then push them to the repository. +> * Some files, such as images, require that you rename them from the command line. For more information, see "[Renaming a file using the command line](#renaming-a-file-using-the-command-line)." 1. In your repository, browse to the file you want to rename. {% data reusables.repositories.edit-file-button %} diff --git a/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md index fb2f7eb6bf6f..1c6201d57f8e 100644 --- a/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/about-git-large-file-storage.md @@ -48,13 +48,9 @@ size 84977953 It tracks the `version` of {% data variables.large_files.product_name_short %} you're using, followed by a unique identifier for the file (`oid`). It also stores the `size` of the final file. -{% note %} - -**Notes**: -* {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites. -* {% data variables.large_files.product_name_short %} cannot be used with template repositories. - -{% endnote %} +> [!NOTE] +> * {% data variables.large_files.product_name_short %} cannot be used with {% data variables.product.prodname_pages %} sites. +> * {% data variables.large_files.product_name_short %} cannot be used with template repositories. ## Further reading diff --git a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md index e509cb50e6e2..49234032c871 100644 --- a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md +++ b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -31,11 +31,8 @@ shortTitle: Large files {% data variables.product.product_name %} limits the size of files allowed in repositories. If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](#removing-files-from-a-repositorys-history)." -{% note %} - -**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." - -{% endnote %} +> [!NOTE] +> If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." {% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks files larger than {% data variables.large_files.max_github_size %}. {% ifversion ghes %}However, a site administrator can configure a different limit for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)."{% endif %} @@ -67,11 +64,8 @@ You can prevent your repository from impacting your infrastructure by effectivel ## Removing files from a repository's history -{% warning %} - -**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.location.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. - -{% endwarning %} +> [!WARNING] +> These procedures will permanently remove files from the repository on your computer and {% data variables.location.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. ### Removing a file added in the most recent unpushed commit diff --git a/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md index 9ed3c3d966f5..6614203e9dd4 100644 --- a/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md +++ b/content/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage.md @@ -27,13 +27,9 @@ For example: If {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) objects are included in [source code archives](/repositories/working-with-files/using-files/downloading-source-code-archives) for your repository, downloads of those archives will count towards bandwidth usage for the repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository)." {% endif %} -{% tip %} - -**Tips**: -* {% data reusables.large_files.owner_quota_only %} -* {% data reusables.large_files.does_not_carry %} - -{% endtip %} +> [!TIP] +> * {% data reusables.large_files.owner_quota_only %} +> * {% data reusables.large_files.does_not_carry %} ## Storage quota diff --git a/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md index d59b0b05af13..d8138500730a 100644 --- a/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/collaboration-with-git-large-file-storage.md @@ -14,11 +14,8 @@ shortTitle: Collaboration --- If collaborators on your repository don't have {% data variables.large_files.product_name_short %} installed, they won't have access to the original large file. If they attempt to clone your repository, they will only fetch the pointer files, and won't have access to any of the actual data. -{% tip %} - -**Tip:** To help users without {% data variables.large_files.product_name_short %} enabled, we recommend you set guidelines for repository contributors that describe how to work with large files. For example, you may ask contributors not to modify large files, or to upload changes to a file sharing service like [Dropbox](http://www.dropbox.com/) or [Google Drive](https://drive.google.com). For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." - -{% endtip %} +> [!TIP] +> To help users without {% data variables.large_files.product_name_short %} enabled, we recommend you set guidelines for repository contributors that describe how to work with large files. For example, you may ask contributors not to modify large files, or to upload changes to a file sharing service like [Dropbox](http://www.dropbox.com/) or [Google Drive](https://drive.google.com). For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." ## Viewing large files in pull requests diff --git a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index 3e2daee9069d..270b98a9d53f 100644 --- a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md @@ -18,11 +18,8 @@ If there are existing files in your repository that you'd like to use {% data va {% ifversion ghes %} -{% tip %} - -**Note:** Before trying to push a large file to {% data variables.product.product_name %}, make sure that you've enabled {% data variables.large_files.product_name_short %} on your enterprise. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise)." - -{% endtip %} +> [!NOTE] +> Before trying to push a large file to {% data variables.product.product_name %}, make sure that you've enabled {% data variables.large_files.product_name_short %} on your enterprise. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise)." {% endif %} @@ -39,15 +36,12 @@ If there are existing files in your repository that you'd like to use {% data va Every file type you want to associate with {% data variables.large_files.product_name_short %} will need to be added with `git {% data variables.large_files.command_name %} track`. This command amends your repository's _.gitattributes_ file and associates large files with {% data variables.large_files.product_name_short %}. - {% note %} - - **Note:** We strongly suggest that you commit your local _.gitattributes_ file into your repository. - - * Relying on a global _.gitattributes_ file associated with {% data variables.large_files.product_name_short %} may cause conflicts when contributing to other Git projects. - * Including the _.gitattributes_ file in the repository allows people creating forks or fresh clones to more easily collaborate using {% data variables.large_files.product_name_short %}. - * Including the _.gitattributes_ file in the repository allows {% data variables.large_files.product_name_short %} objects to optionally be included in ZIP file and tarball archives. - - {% endnote %} + > [!NOTE] + > We strongly suggest that you commit your local _.gitattributes_ file into your repository. + > + > * Relying on a global _.gitattributes_ file associated with {% data variables.large_files.product_name_short %} may cause conflicts when contributing to other Git projects. + > * Including the _.gitattributes_ file in the repository allows people creating forks or fresh clones to more easily collaborate using {% data variables.large_files.product_name_short %}. + > * Including the _.gitattributes_ file in the repository allows {% data variables.large_files.product_name_short %} objects to optionally be included in ZIP file and tarball archives. 1. Add a file to the repository matching the extension you've associated: diff --git a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md index 38fb916c00e4..b8090223e157 100644 --- a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md @@ -28,11 +28,9 @@ shortTitle: Install Git LFS cd ~/Downloads/git-lfs-1.X.X ``` - {% note %} + > [!NOTE] + > The file path you use after `cd` depends on your operating system, Git LFS version you downloaded, and where you saved the {% data variables.large_files.product_name_short %} download. - **Note:** The file path you use after `cd` depends on your operating system, Git LFS version you downloaded, and where you saved the {% data variables.large_files.product_name_short %} download. - - {% endnote %} 1. To install the file, run this command: ```shell @@ -40,11 +38,9 @@ shortTitle: Install Git LFS > {% data variables.large_files.product_name_short %} initialized. ``` - {% note %} - - **Note:** You may have to use `sudo ./install.sh` to install the file. + > [!NOTE] + > You may have to use `sudo ./install.sh` to install the file. - {% endnote %} 1. Next, make required changes to your global Git config: ```shell @@ -60,11 +56,9 @@ shortTitle: Install Git LFS 1. Navigate to [git-lfs.com](https://git-lfs.com) and click **Download**. - {% tip %} - - **Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Windows, see this [Getting started guide](https://github.com/github/git-lfs#getting-started). + > [!TIP] + > For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Windows, see this [Getting started guide](https://github.com/github/git-lfs#getting-started). - {% endtip %} 1. On your computer, locate the downloaded file. 1. Double click on the file called _git-lfs-windows-1.X.X.exe_, where 1.X.X is replaced with the Git LFS version you downloaded. When you open this file Windows will run a setup wizard to install {% data variables.large_files.product_name_short %}. {% data reusables.command_line.open_the_multi_os_terminal %} As the setup wizard may have modified your system `PATH`, opening a new session will ensure Git can locate Git LFS. @@ -83,11 +77,9 @@ shortTitle: Install Git LFS 1. Navigate to [git-lfs.com](https://git-lfs.com) and click **Download**. - {% tip %} + > [!TIP] + > For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Linux, see this [Getting started guide](https://github.com/github/git-lfs#getting-started). - **Tip:** For more information about alternative ways to install {% data variables.large_files.product_name_short %} for Linux, see this [Getting started guide](https://github.com/github/git-lfs#getting-started). - - {% endtip %} 1. On your computer, locate and unzip the downloaded file. {% data reusables.command_line.open_the_multi_os_terminal %} 1. Change the current working directory into the folder you downloaded and unzipped. @@ -96,11 +88,9 @@ shortTitle: Install Git LFS cd ~/Downloads/git-lfs-1.X.X ``` - {% note %} - - **Note:** The file path you use after `cd` depends on your operating system, Git LFS version you downloaded, and where you saved the {% data variables.large_files.product_name_short %} download. + > [!NOTE] + > The file path you use after `cd` depends on your operating system, Git LFS version you downloaded, and where you saved the {% data variables.large_files.product_name_short %} download. - {% endnote %} 1. To install the file, run this command: ```shell @@ -108,11 +98,9 @@ shortTitle: Install Git LFS > {% data variables.large_files.product_name_short %} initialized. ``` - {% note %} - - **Note:** You may have to use `sudo ./install.sh` to install the file. + > [!NOTE] + > You may have to use `sudo ./install.sh` to install the file. - {% endnote %} 1. Next, make required changes to your global Git config: ```shell diff --git a/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md index f8006c95b6bc..28a7e7a4c3df 100644 --- a/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/moving-a-file-in-your-repository-to-git-large-file-storage.md @@ -15,11 +15,8 @@ After installing {% data variables.large_files.product_name_short %} and configu {% data reusables.large_files.resolving-upload-failures %} -{% tip %} - -**Tip:** If you get an error that "this exceeds {% data variables.large_files.product_name_short %}'s file size limit of {% data variables.large_files.max_github_size %}" when you try to push files to Git, you can use `git lfs migrate` instead of `filter-repo` or the BFG Repo Cleaner, to move the large file to {% data variables.large_files.product_name_long %}. For more information about the `git lfs migrate` command, see the [Git LFS 2.2.0](https://github.com/blog/2384-git-lfs-2-2-0-released) release announcement. - -{% endtip %} +> [!TIP] +> If you get an error that "this exceeds {% data variables.large_files.product_name_short %}'s file size limit of {% data variables.large_files.max_github_size %}" when you try to push files to Git, you can use `git lfs migrate` instead of `filter-repo` or the BFG Repo Cleaner, to move the large file to {% data variables.large_files.product_name_long %}. For more information about the `git lfs migrate` command, see the [Git LFS 2.2.0](https://github.com/blog/2384-git-lfs-2-2-0-released) release announcement. 1. Remove the file from the repository's Git history using either the `filter-repo` command or BFG Repo-Cleaner. For detailed information on using these, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." 1. Configure tracking for your file and push it to {% data variables.large_files.product_name_short %}. For more information on this procedure, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)." diff --git a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md index 1f9d8ac9f453..210a79337500 100644 --- a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md @@ -16,11 +16,9 @@ shortTitle: Remove files 1. Remove the file from the repository's Git history using either the `filter-repo` command or BFG Repo-Cleaner. For detailed information on using these, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." 1. Navigate to your _.gitattributes_ file. - {% note %} + > [!NOTE] + > Your _.gitattributes_ file is generally saved within your local repository. In some cases, you may have created a global _.gitattributes_ file that contains all of your {% data variables.large_files.product_name_short %} associations. - **Note:** Your _.gitattributes_ file is generally saved within your local repository. In some cases, you may have created a global _.gitattributes_ file that contains all of your {% data variables.large_files.product_name_short %} associations. - - {% endnote %} 1. Find and remove the associated {% data variables.large_files.product_name_short %} tracking rule within the _.gitattributes_ file. 1. Save and exit the _.gitattributes_ file. @@ -45,11 +43,8 @@ After you remove files from {% data variables.large_files.product_name_short %}, To remove {% data variables.large_files.product_name_short %} objects from a repository, {% ifversion fpt or ghec %}delete and recreate the repository. When you delete a repository, any associated issues, stars, and forks are also deleted. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/deleting-a-repository)." If you need to purge a removed object and you are unable to delete the repository, please [contact support](/support) for help.{% else %}contact your {% data variables.product.prodname_enterprise %} administrator to archive the objects. Archived objects are purged after three months.{% endif %} -{% note %} - -**Note:** If you removed a single file and have other {% data variables.large_files.product_name_short %} objects that you'd like to keep in your repository, after deleting and recreating your repository, reconfigure your {% data variables.large_files.product_name_short %}-associated files. For more information, see "[Removing a single file](#removing-a-single-file)" and "[AUTOTITLE](/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)." - -{% endnote %} +> [!NOTE] +> If you removed a single file and have other {% data variables.large_files.product_name_short %} objects that you'd like to keep in your repository, after deleting and recreating your repository, reconfigure your {% data variables.large_files.product_name_short %}-associated files. For more information, see "[Removing a single file](#removing-a-single-file)" and "[AUTOTITLE](/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)." ## Further reading diff --git a/content/repositories/working-with-files/using-files/downloading-source-code-archives.md b/content/repositories/working-with-files/using-files/downloading-source-code-archives.md index 892aad4dc0c2..2b0c670c164a 100644 --- a/content/repositories/working-with-files/using-files/downloading-source-code-archives.md +++ b/content/repositories/working-with-files/using-files/downloading-source-code-archives.md @@ -49,11 +49,8 @@ Source code archives are available at specific URLs for each repository. For exa | Tag | `codeql-cli/v2.12.0` | [https://github.com/github/codeql/archive/refs/**tags/codeql-cli/v2.12.0**.zip](https://github.com/github/codeql/archive/refs/tags/codeql-cli/v2.12.0.zip) | | Commit | `aef66c4` | [https://github.com/github/codeql/archive/**aef66c462abe817e33aad91d97aa782a1e2ad2c7**.zip](https://github.com/github/codeql/archive/aef66c462abe817e33aad91d97aa782a1e2ad2c7.zip) | -{% note %} - -**Note**: You can use either `.zip` or `.tar.gz` in the URLs above to request a zipball or tarball respectively. - -{% endnote %} +> [!NOTE] +> You can use either `.zip` or `.tar.gz` in the URLs above to request a zipball or tarball respectively. ## Stability of source code archives diff --git a/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md index ce3823e4b59b..6d76c7cbfbf9 100644 --- a/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md +++ b/content/repositories/working-with-files/using-files/getting-permanent-links-to-files.md @@ -15,11 +15,9 @@ topics: - Repositories shortTitle: Permanent links to files --- -{% tip %} -**Tip**: Press "?" on any page in {% data variables.product.product_name %} to see all available keyboard shortcuts. - -{% endtip %} +> [!TIP] +> Press "?" on any page in {% data variables.product.product_name %} to see all available keyboard shortcuts. ## File views show the latest version on a branch @@ -41,11 +39,8 @@ replaces `main` with a specific commit ID and the file content will not change. Looking up the commit SHA by hand is inconvenient, however, so as a shortcut you can type y to automatically update the URL to the permalink version. Then you can copy the URL knowing that anyone you share it with will see exactly what you saw. -{% tip %} - -**Tip**: You can put any identifier that can be resolved to a commit in the URL, including branch names, specific commit SHAs, or tags! - -{% endtip %} +> [!TIP] +> You can put any identifier that can be resolved to a commit in the URL, including branch names, specific commit SHAs, or tags! ## Creating a permanent link to a code snippet diff --git a/content/repositories/working-with-files/using-files/viewing-a-file.md b/content/repositories/working-with-files/using-files/viewing-a-file.md index d96454feda8f..d3444096d2ac 100644 --- a/content/repositories/working-with-files/using-files/viewing-a-file.md +++ b/content/repositories/working-with-files/using-files/viewing-a-file.md @@ -36,11 +36,8 @@ With the raw view, you can view or copy the raw content of a file without any st Within the blame view, you can view the line-by-line revision history for an entire file. -{% tip %} - -**Tip:** On the command line, you can also use `git blame` to view the revision history of lines within a file. For more information, see [Git's `git blame` documentation](https://git-scm.com/docs/git-blame). - -{% endtip %} +> [!TIP] +> On the command line, you can also use `git blame` to view the revision history of lines within a file. For more information, see [Git's `git blame` documentation](https://git-scm.com/docs/git-blame). {% data reusables.repositories.navigate-to-repo %} 1. Click to open the file whose line history you want to view. diff --git a/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/content/repositories/working-with-files/using-files/working-with-non-code-files.md index b51662dc539b..d865207bbadf 100644 --- a/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -38,13 +38,9 @@ shortTitle: Working with non-code files {% data variables.product.product_name %} can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats. -{% note %} - -**Note:** -* {% data variables.product.prodname_dotcom %} does not support comparing the differences between PSD files. -* If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. - -{% endnote %} +> [!NOTE] +> * {% data variables.product.prodname_dotcom %} does not support comparing the differences between PSD files. +> * If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render. ### Viewing images @@ -109,11 +105,8 @@ For example, if your model's URL is [`github.com/skalnik/secret-bear-clip/blob/m By default, the embedded renderer is 420 pixels wide by 620 pixels high, but you can customize the output by passing height and width variables as parameters at the end of the URL, such as `?height=300&width=500`. -{% tip %} - -**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). - -{% endtip %} +> [!NOTE] +> `ref` can be a branch or the hash to an individual commit (like `2391ae`). ### Rendering in Markdown @@ -256,11 +249,8 @@ For example, if your map's URL is [github.com/benbalter/dc-wifi-social/blob/mast By default, the embedded map 420px x 620px, but you can customize the output by passing height and width variables as parameters at the end, such as `?height=300&width=500`. -{% tip %} - -**Note**: `ref` can be a branch or the hash to an individual commit (like `2391ae`). - -{% endtip %} +> [!NOTE] +> `ref` can be a branch or the hash to an individual commit (like `2391ae`). ### Mapping in Markdown diff --git a/content/rest/authentication/authenticating-to-the-rest-api.md b/content/rest/authentication/authenticating-to-the-rest-api.md index eeca70aa49ce..c612631a774d 100644 --- a/content/rest/authentication/authenticating-to-the-rest-api.md +++ b/content/rest/authentication/authenticating-to-the-rest-api.md @@ -29,11 +29,8 @@ curl --request GET \ --header "X-GitHub-Api-Version: {{ allVersions[currentVersion].latestApiVersion }}" ``` -{% note %} - -**Note:** {% data reusables.getting-started.bearer-vs-token %} - -{% endnote %} +> [!NOTE] +> {% data reusables.getting-started.bearer-vs-token %} ### Failed login limit diff --git a/content/rest/checks/runs.md b/content/rest/checks/runs.md index 29182a6d60ec..8dd5e220edbc 100644 --- a/content/rest/checks/runs.md +++ b/content/rest/checks/runs.md @@ -12,10 +12,7 @@ allowTitleToDifferFromFilename: true autogenerated: rest --- -{% note %} - -**Note**: {% data reusables.apps.checks-availability %} - -{% endnote %} +> [!NOTE] +> {% data reusables.apps.checks-availability %} diff --git a/content/rest/checks/suites.md b/content/rest/checks/suites.md index 90a9b3682630..571a149aedef 100644 --- a/content/rest/checks/suites.md +++ b/content/rest/checks/suites.md @@ -12,16 +12,10 @@ allowTitleToDifferFromFilename: true autogenerated: rest --- -{% note %} +> [!NOTE] +> {% data reusables.apps.checks-availability %} -**Note**: {% data reusables.apps.checks-availability %} - -{% endnote %} - -{% note %} - - **Note:** A GitHub App usually only receives one [`check_suite`](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks-and-events/webhooks/webhook-events-and-payloads#create) events. - -{% endnote %} +> [!NOTE] +> A GitHub App usually only receives one [`check_suite`](/webhooks-and-events/webhooks/webhook-events-and-payloads#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks-and-events/webhooks/webhook-events-and-payloads#create) events. diff --git a/content/rest/codespaces/organization-secrets.md b/content/rest/codespaces/organization-secrets.md index 5411c9ced449..c4a0d875d96c 100644 --- a/content/rest/codespaces/organization-secrets.md +++ b/content/rest/codespaces/organization-secrets.md @@ -13,10 +13,7 @@ topics: autogenerated: rest --- -{% note %} - -**Note**: These endpoints are currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> These endpoints are currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/content/rest/dependabot/alerts.md b/content/rest/dependabot/alerts.md index e5e0d78d93fc..5f2be0e2968b 100644 --- a/content/rest/dependabot/alerts.md +++ b/content/rest/dependabot/alerts.md @@ -12,11 +12,8 @@ topics: autogenerated: rest --- -{% note %} - -**Note**: The ability to use the REST API to manage Dependabot alerts is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endnote %} +> [!NOTE] +> The ability to use the REST API to manage Dependabot alerts is currently in {% data variables.release-phases.public_preview %} and subject to change. ## About {% data variables.product.prodname_dependabot_alerts %} diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index d608d2e1eea4..f1ff203b803f 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -35,11 +35,8 @@ autogenerated: rest {% ifversion fpt or ghec %} -{% note %} - -**Note:** This information applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. - -{% endnote %} +> [!NOTE] +> This information applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. {% endif %} diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index 81a045dc2ed4..f98135e6e012 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -12,14 +12,11 @@ autogenerated: rest --- {% ifversion emu-public-scim-schema %} -{% note %} -**Notes**: +> [!NOTE] +> * {% data reusables.scim.ghec-open-scim-operation-differentiation %} +> * {% data reusables.scim.ghec-open-scim-test-in-isolation %} -* {% data reusables.scim.ghec-open-scim-operation-differentiation %} -* {% data reusables.scim.ghec-open-scim-test-in-isolation %} - -{% endnote %} {% endif %} ## About SCIM @@ -125,22 +122,18 @@ The SCIM integration on the IdP performs actions on behalf of an enterprise owne To authenticate API requests, the person who configures SCIM on the IdP must use a {% data variables.product.pat_v1 %} with the {% ifversion scim-enterprise-scope %}`scim:enterprise`{% else %}`admin:enterprise`{% endif %} scope, which the IdP must provide in the request's `Authorization` header. For more information about {% data variables.product.pat_v1_plural %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)". -{% note %} - -**Note:** Enterprise owners must generate and use a {% data variables.product.pat_v1 %} for authentication of requests to endpoints in this category. {% ifversion ghes %}{% data variables.product.pat_v2_caps %} and {% endif %}GitHub app callers are not supported at this time. - -{% endnote %} +> [!NOTE] +> Enterprise owners must generate and use a {% data variables.product.pat_v1 %} for authentication of requests to endpoints in this category. {% ifversion ghes %}{% data variables.product.pat_v2_caps %} and {% endif %}GitHub app callers are not supported at this time. ### Mapping of SAML and SCIM data The {% data variables.product.product_name %} instance links each user who authenticates successfully with SAML SSO to a SCIM identity. To link the identities successfully, the SAML IdP and the SCIM integration must use matching SAML `NameID` and SCIM `userName` values for each user. {% ifversion ghes %} -{% note %} -**Note:** If the {% data variables.product.product_name %} uses Entra ID as a SAML IdP, {% data variables.product.product_name %} will also check the SCIM `externalId` claim and SAML `http://schemas.microsoft.com/identity/claims/objectidentifier` claim to match users first, instead of using `NameID` and `userName`. +> [!NOTE] +> If the {% data variables.product.product_name %} uses Entra ID as a SAML IdP, {% data variables.product.product_name %} will also check the SCIM `externalId` claim and SAML `http://schemas.microsoft.com/identity/claims/objectidentifier` claim to match users first, instead of using `NameID` and `userName`. -{% endnote %} {% endif %} ### Supported SCIM user attributes diff --git a/content/rest/guides/building-a-ci-server.md b/content/rest/guides/building-a-ci-server.md index c5cb1a960ef1..20fc3a13797a 100644 --- a/content/rest/guides/building-a-ci-server.md +++ b/content/rest/guides/building-a-ci-server.md @@ -33,11 +33,10 @@ to [use it](/webhooks-and-events/webhooks/configuring-your-server-to-receive-pay applications to the internet. {% ifversion cli-webhook-forwarding %} -{% note %} -**Note:** Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/receiving-webhooks-with-the-github-cli)." +> [!NOTE] +> Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/receiving-webhooks-with-the-github-cli)." -{% endnote %} {% endif %} Note: you can download the complete source code for this project diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md index 63bdba5716b3..37ea81f6fd41 100644 --- a/content/rest/guides/delivering-deployments.md +++ b/content/rest/guides/delivering-deployments.md @@ -33,11 +33,10 @@ to [use it](/webhooks-and-events/webhooks/configuring-your-server-to-receive-pay applications to the internet. {% ifversion cli-webhook-forwarding %} -{% note %} -**Note:** Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/receiving-webhooks-with-the-github-cli)." +> [!NOTE] +> Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/receiving-webhooks-with-the-github-cli)." -{% endnote %} {% endif %} Note: you can download the complete source code for this project diff --git a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md index a52cf5ae3de9..7f0941f2d6ea 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md @@ -24,17 +24,16 @@ You must install and import `octokit` in order to use the Octokit.js library. Th ## Instantiating and authenticating -{% warning %} - -**Warning**: Treat your authentication credentials like a password. - -To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." - -{% ifversion ghec or fpt %}You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} - -If {% ifversion ghec or fpt %}these options are not possible{% else %}this is not possible{% endif %}, consider using another CLI service to store your credentials securely. - -{% endwarning %} +> [!WARNING] +> Treat your authentication credentials like a password. +> +> To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." +{% ifversion ghec or fpt %} +> +> You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." +{% endif %} +> +> If {% ifversion ghec or fpt %}these options are not possible{% else %}this is not possible{% endif %}, consider using another CLI service to store your credentials securely. ### Authenticating with a {% data variables.product.pat_generic %} diff --git a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md index 0b94fee3224b..035bc01e07fa 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md @@ -24,17 +24,16 @@ You must install and import the `octokit` gem in order to use the Octokit.rb lib ## Instantiating and authenticating -{% warning %} - -**Warning**: Treat your authentication credentials like a password. - -To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." - -{% ifversion ghec or fpt %}You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} - -If {% ifversion ghec or fpt %}these options are not possible{% else %}this is not possible{% endif %}, consider using another CLI service to store your credentials securely. - -{% endwarning %} +> [!WARNING] +> Treat your authentication credentials like a password. +> +> To keep your credentials secure, you can store your credentials as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." +{% ifversion ghec or fpt %} +> +> You can also store your credentials as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." +{% endif %} +> +> If {% ifversion ghec or fpt %}these options are not possible{% else %}this is not possible{% endif %}, consider using another CLI service to store your credentials securely. ### Authenticating with a {% data variables.product.pat_generic %} @@ -319,11 +318,8 @@ comment_url = comment_if_data_files_changed(octokit, owner, repo, pull_number) puts "A comment was added to the pull request: #{comment_url}" ``` -{% note %} - -**Note:** This is just a basic example. In practice, you may want to use error handling and conditional checks to handle various scenarios. - -{% endnote %} +> [!NOTE] +> This is just a basic example. In practice, you may want to use error handling and conditional checks to handle various scenarios. ## Next steps diff --git a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md index 00e27914f477..eb9e31cd05fc 100644 --- a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md +++ b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md @@ -39,11 +39,8 @@ the model and it opens up a ton of things you could potentially do with the API. ## Checking mergeability of pull requests -{% warning %} - -**Warning!** Please do not depend on using Git directly or [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/git/refs#get-a-reference) for updates to `merge` Git refs, because this content becomes outdated without warning. - -{% endwarning %} +> [!WARNING] +> Please do not depend on using Git directly or [`GET /repos/{owner}/{repo}/git/refs/{ref}`](/rest/git/refs#get-a-reference) for updates to `merge` Git refs, because this content becomes outdated without warning. A consuming API needs to explicitly request a pull request to create a _test_ merge commit. A _test_ merge commit is created when you view the pull request in the UI and the "Merge" button is displayed, or when you [get](/rest/pulls/pulls#get-a-pull-request), [create](/rest/pulls/pulls#create-a-pull-request), or [edit](/rest/pulls#update-a-pull-request) a pull request using the REST API. Without this request, the `merge` Git refs will fall out of date until the next time someone views the pull request. diff --git a/content/rest/migrations/source-imports.md b/content/rest/migrations/source-imports.md index 13e981e77c5f..288c978ae83f 100644 --- a/content/rest/migrations/source-imports.md +++ b/content/rest/migrations/source-imports.md @@ -14,11 +14,8 @@ autogenerated: rest ## About source imports -{% warning %} - -**Warning**: Due to very low levels of usage and available alternatives, the Source Imports API has been {% data variables.release-phases.retired %}. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - -{% endwarning %} +> [!WARNING] +> Due to very low levels of usage and available alternatives, the Source Imports API has been {% data variables.release-phases.retired %}. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). {% data variables.migrations.source_imports_intro %} A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/webhooks-and-events/webhooks/webhook-events-and-payloads#repository_import) to find out the status of the import. diff --git a/content/rest/orgs/personal-access-tokens.md b/content/rest/orgs/personal-access-tokens.md index a31e7dfc100a..8fcb13f0a08d 100644 --- a/content/rest/orgs/personal-access-tokens.md +++ b/content/rest/orgs/personal-access-tokens.md @@ -12,10 +12,7 @@ autogenerated: rest allowTitleToDifferFromFilename: true --- -{% note %} - -**Note**: {% data reusables.user-settings.pat-v2-beta %} - -{% endnote %} +> [!NOTE] +> {% data reusables.user-settings.pat-v2-beta %} diff --git a/content/rest/quickstart.md b/content/rest/quickstart.md index 8c050e124e8f..82ba2f0c14cb 100644 --- a/content/rest/quickstart.md +++ b/content/rest/quickstart.md @@ -102,19 +102,16 @@ You can use Octokit.js to interact with the {% data variables.product.prodname_d 1. Create an access token. For example, create a {% data variables.product.pat_generic %} or a {% data variables.product.prodname_github_app %} user access token. You will use this token to authenticate your request, so you should give it any scopes or permissions that are required to access that endpoint. For more information, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." - {% warning %} - - **Warning**: Treat your access token like a password. - - To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. - + > [!WARNING] + > Treat your access token like a password. + > + > To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. {%- ifversion fpt or ghec %} - - You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} - - If these options are not possible, consider using another CLI service to store your token securely. - - {% endwarning %} + > + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." + {% endif %} + > + > If these options are not possible, consider using another CLI service to store your token securely. 1. Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). 1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). @@ -259,29 +256,23 @@ If you are authenticating with a {% data variables.product.prodname_github_app % ## Using `curl` in the command line -{% note %} - -**Note:** If you want to make API requests from the command line, {% data variables.product.prodname_dotcom %} recommends that you use {% data variables.product.prodname_cli %}, which simplifies authentication and requests. For more information about getting started with the REST API using {% data variables.product.prodname_cli %}, see the {% data variables.product.prodname_cli %} version of this article. - -{% endnote %} +> [!NOTE] +> If you want to make API requests from the command line, {% data variables.product.prodname_dotcom %} recommends that you use {% data variables.product.prodname_cli %}, which simplifies authentication and requests. For more information about getting started with the REST API using {% data variables.product.prodname_cli %}, see the {% data variables.product.prodname_cli %} version of this article. 1. Install `curl` if it isn't already installed on your machine. To check if `curl` is installed, execute `curl --version` in the command line. If the output provides information about the version of `curl`, that means `curl` is installed. If you get a message similar to `command not found: curl`, you need to download and install `curl`. For more information, see [the curl project download page](https://curl.se/download.html). 1. Create an access token. For example, create a {% data variables.product.pat_generic %} or a {% data variables.product.prodname_github_app %} user access token. You will use this token to authenticate your request, so you should give it any scopes or permissions that are required to access the endpoint. For more information, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)." - {% warning %} - - **Warning**: Treat your access token like a password. - + > [!WARNING] + > Treat your access token like a password. {%- ifversion fpt or ghec %} - - To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} - - You can also use {% data variables.product.prodname_cli %} instead of `curl`. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. - - If these options are not possible, consider using another CLI service to store your token securely. - - {% endwarning %} + > + > To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." + {% endif %} + > + > You can also use {% data variables.product.prodname_cli %} instead of `curl`. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + > + > If these options are not possible, consider using another CLI service to store your token securely. 1. Use the `curl` command to make your request. Pass your token in an `Authorization` header.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} Replace `YOUR-TOKEN` with your token. @@ -292,11 +283,8 @@ If you are authenticating with a {% data variables.product.prodname_github_app % --header "Authorization: Bearer YOUR-TOKEN" ``` - {% note %} - - **Note:** {% data reusables.getting-started.bearer-vs-token %} - - {% endnote %} + > [!NOTE] + > {% data reusables.getting-started.bearer-vs-token %} ## Using `curl` commands in {% data variables.product.prodname_actions %} diff --git a/content/rest/releases/releases.md b/content/rest/releases/releases.md index 5ba3d2c151f7..bfd570700f6e 100644 --- a/content/rest/releases/releases.md +++ b/content/rest/releases/releases.md @@ -12,10 +12,7 @@ topics: autogenerated: rest --- -{% note %} - -**Note:** These endpoints replace the endpoints to manage downloads. You can retrieve the download count and browser download URL from these endpoints. - -{% endnote %} +> [!NOTE] +> These endpoints replace the endpoints to manage downloads. You can retrieve the download count and browser download URL from these endpoints. diff --git a/content/rest/scim/scim.md b/content/rest/scim/scim.md index 6410d05ee8b0..c57e28a4a3a6 100644 --- a/content/rest/scim/scim.md +++ b/content/rest/scim/scim.md @@ -22,13 +22,9 @@ autogenerated: rest These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership and are based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). IdPs should use the base URL `{% data variables.product.rest_url %}/scim/v2/organizations/{org}/` for {% data variables.product.product_name %} SCIM endpoints. -{% note %} - -**Notes:** -* These endpoints are only available for individual organizations that use {% data variables.product.prodname_ghe_cloud %} with SAML SSO enabled. For more information about SCIM, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." For more information about authorizing a token for a SAML SSO organization, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)." -* These endpoints cannot be used with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. - -{% endnote %} +> [!NOTE] +> * These endpoints are only available for individual organizations that use {% data variables.product.prodname_ghe_cloud %} with SAML SSO enabled. For more information about SCIM, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)." For more information about authorizing a token for a SAML SSO organization, see "[AUTOTITLE](/rest/overview/authenticating-to-the-rest-api)." +> * These endpoints cannot be used with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. ### Authentication @@ -50,14 +46,11 @@ Name | Type | Description `id` | `string` | Identifier generated by the GitHub SCIM endpoint. `active` | `boolean` | Used to indicate whether the identity is active (true) or should be deprovisioned (false). -{% note %} - -**Note:** These endpoints are case sensitive. For example, the first letter in the `Users` endpoint must be capitalized: - -```shell -GET /scim/v2/organizations/{org}/Users/{scim_user_id} -``` - -{% endnote %} +> [!NOTE] +> These endpoints are case sensitive. For example, the first letter in the `Users` endpoint must be capitalized: +> +> ```shell +> GET /scim/v2/organizations/{org}/Users/{scim_user_id} +> ``` diff --git a/content/rest/security-advisories/global-advisories.md b/content/rest/security-advisories/global-advisories.md index fa60574d6270..199bff509fea 100644 --- a/content/rest/security-advisories/global-advisories.md +++ b/content/rest/security-advisories/global-advisories.md @@ -14,11 +14,8 @@ allowTitleToDifferFromFilename: true {% ifversion ghes %} -{% note %} - -**Note:** To use these endpoints, an administrator must enable {% data variables.product.prodname_github_connect %} for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database#accessing-the-local-advisory-database-on-your-github-enterprise-server-instance)." - -{% endnote %} +> [!NOTE] +> To use these endpoints, an administrator must enable {% data variables.product.prodname_github_connect %} for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database#accessing-the-local-advisory-database-on-your-github-enterprise-server-instance)." {% endif %} diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index 3b90eec81b61..307bcd77e046 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -21,14 +21,11 @@ autogenerated: rest To use these endpoints, the authenticated user must be a team maintainer or an owner of the organization associated with the team. {% ifversion ghec %} -{% note %} -**Notes:** +> [!NOTE] +> * These endpoints are only available for organizations that are part of an enterprise using {% 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 your organization uses team synchronization, you can use the API to manage team synchronization. For more information, see "[AUTOTITLE](/rest/teams/team-sync)." -* These endpoints are only available for organizations that are part of an enterprise using {% 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 your organization uses team synchronization, you can use the API to manage team synchronization. For more information, see "[AUTOTITLE](/rest/teams/team-sync)." - -{% endnote %} {% endif %} diff --git a/content/rest/teams/members.md b/content/rest/teams/members.md index 034b66b471e4..265b5a0b8563 100644 --- a/content/rest/teams/members.md +++ b/content/rest/teams/members.md @@ -18,10 +18,7 @@ autogenerated: rest {% data reusables.organizations.team-api %} -{% note %} - -**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API to make changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." - -{% endnote %} +> [!NOTE] +> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API to make changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." diff --git a/content/rest/teams/team-sync.md b/content/rest/teams/team-sync.md index 1b75c539ef13..51923b0cbee3 100644 --- a/content/rest/teams/team-sync.md +++ b/content/rest/teams/team-sync.md @@ -19,10 +19,7 @@ To use these endpoints, the authenticated user must be a team maintainer or an o You can manage {% data variables.product.product_name %} team members through your IdP with team synchronization. Team synchronization must be enabled to use these endpoints. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)." -{% note %} - -**Note:** These endpoints cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.enterprise.prodname_emu_org %}, see "[AUTOTITLE](/enterprise-cloud@latest/rest/teams/external-groups)". - -{% endnote %} +> [!NOTE] +> These endpoints cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.enterprise.prodname_emu_org %}, see "[AUTOTITLE](/enterprise-cloud@latest/rest/teams/external-groups)". diff --git a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md index cedb396f28e2..8dd56452dfc7 100644 --- a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md +++ b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md @@ -17,11 +17,8 @@ shortTitle: Best practices {% ifversion ghes %} -{% note %} - -**Note**: Rate limits are only enabled for your instance if your site administrator has enabled them. Even if rate limits are disabled for your instance, you may still want to follow the best practices that are intended to help you avoid exceeding the rate limit. This can help reduce load on your servers. - -{% endnote %} +> [!NOTE] +> Rate limits are only enabled for your instance if your site administrator has enabled them. Even if rate limits are disabled for your instance, you may still want to follow the best practices that are intended to help you avoid exceeding the rate limit. This can help reduce load on your servers. {% endif %} diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index ebb41c30f551..9c8feda612cc 100644 --- a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -140,17 +140,11 @@ To authenticate your request, you will need to provide an authentication token w For an example of a request that uses an authentication token, see "[Making a request](#making-a-request)." -{% note %} +> [!NOTE] +> If you don't want to create a token, you can use {% data variables.product.prodname_cli %}. {% data variables.product.prodname_cli %} will take care of authentication for you, and help keep your account secure. For more information, see the [{% data variables.product.prodname_cli %} version of this page](/rest/guides/getting-started-with-the-rest-api?tool=cli). -**Note:** If you don't want to create a token, you can use {% data variables.product.prodname_cli %}. {% data variables.product.prodname_cli %} will take care of authentication for you, and help keep your account secure. For more information, see the [{% data variables.product.prodname_cli %} version of this page](/rest/guides/getting-started-with-the-rest-api?tool=cli). - -{% endnote %} - -{% warning %} - -**Warning:** Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)." - -{% endwarning %} +> [!WARNING] +> Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)." {% endcurl %} @@ -166,11 +160,8 @@ To authenticate your request, you will need to provide an authentication token w For an example of a request that uses an authentication token, see "[Making a request](#making-a-request)." -{% warning %} - -**Warning:** Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)." - -{% endwarning %} +> [!WARNING] +> Treat your access token the same way you would treat your passwords or other sensitive credentials. For more information, see "[AUTOTITLE](/rest/overview/keeping-your-api-credentials-secure)." {% endjavascript %} @@ -360,11 +351,8 @@ curl --request GET \ The following example uses the "[Create an issue](/rest/issues/issues#create-an-issue)" endpoint to create a new issue in {% ifversion ghes %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-NAME` with the name of the repository where you want to create a new issue, and replace `REPO-OWNER` with the name of the account that owns the repository.{% endif %} Replace `YOUR-TOKEN` with the authentication token you created in a previous step. -{% note %} - -**Note**: If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - -{% endnote %} +> [!NOTE] +> If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." ```shell copy curl \ @@ -425,11 +413,8 @@ Create an access token to authenticate your request. You can save your token and In the following example request, the HTTP method is `POST`, the path is `/repos/{owner}/{repo}/issues`, the path parameters are `owner: "{% ifversion ghes %}REPO-OWNER{% else %}octocat{% endif %}"` and `repo: "{% ifversion ghes %}REPO-NAME{% else %}Spoon-Knife{% endif %}"`, and the body parameters are `title: "Created with the REST API"` and `body: "This is a test issue created by the REST API"`.{% ifversion ghes %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} - {% note %} - - **Note**: If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - - {% endnote %} + > [!NOTE] + > If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." ```javascript copy await octokit.request("POST /repos/{owner}/{repo}/issues", { diff --git a/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md index ce031641a993..51f2bb5466ac 100644 --- a/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md +++ b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md @@ -68,11 +68,8 @@ curl -u YOUR_CLIENT_ID:YOUR_CLIENT_SECRET -I {% data variables.product.rest_url For these requests, the rate limit is 5,000 requests per hour per {% data variables.product.prodname_oauth_app %}. If the app is owned by a {% data variables.product.prodname_ghe_cloud %} organization, the rate limit is 15,000 requests per hour. -{% note %} - -**Note:** Never include your app's client secret in client-side code or in code that runs on a user device. The client secret can be used to generate OAuth access tokens for users who have authorized your app, so you should always keep the client secret secure. - -{% endnote %} +> [!NOTE] +> Never include your app's client secret in client-side code or in code that runs on a user device. The client secret can be used to generate OAuth access tokens for users who have authorized your app, so you should always keep the client secret secure. ### Primary rate limit for `GITHUB_TOKEN` in {% data variables.product.prodname_actions %} diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index 6c746a1217b6..24f8b2430cd8 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -34,16 +34,11 @@ topics: After typing a search query, you can press **Enter** to go to the full search results view, where you can see each match and a visual interface for applying filters. For more information, see "[Searching using a visual interface](#searching-using-a-visual-interface)." {% endif %} -{% note %} - -**Notes:** - -* {% data reusables.search.required_login %} -* {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}." For more information about {% data variables.product.prodname_pages %}, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages)" -* Currently our search doesn't support exact matching.{% ifversion ghes %} -* Whenever you are searching in code files, only the first two results in each file will be returned.{% endif %} - -{% endnote %} +> [!NOTE] +> * {% data reusables.search.required_login %} +> * {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}." For more information about {% data variables.product.prodname_pages %}, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages)" +> * Currently our search doesn't support exact matching.{% ifversion ghes %} +> * Whenever you are searching in code files, only the first two results in each file will be returned.{% endif %} After running a search on {% data variables.product.product_name %}, you can sort the results, or further refine them by clicking one of the languages in the sidebar. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/sorting-search-results)." diff --git a/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md b/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md index 004b972690fc..2ff2502d35bf 100644 --- a/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md +++ b/content/search-github/getting-started-with-searching-on-github/sorting-search-results.md @@ -14,11 +14,10 @@ topics: --- {% ifversion code-search-upgrade %} - {% note %} - **Note:** Sorting search results is not supported for {% data variables.product.product_name %} code search. For more information on code search, see "[AUTOTITLE](/search-github/github-code-search/about-github-code-search)." +> [!NOTE] +> Sorting search results is not supported for {% data variables.product.product_name %} code search. For more information on code search, see "[AUTOTITLE](/search-github/github-code-search/about-github-code-search)." - {% endnote %} {% endif %} Use the **Sort** dropdown menu to sort results by relevance, number of stars, number of forks, and how recently the items were updated. diff --git a/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md b/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md index 11cf98a11e13..12b65f3d0c85 100644 --- a/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md +++ b/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md @@ -16,11 +16,10 @@ shortTitle: Understand search syntax --- {% ifversion code-search-upgrade %} - {% note %} - **Note:** The syntax below applies to non-code search. For more information on code search syntax, see "[AUTOTITLE](/search-github/github-code-search/understanding-github-code-search-syntax)." +> [!NOTE] +> The syntax below applies to non-code search. For more information on code search syntax, see "[AUTOTITLE](/search-github/github-code-search/understanding-github-code-search-syntax)." - {% endnote %} {% endif %} ## Query for values greater or less than another value diff --git a/content/search-github/github-code-search/understanding-github-code-search-syntax.md b/content/search-github/github-code-search/understanding-github-code-search-syntax.md index 53532e9c1750..9c8cf017f5ed 100644 --- a/content/search-github/github-code-search/understanding-github-code-search-syntax.md +++ b/content/search-github/github-code-search/understanding-github-code-search-syntax.md @@ -120,11 +120,8 @@ To search within a set of repositories, you can combine multiple `repo:` qualifi repo:github-linguist/linguist OR repo:tree-sitter/tree-sitter ``` -{% note %} - -**Note:** Code search does not currently support regular expressions or partial matching for repository names, so you will have to type the entire repository name (including the user prefix) for the `repo:` qualifier to work. - -{% endnote %} +> [!NOTE] +> Code search does not currently support regular expressions or partial matching for repository names, so you will have to type the entire repository name (including the user prefix) for the `repo:` qualifier to work. ### Organization and user qualifiers @@ -140,11 +137,8 @@ To search for files within a personal account, use the `user:` qualifier. For ex user:octocat ``` -{% note %} - -**Note:** Code search does not currently support regular expressions or partial matching for organization or user names, so you will have to type the entire organization or user name for the qualifier to work. - -{% endnote %} +> [!NOTE] +> Code search does not currently support regular expressions or partial matching for organization or user names, so you will have to type the entire organization or user name for the qualifier to work. ### Language qualifier diff --git a/content/search-github/searching-on-github/finding-files-on-github.md b/content/search-github/searching-on-github/finding-files-on-github.md index ba2bd09c398e..7448c8835da4 100644 --- a/content/search-github/searching-on-github/finding-files-on-github.md +++ b/content/search-github/searching-on-github/finding-files-on-github.md @@ -12,14 +12,10 @@ versions: topics: - GitHub search --- -{% tip %} -**Tips:** - -* By default, file finder results exclude some directories like `build`, `log`, `tmp`, and `vendor`. To search for files in these directories, {% ifversion code-search-upgrade %}use the [`path` code search qualifier](/search-github/github-code-search/understanding-github-code-search-syntax#path-qualifier){% else %}use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename){% endif %}. Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files). -* You can also open the file finder by pressing `t` on your keyboard. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." - -{% endtip %} +> [!TIP] +> * By default, file finder results exclude some directories like `build`, `log`, `tmp`, and `vendor`. To search for files in these directories, {% ifversion code-search-upgrade %}use the [`path` code search qualifier](/search-github/github-code-search/understanding-github-code-search-syntax#path-qualifier){% else %}use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename){% endif %}. Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files). +> * You can also open the file finder by pressing `t` on your keyboard. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." ## Using the file finder diff --git a/content/search-github/searching-on-github/searching-code.md b/content/search-github/searching-on-github/searching-code.md index dcdcc5a687e9..d1e8b3a98a33 100644 --- a/content/search-github/searching-on-github/searching-code.md +++ b/content/search-github/searching-on-github/searching-code.md @@ -16,13 +16,12 @@ topics: - GitHub search --- {% ifversion code-search-upgrade %} -{% note %} -**Note:** This article covers the syntax for legacy code search, which you should only need to use for the [REST API endpoint for searching code](/rest/search/search#search-code). +> [!NOTE] +> This article covers the syntax for legacy code search, which you should only need to use for the [REST API endpoint for searching code](/rest/search/search#search-code). +> +> For information on the code search syntax that you can use on {% data variables.product.prodname_dotcom %}, see "[AUTOTITLE](/search-github/github-code-search/understanding-github-code-search-syntax)." -For information on the code search syntax that you can use on {% data variables.product.prodname_dotcom %}, see "[AUTOTITLE](/search-github/github-code-search/understanding-github-code-search-syntax)." - -{% endnote %} {% endif %} {% data reusables.search.you-can-search-globally %} For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." diff --git a/content/search-github/searching-on-github/searching-in-forks.md b/content/search-github/searching-on-github/searching-in-forks.md index 916b0b339f0b..310d9855651c 100644 --- a/content/search-github/searching-on-github/searching-in-forks.md +++ b/content/search-github/searching-on-github/searching-in-forks.md @@ -17,11 +17,8 @@ To show forks in repository search results, add `fork:true` or `fork:only` to yo {% ifversion ghes %}Forks are only indexed for code search when they have more stars than the parent repository. You will not be able to search the code in a fork that has fewer stars than its parent. To show forks with more stars than the parent repository in code search results, add `fork:true` or `fork:only` to your query. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-code)."{% endif %} -{% note %} - -**Note:** Forks can only be included in repository and code searches. - -{% endnote %} +> [!NOTE] +> Forks can only be included in repository and code searches. The `fork:true` qualifier finds all results that match your search query, including forks. The `fork:only` qualifier finds _only_ forks that match your search query. diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 49ef1029d60a..14dde9768de0 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -16,17 +16,17 @@ shortTitle: Search issues & PRs --- You can search for issues and pull requests globally across all of {% data variables.product.product_name %}, or search for issues and pull requests within a particular organization. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." -{% tip %} - -**Tips:**{% ifversion ghes %} -* This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.location.product_location %}.{% endif %} -{% ifversion issues-advanced-search %}* If your organization has opted-in to the {% data variables.release-phases.public_preview %} of advanced issue search, you can use boolean and nested queries on your repository's issues page. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests#building-advanced-filters-for-issues)."{% 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. -* Use a minus (hyphen) symbol to exclude results that match a qualifier. For example, to ignore issues created by the "octocat" user, you'd use `-author:octocat` in your search. Note that this does not work for [missing metadata qualifiers](#search-by-missing-metadata). -* {% data reusables.search.search_issues_and_pull_requests_shortcut %} - - {% endtip %} +> [!TIP] +{% ifversion ghes %} +> * This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.location.product_location %}. +{% endif %} +{% ifversion issues-advanced-search %} +> * If your organization has opted-in to the {% data variables.release-phases.public_preview %} of advanced issue search, you can use boolean and nested queries on your repository's issues page. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests#building-advanced-filters-for-issues)." +{% 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. +> * Use a minus (hyphen) symbol to exclude results that match a qualifier. For example, to ignore issues created by the "octocat" user, you'd use `-author:octocat` in your search. Note that this does not work for [missing metadata qualifiers](#search-by-missing-metadata). +> * {% data reusables.search.search_issues_and_pull_requests_shortcut %} ## Search only issues or pull requests diff --git a/content/site-policy/github-terms/github-corporate-terms-of-service.md b/content/site-policy/github-terms/github-corporate-terms-of-service.md index 0a46740e5381..f0d4f982f886 100644 --- a/content/site-policy/github-terms/github-corporate-terms-of-service.md +++ b/content/site-policy/github-terms/github-corporate-terms-of-service.md @@ -11,11 +11,8 @@ topics: --- -{% note %} - -**Note:** The GitHub Corporate Terms of Service were deprecated effective 30 November 2021, and are no longer used for new customers. The terms below apply _only_ to those GitHub customers with executed agreements that explicitly reference the Corporate Terms of Service. All other business or institution customers are directed to the GitHub Customer Agreement terms available at [github.com/customer-terms](https://github.com/customer-terms). - -{% endnote %} +> [!NOTE] +> The GitHub Corporate Terms of Service were deprecated effective 30 November 2021, and are no longer used for new customers. The terms below apply _only_ to those GitHub customers with executed agreements that explicitly reference the Corporate Terms of Service. All other business or institution customers are directed to the GitHub Customer Agreement terms available at [github.com/customer-terms](https://github.com/customer-terms). ## GitHub Corporate Terms of Service diff --git a/content/site-policy/github-terms/github-educational-use-agreement.md b/content/site-policy/github-terms/github-educational-use-agreement.md index 83cf12e6708b..8b2fde63cf0e 100644 --- a/content/site-policy/github-terms/github-educational-use-agreement.md +++ b/content/site-policy/github-terms/github-educational-use-agreement.md @@ -8,11 +8,8 @@ topics: - Education --- -{% note %} - -**Note:** The below Educational Use Agreement is related to the GitHub Campus Program Partner Schools, also found [here](https://education.github.com/schools/terms), and is considered the program terms and conditions. - -{% endnote %} +> [!NOTE] +> The below Educational Use Agreement is related to the GitHub Campus Program Partner Schools, also found [here](https://education.github.com/schools/terms), and is considered the program terms and conditions. ## EDUCATIONAL USE AGREEMENT diff --git a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md index 65b574fc8fdb..5276715ae43c 100644 --- a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md +++ b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md @@ -27,11 +27,8 @@ When you become a sponsored developer or sponsored organization, additional term ## About the {% data variables.product.prodname_matching_fund %} -{% note %} - -**Note:** {% data reusables.sponsors.matching-fund-eligible %} - -{% endnote %} +> [!NOTE] +> {% data reusables.sponsors.matching-fund-eligible %} The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}. diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md index 90dcbf6f6275..1a093d040f5d 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md @@ -42,11 +42,9 @@ shortTitle: Manage payment tiers {% data reusables.sponsors.navigate-to-sponsors-dashboard %} {% data reusables.sponsors.navigate-to-sponsor-tiers-tab %} {% data reusables.sponsors.edit-tier %} - {% note %} - **Note:** To see ideas of tier descriptions, scroll down. - - {% endnote %} + > [!NOTE] + > To see ideas of tier descriptions, scroll down. {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.tier-update %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md index 55ff18b6c77b..f9b925e18a83 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md @@ -40,12 +40,10 @@ If you are not a U.S. citizen or other U.S. person, including a resident alien i If your country of residence or billing country is India, then you can use your Permanent Account Number (PAN) as your tax identification number. -{% note %} - -**Note:** If your country does not require citizens to have a tax number issued by the government, then you can instead write "not legally required". - -Guidance from the IRS states that you should not write "not applicable." For more information, see "[Instructions for Form W-8BEN, Line 6](https://www.irs.gov/instructions/iw8ben#idm139867098922656)" on the IRS website. -{% endnote %} +> [!NOTE] +> If your country does not require citizens to have a tax number issued by the government, then you can instead write "not legally required". +> +> Guidance from the IRS states that you should not write "not applicable." For more information, see "[Instructions for Form W-8BEN, Line 6](https://www.irs.gov/instructions/iw8ben#idm139867098922656)" on the IRS website. The IRS allows non-resident and resident aliens to request an [Individual Taxpayer Identification Number](https://www.irs.gov/individuals/international-taxpayers/taxpayer-identification-numbers-tin#itin) or ITIN. It is unlikely that this is necessary for maintainers receiving income through {% data variables.product.prodname_sponsors %}, but read the full [instructions](https://www.irs.gov/pub/irs-pdf/iw8ben.pdf) to determine your individual circumstances. diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/unlinking-your-patreon-account-from-your-github-sponsors-profile.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/unlinking-your-patreon-account-from-your-github-sponsors-profile.md index b48e7e44a238..7969e55e5898 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/unlinking-your-patreon-account-from-your-github-sponsors-profile.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/unlinking-your-patreon-account-from-your-github-sponsors-profile.md @@ -11,11 +11,8 @@ topics: shortTitle: Unlink Patreon --- -{% note %} - -**Note:** Unlinking your Patreon account from your {% data variables.product.prodname_sponsors %} profile will prevent new sponsors from sponsoring you through Patreon, but it **will not** cancel existing sponsorships through Patreon. Instead, they will appear as cancelled on {% data variables.product.prodname_dotcom %} and your sponsors will have to cancel those sponsorships themselves on Patreon. For more information, see [How do I cancel?](https://support.patreon.com/hc/en-us/articles/360005502572-How-do-I-cancel-) in the Patreon documentation. - -{% endnote %} +> [!NOTE] +> Unlinking your Patreon account from your {% data variables.product.prodname_sponsors %} profile will prevent new sponsors from sponsoring you through Patreon, but it **will not** cancel existing sponsorships through Patreon. Instead, they will appear as cancelled on {% data variables.product.prodname_dotcom %} and your sponsors will have to cancel those sponsorships themselves on Patreon. For more information, see [How do I cancel?](https://support.patreon.com/hc/en-us/articles/360005502572-How-do-I-cancel-) in the Patreon documentation. ## Unlinking your Patreon account from your {% data variables.product.company_short %} account diff --git a/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md b/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md index b270ecdd440a..57a3b79b718a 100644 --- a/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md +++ b/content/sponsors/sponsoring-open-source-contributors/about-sponsorships-fees-and-taxes.md @@ -31,11 +31,8 @@ If the sponsored account retires your tier, the tier will remain in place for yo If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-personal-account)" and "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." -{% note %} - -**Note:** {% data variables.product.prodname_dotcom %} is not responsible for how developers represent themselves nor does {% data variables.product.prodname_dotcom %} endorse any sponsored open source projects. The claims are solely the responsibility of the developer receiving the funds. Make sure you trust a person before offering a sponsorship. For more information, see the [{% data variables.product.prodname_sponsors %} Additional Terms](/free-pro-team@latest/site-policy/github-terms/github-sponsors-additional-terms). - -{% endnote %} +> [!NOTE] +> {% data variables.product.prodname_dotcom %} is not responsible for how developers represent themselves nor does {% data variables.product.prodname_dotcom %} endorse any sponsored open source projects. The claims are solely the responsibility of the developer receiving the funds. Make sure you trust a person before offering a sponsorship. For more information, see the [{% data variables.product.prodname_sponsors %} Additional Terms](/free-pro-team@latest/site-policy/github-terms/github-sponsors-additional-terms). ## About billing and sponsorship payments @@ -44,19 +41,13 @@ For additional information on your preferred funding, please click on any of the * [AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github) * [AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-patreon) -{% note %} - -**Note:** When sponsoring through GitHub, your balance will be charged effective immediately. {% data reusables.sponsors.prorated-sponsorship %} - -{% endnote %} +> [!NOTE] +> When sponsoring through GitHub, your balance will be charged effective immediately. {% data reusables.sponsors.prorated-sponsorship %} Alternatively, enterprises and organizations may opt to be billed by recurring invoice. For additional information on billing by invoice, please click on [AUTOTITLE](/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice). -{% warning %} - -**Warning:** As of February 23, 2023, GitHub Sponsors does not support PayPal. While this only affects GitHub Sponsors, please note that it is still possible to fund GitHub Pro, GitHub Copilot, Actions and Packages, Storage, Codespaces and Git LFS Data using PayPal. - -{% endwarning %} +> [!WARNING] +> As of February 23, 2023, GitHub Sponsors does not support PayPal. While this only affects GitHub Sponsors, please note that it is still possible to fund GitHub Pro, GitHub Copilot, Actions and Packages, Storage, Codespaces and Git LFS Data using PayPal. {% ifversion enterprise-orgs-sponsors-with-cc %} diff --git a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md index 75bf6b3dff54..ccc7751bd434 100644 --- a/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md +++ b/content/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice.md @@ -35,11 +35,8 @@ Once the organization reaches the yearly minimum spend, they can opt out of bein If your organization currently pays for {% data variables.product.prodname_sponsors %} by credit card, you can switch to paying by invoice. Switching to paying by invoice will not affect the billing schedule for other {% data variables.product.company_short %} products like {% data variables.product.prodname_actions %} or {% data variables.product.prodname_registry %}. -{% note %} - -**Note:** Changing your payment method to invoiced billing will cancel your current sponsorships and your current sponsored projects will receive a cancellation email. You will need to set up your sponsorships again after switching to paying by invoice. You can view your recently canceled sponsorships in your past sponsorships list. Additionally, {% data variables.product.prodname_dotcom %} will email you a list of your active sponsorships prior to switching to invoiced billing. You can re-sponsor projects by importing that list into the bulk sponsorship tool. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor#sponsoring-accounts-in-bulk)." - -{% endnote %} +> [!NOTE] +> Changing your payment method to invoiced billing will cancel your current sponsorships and your current sponsored projects will receive a cancellation email. You will need to set up your sponsorships again after switching to paying by invoice. You can view your recently canceled sponsorships in your past sponsorships list. Additionally, {% data variables.product.prodname_dotcom %} will email you a list of your active sponsorships prior to switching to invoiced billing. You can re-sponsor projects by importing that list into the bulk sponsorship tool. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor#sponsoring-accounts-in-bulk)." {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} diff --git a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md index 36f30894a73f..19326757f12e 100644 --- a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md +++ b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor-through-github.md @@ -71,11 +71,8 @@ Before you can sponsor an account, you must have a verified email address. For m * {% data variables.product.prodname_dotcom %}'s template CSV file for bulk sponsorships edited to contain your desired sponsorships. To download the example CSV file, in the "Import a CSV" box, click **Download example CSV**. * A CSV file of your own creation containing your desired sponsorships. For {% data variables.product.prodname_dotcom %} to parse your CSV file correctly, the file must contain columns labeled "Maintainer username" and "Sponsorship amount in USD." - {% note %} - - **Note:** Any errors in your file are reported at the top of the review page with instructions to resolve them. - - {% endnote %} + > [!NOTE] + > Any errors in your file are reported at the top of the review page with instructions to resolve them. 1. Optionally, to resolve any errors or make any changes to your sponsorship selections, click **Choose file**, then navigate to the new or updated CSV file you would like to upload. Select the CSV file, then click **Open**. 1. To confirm your sponsorship elections, click **Continue to checkout**. diff --git a/content/sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-github.md b/content/sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-github.md index 007fddff0a95..4ba9c661b286 100644 --- a/content/sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-github.md +++ b/content/sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-github.md @@ -13,11 +13,8 @@ redirect_from: - /sponsors/sponsoring-open-source-contributors/unlinking-your-patreon-account-from-your-github-account --- -{% note %} - -**Note:** Unlinking your Patreon account from {% data variables.product.company_short %} will not cancel any existing sponsorships you have created through Patreon. They will only appear as cancelled on {% data variables.product.prodname_dotcom %}. To stop sponsoring maintainers through Patreon, see [How do I cancel?](https://support.patreon.com/hc/en-us/articles/360005502572-How-do-I-cancel-) in the Patreon documentation. - -{% endnote %} +> [!NOTE] +> Unlinking your Patreon account from {% data variables.product.company_short %} will not cancel any existing sponsorships you have created through Patreon. They will only appear as cancelled on {% data variables.product.prodname_dotcom %}. To stop sponsoring maintainers through Patreon, see [How do I cancel?](https://support.patreon.com/hc/en-us/articles/360005502572-How-do-I-cancel-) in the Patreon documentation. ## Unlinking your Patreon account from your {% data variables.product.company_short %} account diff --git a/content/support/contacting-github-support/creating-a-support-ticket.md b/content/support/contacting-github-support/creating-a-support-ticket.md index f4ba01cec5a1..33ffa5b5cc59 100644 --- a/content/support/contacting-github-support/creating-a-support-ticket.md +++ b/content/support/contacting-github-support/creating-a-support-ticket.md @@ -77,11 +77,8 @@ Especially for tickets with {% data variables.product.support_ticket_priority_ur ## Creating a support ticket{% ifversion ghes %} using the {% data variables.contact.enterprise_portal %}{% endif %} -{% note %} - -**Note:** Before you submit a ticket, you have the option of using {% data variables.product.prodname_copilot_in_support %} to receive an immediate response to your question. If {% data variables.product.prodname_copilot_in_support %} is unable to resolve your issue, you can continue submitting your ticket. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-copilot-in-github-support)." - -{% endnote %} +> [!NOTE] +> Before you submit a ticket, you have the option of using {% data variables.product.prodname_copilot_in_support %} to receive an immediate response to your question. If {% data variables.product.prodname_copilot_in_support %} is unable to resolve your issue, you can continue submitting your ticket. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-copilot-in-github-support)." 1. Navigate to the {% data variables.contact.contact_landing_page_portal %} and choose one of the following options: diff --git a/content/support/contacting-github-support/providing-data-to-github-support.md b/content/support/contacting-github-support/providing-data-to-github-support.md index 10d95f852558..e9d40e720a39 100644 --- a/content/support/contacting-github-support/providing-data-to-github-support.md +++ b/content/support/contacting-github-support/providing-data-to-github-support.md @@ -100,11 +100,8 @@ For more information, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterp Support bundles include logs from the past two days by default. You can specify an exact duration in days. To provide logs from the past eight days, you can download an extended support bundle. For more information, see "[Creating and sharing extended support bundles](#creating-and-sharing-extended-support-bundles)." -{% tip %} - -**Tip:** When you contact {% data variables.contact.github_support %}, you'll be sent a confirmation email that will contain a ticket reference link. If {% data variables.contact.github_support %} asks you to upload a support bundle, you can use the ticket reference link to upload the support bundle. - -{% endtip %} +> [!TIP] +> When you contact {% data variables.contact.github_support %}, you'll be sent a confirmation email that will contain a ticket reference link. If {% data variables.contact.github_support %} asks you to upload a support bundle, you can use the ticket reference link to upload the support bundle. ### Creating a support bundle from the {% data variables.enterprise.management_console %} diff --git a/content/support/learning-about-github-support/about-github-premium-support.md b/content/support/learning-about-github-support/about-github-premium-support.md index 09e6c31ce034..964d5251edaa 100644 --- a/content/support/learning-about-github-support/about-github-premium-support.md +++ b/content/support/learning-about-github-support/about-github-premium-support.md @@ -22,15 +22,9 @@ topics: - Support --- -{% note %} - -**Notes:** - -* The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of November 2021. - -* {% data reusables.support.data-protection-and-privacy %} - -{% endnote %} +> [!NOTE] +> * The terms of {% data variables.contact.premium_support %} are subject to change without notice and are effective as of November 2021. +> * {% data reusables.support.data-protection-and-privacy %} ## About {% data variables.contact.premium_support %} @@ -62,11 +56,8 @@ Incident management | None | For urgent priority tickets, as needed {% endrowheaders %} - {% note %} - - **Note:** Enterprise owners and billing managers automatically have a support entitlement. Enterprise owners can add support entitlements to members of organizations owned by their 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] + > Enterprise owners and billing managers automatically have a support entitlement. Enterprise owners can add support entitlements to members of organizations owned by their enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." ## Billing for {% data variables.contact.premium_support %} diff --git a/content/support/learning-about-github-support/about-github-support.md b/content/support/learning-about-github-support/about-github-support.md index a27b40d52787..b3f79f794369 100644 --- a/content/support/learning-about-github-support/about-github-support.md +++ b/content/support/learning-about-github-support/about-github-support.md @@ -130,11 +130,8 @@ For pricing, licensing, renewals, quotes, payments, and other related questions, To learn more about training options, including customized trainings, see [{% data variables.product.company_short %}'s training site](https://services.github.com/). -{% note %} - -**Note:** Training is included in the {% data variables.product.premium_plus_support_plan %}. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-premium-support)." - -{% endnote %} +> [!NOTE] +> Training is included in the {% data variables.product.premium_plus_support_plan %}. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-premium-support)." {% endif %} diff --git a/content/webhooks/about-webhooks.md b/content/webhooks/about-webhooks.md index 2d74c6630d41..5b2dc2e65767 100644 --- a/content/webhooks/about-webhooks.md +++ b/content/webhooks/about-webhooks.md @@ -59,11 +59,8 @@ If you only need information once or intermittently, or only want to get informa For information on best practices to follow when using webhooks, see "[AUTOTITLE](/webhooks/using-webhooks/best-practices-for-using-webhooks)." -{% note %} - -**Note:** GitHub Services (sometimes referred to as Service Hooks) is {% data variables.release-phases.retired %}, in favor of integrating with webhooks. For more information about migrating your integration from using GitHub Services to using webhooks, see the [blog post](https://developer.github.com/changes/2018-04-25-github-services-deprecation/). - -{% endnote %} +> [!NOTE] +> GitHub Services (sometimes referred to as Service Hooks) is {% data variables.release-phases.retired %}, in favor of integrating with webhooks. For more information about migrating your integration from using GitHub Services to using webhooks, see the [blog post](https://developer.github.com/changes/2018-04-25-github-services-deprecation/). ## Further reading diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing.md b/content/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing.md index e61815157b0b..2a103af17111 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/using-the-github-cli-to-forward-webhooks-for-testing.md @@ -19,11 +19,8 @@ When you make changes to your integration code, running the code in a local envi Webhook forwarding in the {% data variables.product.prodname_cli %} only works with repository and organization webhooks. If you want to test other types of webhooks locally, you'll need to do this manually. For more information, see "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/testing-webhooks)." -{% warning %} - -**Warning**: Webhook forwarding is only designed for use during testing and development. It is not supported for use in production environments for handling live webhooks. - -{% endwarning %} +> [!WARNING] +> Webhook forwarding is only designed for use during testing and development. It is not supported for use in production environments for handling live webhooks. ## Receiving webhooks with {% data variables.product.prodname_cli %} @@ -51,8 +48,5 @@ Webhook forwarding in the {% data variables.product.prodname_cli %} only works w Leave the command running in the background. It will receive all of the specified events for the specified repository and forward them to your webhook handler running at the specified URL. - {% note %} - - **Note**: Only one person can use webhook forwarding at a time for each repository and organization. If you try to set up webhook forwarding and someone else is already working with that organization or repository, you'll receive a `Hook already exists` error. - - {% endnote %} + > [!NOTE] + > Only one person can use webhook forwarding at a time for each repository and organization. If you try to set up webhook forwarding and someone else is already working with that organization or repository, you'll receive a `Hook already exists` error. diff --git a/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md b/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md index ea6fe9d04e9b..26a4df698dc1 100644 --- a/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md +++ b/content/webhooks/using-webhooks/best-practices-for-using-webhooks.md @@ -54,11 +54,8 @@ If your server goes down, you should redeliver missed webhooks once your server In a replay attack, a bad actor intercepts a webhook delivery and re-sends the delivery. To protect against replay attacks, you can use the `X-GitHub-Delivery` header to ensure that each delivery is unique per event. -{% note %} - -**Note**: If you request a redelivery, the `X-GitHub-Delivery` header will be the same as in the original delivery. - -{% endnote %} +> [!NOTE] +> If you request a redelivery, the `X-GitHub-Delivery` header will be the same as in the original delivery. ## Further reading diff --git a/content/webhooks/using-webhooks/creating-webhooks.md b/content/webhooks/using-webhooks/creating-webhooks.md index d04ab1934567..196a89aa4b8a 100644 --- a/content/webhooks/using-webhooks/creating-webhooks.md +++ b/content/webhooks/using-webhooks/creating-webhooks.md @@ -84,11 +84,8 @@ You can use the {% data variables.product.company_short %} web interface or the {% data reusables.webhooks.content_type_and_secret %} 1. Optionally, if your payload URL is HTTPS and you would not like {% data variables.product.prodname_ghe_server %} to verify SSL certificates when delivering payloads, under "SSL verification", select **Disable**. Read the information about SSL verification, then click **Disable, I understand my webhooks may not be secure**. - {% warning %} - - **Warning:** SSL verification helps ensure that hook payloads are delivered securely. We do not recommend disabling SSL verification. - - {% endwarning %} + > [!WARNING] + > SSL verification helps ensure that hook payloads are delivered securely. We do not recommend disabling SSL verification. 1. Under "Which events would you like to trigger this webhook?", select the types of webhooks you'd like to receive. You should only subscribe to the webhook events that you need. 1. If you chose **Let me select individual events**, select the events that will trigger the webhook.