From 37bf23ac041e4631f8597e9e86686ef1daa149fc Mon Sep 17 00:00:00 2001 From: Roniece Ricardo <33437850+RonRicardo@users.noreply.github.com> Date: Thu, 19 Dec 2024 18:22:01 -0500 Subject: [PATCH] [Quote removal] Remove quotes from data/reusables/repositories through data/reusables/webhooks (#53670) --- .../repositories/about-giving-access-to-forks.md | 2 +- .../repositories/about-push-rule-delegated-bypass.md | 2 +- .../repositories/administrators-can-disable-issues.md | 2 +- data/reusables/repositories/asking-for-review.md | 2 +- data/reusables/repositories/autolink-references.md | 2 +- data/reusables/repositories/choose-repo-visibility.md | 2 +- data/reusables/repositories/commit-signoffs.md | 2 +- data/reusables/repositories/create-pull-request.md | 2 +- data/reusables/repositories/default-issue-templates.md | 2 +- .../deleted_forks_from_private_repositories_warning.md | 2 +- data/reusables/repositories/deleting-ruleset-tip.md | 2 +- data/reusables/repositories/dependency-review.md | 2 +- data/reusables/repositories/deploy-keys-write-access.md | 2 +- data/reusables/repositories/deploy-keys.md | 2 +- data/reusables/repositories/desktop-fork.md | 2 +- data/reusables/repositories/edit-ruleset-steps.md | 2 +- data/reusables/repositories/enable-security-alerts.md | 2 +- data/reusables/repositories/forks-page.md | 2 +- .../repositories/github-reviews-security-advisories.md | 2 +- data/reusables/repositories/importing-context.md | 2 +- .../repositories/private_forks_inherit_permissions.md | 2 +- .../protected-branches-block-web-edits-uploads.md | 2 +- data/reusables/repositories/repo-rules-permissions.md | 2 +- .../repositories/rulesets-about-enforcement-statuses.md | 2 +- data/reusables/repositories/rulesets-alternative.md | 2 +- data/reusables/repositories/rulesets-bypass-step.md | 2 +- data/reusables/repositories/rulesets-commit-regex.md | 2 +- .../repositories/rulesets-create-and-insights-step.md | 2 +- data/reusables/repositories/rulesets-general-step.md | 2 +- data/reusables/repositories/rulesets-metadata-step.md | 4 ++-- data/reusables/repositories/rulesets-protections-step.md | 2 +- ...lesets-push-rules-general-info-for-related-articles.md | 2 +- .../repositories/rulesets-push-rules-path-example.md | 2 +- .../rulesets-require-code-scanning-results.md | 2 +- data/reusables/repositories/rulesets-target-branches.md | 2 +- .../repositories/rulest-workflows-intro-paragraph.md | 2 +- data/reusables/repositories/security-advisory-edit-cve.md | 2 +- data/reusables/repositories/security-advisory-edit-cwe.md | 2 +- .../repositories/security-advisory-edit-details.md | 2 +- data/reusables/repositories/security-guidelines.md | 2 +- data/reusables/repositories/sensitive-info-warning.md | 2 +- .../repositories/settings-permissions-org-policy-note.md | 2 +- data/reusables/repositories/sidebar-dependabot-alerts.md | 2 +- .../squash-and-rebase-linear-commit-history.md | 2 +- data/reusables/repositories/workflow-notifications.md | 4 ++-- data/reusables/repositories/you-can-fork.md | 2 +- data/reusables/rest-api/permission-header.md | 2 +- .../rest-api/secondary-rate-limit-rest-graphql.md | 2 +- .../saml/authenticate-with-saml-at-least-once.md | 2 +- data/reusables/saml/authentication-loop.md | 2 +- data/reusables/saml/authorized-creds-info.md | 2 +- data/reusables/saml/create-a-machine-user.md | 2 +- .../saml/current-time-earlier-than-notbefore-condition.md | 2 +- data/reusables/saml/ghes-you-must-configure-saml-sso.md | 2 +- data/reusables/saml/must-authorize-linked-identity.md | 2 +- data/reusables/saml/no-scim-for-enterprises.md | 4 ++-- data/reusables/saml/okta-edit-provisioning.md | 2 +- data/reusables/saml/outside-collaborators-exemption.md | 2 +- data/reusables/saml/saml-accounts.md | 2 +- data/reusables/saml/saml-ghes-account-revocation.md | 2 +- data/reusables/saml/saml-session-oauth.md | 2 +- data/reusables/saml/use-api-to-get-externalidentity.md | 2 +- data/reusables/saml/you-must-periodically-authenticate.md | 2 +- data/reusables/scim/emu-prerequisite-authentication.md | 2 +- data/reusables/scim/emu-scim-rate-limit.md | 2 +- data/reusables/scim/enterprise-account-scim.md | 2 +- .../scim/ghec-open-scim-operation-differentiation.md | 2 +- data/reusables/scim/ghes-beta-note.md | 4 ++-- .../scim/organization-rest-api-ghec-deployment-option.md | 2 +- ...cim-more-info-about-deprovisioning-and-reactivating.md | 2 +- data/reusables/search/date_gt_lt.md | 2 +- data/reusables/search/non-code-search-explanation.md | 2 +- data/reusables/search/requested_reviews_search.md | 2 +- data/reusables/search/requested_reviews_search_tip.md | 2 +- .../search/search_issues_and_pull_requests_shortcut.md | 2 +- data/reusables/search/syntax_tips.md | 2 +- data/reusables/secret-scanning/alert-type-links.md | 2 +- .../secret-scanning/audit-secret-scanning-events.md | 2 +- .../secret-scanning/dry-runs-enterprise-permissions.md | 2 +- .../secret-scanning/enterprise-enable-secret-scanning.md | 4 ++-- data/reusables/secret-scanning/link-to-push-protection.md | 2 +- data/reusables/secret-scanning/partner-program-link.md | 4 ++-- .../push-protection-allow-secrets-alerts.md | 2 +- .../secret-scanning/push-protection-enterprise-note.md | 2 +- .../secret-scanning/push-protection-org-notes.md | 2 +- .../push-protection-public-repos-bypass.md | 2 +- .../secret-scanning-enterprise-level-api.md | 2 +- data/reusables/secret-scanning/view-custom-pattern.md | 4 ++-- .../security-advisory/link-browsing-advisory-db.md | 2 +- .../security-advisory/private-vulnerability-api.md | 2 +- .../private-vulnerability-reporting-disabled.md | 2 +- .../private-vulnerability-reporting-enable.md | 2 +- .../reporting-a-vulnerability-non-admin.md | 4 ++-- .../security-advisory/repository-level-advisory-note.md | 2 +- .../security-researcher-cannot-create-advisory.md | 2 +- .../edit-configuration-next-step.md | 2 +- .../enable-security-features-with-gh-config.md | 2 +- .../security-configurations/managing-GHAS-licenses.md | 2 +- .../security-configurations/troubleshooting-next-step.md | 2 +- .../reusables/security-overview/enterprise-filters-tip.md | 2 +- data/reusables/security-overview/filter-and-toggle.md | 2 +- .../security-overview/filter-secret-scanning-metrics.md | 2 +- .../security-overview/information-varies-GHAS.md | 2 +- .../security-information-about-actions.md | 2 +- data/reusables/security-overview/settings-limitations.md | 2 +- data/reusables/security/note-securing-your-org.md | 2 +- data/reusables/shortdesc/authenticating_github_app.md | 2 +- data/reusables/sponsors/feedback.md | 2 +- data/reusables/sponsors/legal-additional-terms.md | 2 +- data/reusables/sponsors/manage-updates-for-orgs.md | 2 +- data/reusables/sponsors/no-fees.md | 2 +- data/reusables/sponsors/payout-choice.md | 2 +- data/reusables/sponsors/payout-info.md | 2 +- data/reusables/sponsors/sponsor-as-business.md | 2 +- data/reusables/sponsors/tier-details.md | 2 +- data/reusables/ssh/add-public-key-to-github.md | 2 +- data/reusables/ssh/apple-use-keychain.md | 2 +- data/reusables/support/ask-and-answer-forum.md | 2 +- .../support/enterprise-comment-on-support-tickets.md | 2 +- data/reusables/support/entitlements-note.md | 2 +- data/reusables/support/submit-a-ticket.md | 8 ++++---- .../support/support-ticket-translation-option.md | 2 +- data/reusables/two_fa/after-2fa-add-security-key.md | 2 +- .../two_fa/backup_options_during_2fa_enrollment.md | 2 +- data/reusables/two_fa/ghes_ntp.md | 2 +- data/reusables/two_fa/sms-warning.md | 2 +- data/reusables/two_fa/unlink-email-address.md | 2 +- .../user-settings/about-commit-email-addresses.md | 2 +- data/reusables/user-settings/context_switcher.md | 2 +- .../reusables/user-settings/enabling-fixed-width-fonts.md | 2 +- .../user-settings/link_email_with_your_account.md | 2 +- .../user-settings/no-verification-disposable-emails.md | 2 +- .../user-settings/password-authentication-deprecation.md | 2 +- data/reusables/user-settings/patv2-limitations.md | 2 +- data/reusables/user-settings/review_oauth_tokens_tip.md | 2 +- data/reusables/user-settings/sudo-mode-popup.md | 2 +- .../user-settings/verify-org-approved-email-domain.md | 2 +- data/reusables/webhooks/commit_comment_short_desc.md | 2 +- data/reusables/webhooks/content_type_and_secret.md | 2 +- data/reusables/webhooks/create_short_desc.md | 2 +- data/reusables/webhooks/delete_short_desc.md | 2 +- data/reusables/webhooks/fork_short_desc.md | 2 +- data/reusables/webhooks/gollum_short_desc.md | 2 +- data/reusables/webhooks/issue_comment_short_desc.md | 2 +- data/reusables/webhooks/issues_short_desc.md | 2 +- data/reusables/webhooks/member_short_desc.md | 2 +- .../webhooks/pull_request_review_comment_short_desc.md | 2 +- data/reusables/webhooks/pull_request_review_short_desc.md | 2 +- data/reusables/webhooks/pull_request_short_desc.md | 2 +- data/reusables/webhooks/release_short_desc.md | 2 +- data/reusables/webhooks/secret.md | 2 +- data/reusables/webhooks/signature-troubleshooting.md | 4 ++-- data/reusables/webhooks/sponsorship_short_desc.md | 2 +- data/reusables/webhooks/watch_short_desc.md | 2 +- .../webhooks/webhooks-as-audit-log-alternative.md | 2 +- 155 files changed, 167 insertions(+), 167 deletions(-) diff --git a/data/reusables/repositories/about-giving-access-to-forks.md b/data/reusables/repositories/about-giving-access-to-forks.md index 7ecc353bd7be..5c8fbd1318fc 100644 --- a/data/reusables/repositories/about-giving-access-to-forks.md +++ b/data/reusables/repositories/about-giving-access-to-forks.md @@ -1 +1 @@ -If you fork a public repository to your personal account, make changes, then open a pull request to propose your changes to the upstream repository, you can give anyone with push access to the upstream repository permission to push changes to your pull request branch (including deleting the branch). This speeds up collaboration by allowing repository maintainers to make commits or run tests locally to your pull request branch from a user-owned fork before merging. You cannot give push permissions to a fork owned by an organization. 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)." +If you fork a public repository to your personal account, make changes, then open a pull request to propose your changes to the upstream repository, you can give anyone with push access to the upstream repository permission to push changes to your pull request branch (including deleting the branch). This speeds up collaboration by allowing repository maintainers to make commits or run tests locally to your pull request branch from a user-owned fork before merging. You cannot give push permissions to a fork owned by an organization. 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). diff --git a/data/reusables/repositories/about-push-rule-delegated-bypass.md b/data/reusables/repositories/about-push-rule-delegated-bypass.md index b71d974f9c3b..f92756a2f2b4 100644 --- a/data/reusables/repositories/about-push-rule-delegated-bypass.md +++ b/data/reusables/repositories/about-push-rule-delegated-bypass.md @@ -6,4 +6,4 @@ Delegated bypass for push rulesets lets you control who can bypass push protecti If the request to bypass push rules is approved, the contributor can push the commit containing restricted content. If the request is denied, the contributor must remove the content from the commit (or commits) containing the restricted content before pushing again. -To configure delegated bypass, organization owners or repository administrators first create a "bypass list". The bypass list includes specific roles and teams, such as team or repository administrators, who oversee requests to bypass push protection. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." +To configure delegated bypass, organization owners or repository administrators first create a "bypass list". The bypass list includes specific roles and teams, such as team or repository administrators, who oversee requests to bypass push protection. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization) and [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets). diff --git a/data/reusables/repositories/administrators-can-disable-issues.md b/data/reusables/repositories/administrators-can-disable-issues.md index 7be9aceebca5..93c015a5ea03 100644 --- a/data/reusables/repositories/administrators-can-disable-issues.md +++ b/data/reusables/repositories/administrators-can-disable-issues.md @@ -1 +1 @@ -Repository administrators can disable issues for a repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues)." +Repository administrators can disable issues for a repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-issues). diff --git a/data/reusables/repositories/asking-for-review.md b/data/reusables/repositories/asking-for-review.md index b12b30b3fedb..5a5857da4ff1 100644 --- a/data/reusables/repositories/asking-for-review.md +++ b/data/reusables/repositories/asking-for-review.md @@ -1,2 +1,2 @@ > [!TIP] -> After you create a pull request, you can ask a specific person to [review your proposed changes](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request). For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." +> After you create a pull request, you can ask a specific person to [review your proposed changes](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request). For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review). diff --git a/data/reusables/repositories/autolink-references.md b/data/reusables/repositories/autolink-references.md index d431bdaab528..cd931c1cb2d9 100644 --- a/data/reusables/repositories/autolink-references.md +++ b/data/reusables/repositories/autolink-references.md @@ -1 +1 @@ -If custom autolink references are configured for a repository, then references to external resources, like a JIRA issue or Zendesk ticket, convert into shortened links. To know which autolinks are available in your repository, contact someone with admin permissions to the repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources)." +If custom autolink references are configured for a repository, then references to external resources, like a JIRA issue or Zendesk ticket, convert into shortened links. To know which autolinks are available in your repository, contact someone with admin permissions to the repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources). diff --git a/data/reusables/repositories/choose-repo-visibility.md b/data/reusables/repositories/choose-repo-visibility.md index 0193ddbab010..a64a06febfe6 100644 --- a/data/reusables/repositories/choose-repo-visibility.md +++ b/data/reusables/repositories/choose-repo-visibility.md @@ -1 +1 @@ -1. Choose a repository visibility. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)." +1. Choose a repository visibility. For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility). diff --git a/data/reusables/repositories/commit-signoffs.md b/data/reusables/repositories/commit-signoffs.md index 1a6634d17e00..4c2cc5ead30b 100644 --- a/data/reusables/repositories/commit-signoffs.md +++ b/data/reusables/repositories/commit-signoffs.md @@ -6,4 +6,4 @@ You can determine whether a repository you are contributing to has compulsory co Before signing off on a commit, you should ensure that your commit is in compliance with the rules and licensing governing the repository you're committing to. The repository may use a sign off agreement, such as the Developer Certificate of Origin from the Linux Foundation. For more information, see the [Developer Certificate of Origin](https://developercertificate.org/). -Signing off on a commit differs from signing a commit. For more information about signing a commit, see "[AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification)." +Signing off on a commit differs from signing a commit. For more information about signing a commit, see [AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification). diff --git a/data/reusables/repositories/create-pull-request.md b/data/reusables/repositories/create-pull-request.md index ca33d46b5c42..34cd5b305991 100644 --- a/data/reusables/repositories/create-pull-request.md +++ b/data/reusables/repositories/create-pull-request.md @@ -1,2 +1,2 @@ 1. To create a pull request that is ready for review, click **Create Pull Request**. -To create a draft pull request, use the drop-down and select **Create Draft Pull Request**, then click **Draft Pull Request**. If you are the member of an organization, you may need to request access to draft pull requests from an organization owner. See "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests)." +To create a draft pull request, use the drop-down and select **Create Draft Pull Request**, then click **Draft Pull Request**. If you are the member of an organization, you may need to request access to draft pull requests from an organization owner. See [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests). diff --git a/data/reusables/repositories/default-issue-templates.md b/data/reusables/repositories/default-issue-templates.md index a703881264c4..637d8b6f7925 100644 --- a/data/reusables/repositories/default-issue-templates.md +++ b/data/reusables/repositories/default-issue-templates.md @@ -1 +1 @@ -You can create default issue templates and a default configuration file for issue templates 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)." +You can create default issue templates and a default configuration file for issue templates 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/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 77f341224306..3844be1e3bde 100644 --- a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -2,4 +2,4 @@ > * If you remove a person’s access to a private repository, any of their forks of that private repository are deleted. Local clones of the private repository are retained. If a team's access to a private repository is revoked or a team with access to a private repository is deleted, and team members do not have access to the repository through another team, private forks of the repository will be deleted.{% ifversion ghes %} > * When [LDAP Sync is enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} > * You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -> * People with admin permissions to a private{% ifversion ghes or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghec %} or internal{% endif %} repository in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." +> * People with admin permissions to a private{% ifversion ghes or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghec %} or internal{% endif %} repository in an organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization) and [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository). diff --git a/data/reusables/repositories/deleting-ruleset-tip.md b/data/reusables/repositories/deleting-ruleset-tip.md index 13ebacaca96e..90c034effbc8 100644 --- a/data/reusables/repositories/deleting-ruleset-tip.md +++ b/data/reusables/repositories/deleting-ruleset-tip.md @@ -1,2 +1,2 @@ > [!TIP] -> If you want to temporarily disable a ruleset but do not want to delete it, you can set the ruleset's status to "Disabled." For more information, see "[Editing a ruleset](#editing-a-ruleset)." +> If you want to temporarily disable a ruleset but do not want to delete it, you can set the ruleset's status to "Disabled." For more information, see [Editing a ruleset](#editing-a-ruleset). diff --git a/data/reusables/repositories/dependency-review.md b/data/reusables/repositories/dependency-review.md index 7757225ed4ba..4a63b03bb65e 100644 --- a/data/reusables/repositories/dependency-review.md +++ b/data/reusables/repositories/dependency-review.md @@ -1 +1 @@ -Additionally, {% data variables.product.prodname_dotcom %} can review any dependencies added, updated, or removed in a pull request made against the default branch of a repository, and flag any changes that would reduce the security of your project. This allows you to spot and deal with vulnerable dependencies before, rather than after, they reach your codebase. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)." +Additionally, {% data variables.product.prodname_dotcom %} can review any dependencies added, updated, or removed in a pull request made against the default branch of a repository, and flag any changes that would reduce the security of your project. This allows you to spot and deal with vulnerable dependencies before, rather than after, they reach your codebase. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request). diff --git a/data/reusables/repositories/deploy-keys-write-access.md b/data/reusables/repositories/deploy-keys-write-access.md index dcc98fd95bfb..93097c1041f7 100644 --- a/data/reusables/repositories/deploy-keys-write-access.md +++ b/data/reusables/repositories/deploy-keys-write-access.md @@ -1 +1 @@ -Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)" and "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)." +Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization) and [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository). diff --git a/data/reusables/repositories/deploy-keys.md b/data/reusables/repositories/deploy-keys.md index 41aad645dd70..8ef13d894345 100644 --- a/data/reusables/repositories/deploy-keys.md +++ b/data/reusables/repositories/deploy-keys.md @@ -1 +1 @@ -You can launch projects from a repository on {% data variables.location.product_location %} to your server by using a deploy key, which is an SSH key that grants access to a single repository. {% data variables.product.product_name %} attaches the public part of the key directly to your repository instead of a personal account, and the private part of the key remains on your server. For more information, see "[AUTOTITLE](/rest/guides/delivering-deployments)." +You can launch projects from a repository on {% data variables.location.product_location %} to your server by using a deploy key, which is an SSH key that grants access to a single repository. {% data variables.product.product_name %} attaches the public part of the key directly to your repository instead of a personal account, and the private part of the key remains on your server. For more information, see [AUTOTITLE](/rest/guides/delivering-deployments). diff --git a/data/reusables/repositories/desktop-fork.md b/data/reusables/repositories/desktop-fork.md index 1be579e8567a..c97d0193e404 100644 --- a/data/reusables/repositories/desktop-fork.md +++ b/data/reusables/repositories/desktop-fork.md @@ -1 +1 @@ -You can use {% data variables.product.prodname_desktop %} to fork a repository. For more information, see "[AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop)." +You can use {% data variables.product.prodname_desktop %} to fork a repository. For more information, see [AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop). diff --git a/data/reusables/repositories/edit-ruleset-steps.md b/data/reusables/repositories/edit-ruleset-steps.md index 07f7c58e586c..deb5061c0e6a 100644 --- a/data/reusables/repositories/edit-ruleset-steps.md +++ b/data/reusables/repositories/edit-ruleset-steps.md @@ -1,3 +1,3 @@ 1. On the "Rulesets" page, click the name of the ruleset you want to edit. -1. Change the ruleset as required. For information on the available rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets)." +1. Change the ruleset as required. For information on the available rules, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets). 1. At the bottom of the page, click **Save changes**. diff --git a/data/reusables/repositories/enable-security-alerts.md b/data/reusables/repositories/enable-security-alerts.md index 61b386aa3d0b..5dc3d2fccc00 100644 --- a/data/reusables/repositories/enable-security-alerts.md +++ b/data/reusables/repositories/enable-security-alerts.md @@ -1,3 +1,3 @@ {% ifversion ghes %} -Enterprise owners must enable {% data variables.product.prodname_dependabot_alerts %} for {% data variables.location.product_location %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +Enterprise owners must enable {% data variables.product.prodname_dependabot_alerts %} for {% data variables.location.product_location %} before you can use this feature. For more information, see [AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise). {% endif %} diff --git a/data/reusables/repositories/forks-page.md b/data/reusables/repositories/forks-page.md index 34f99af82629..3e8a852358a7 100644 --- a/data/reusables/repositories/forks-page.md +++ b/data/reusables/repositories/forks-page.md @@ -1 +1 @@ -{% ifversion repositories-forks-page-improvement %}You can view, sort, and filter the forks of a repository on the repository's forks page. For more information, see "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories#listing-the-forks-of-a-repository)."{% endif %} +{% ifversion repositories-forks-page-improvement %}You can view, sort, and filter the forks of a repository on the repository's forks page. For more information, see [AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories#listing-the-forks-of-a-repository).{% endif %} diff --git a/data/reusables/repositories/github-reviews-security-advisories.md b/data/reusables/repositories/github-reviews-security-advisories.md index aaef4327cac5..f8e34eda7ebc 100644 --- a/data/reusables/repositories/github-reviews-security-advisories.md +++ b/data/reusables/repositories/github-reviews-security-advisories.md @@ -1,3 +1,3 @@ {% data variables.product.prodname_dotcom %} will review each published security advisory, add it to the {% data variables.product.prodname_advisory_database %}, and may use the security advisory to send {% data variables.product.prodname_dependabot_alerts %} to affected repositories. If the security advisory comes from a fork, we'll only send an alert if the fork owns a package, published under a unique name, on a public package registry. This process can take up to 72 hours and {% data variables.product.prodname_dotcom %} may contact you for more information. -For more information about {% data variables.product.prodname_dependabot_alerts %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts#dependabot-alerts-for-vulnerable-dependencies)" and "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-dependabot-security-updates)." For more information about {% data variables.product.prodname_advisory_database %}, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database)." +For more information about {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts#dependabot-alerts-for-vulnerable-dependencies) and [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-dependabot-security-updates). For more information about {% data variables.product.prodname_advisory_database %}, see [AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database). diff --git a/data/reusables/repositories/importing-context.md b/data/reusables/repositories/importing-context.md index ffa234532e2a..6391b6407132 100644 --- a/data/reusables/repositories/importing-context.md +++ b/data/reusables/repositories/importing-context.md @@ -1 +1 @@ -Importing your source code to {% data variables.product.prodname_dotcom %} makes it easier for you and others to work together on projects and manage code. {% data variables.product.prodname_dotcom %} helps you collaborate, track changes, and organize tasks, making it simpler to build and manage projects. For more information, see "[AUTOTITLE](/get-started/start-your-journey/about-github-and-git)." +Importing your source code to {% data variables.product.prodname_dotcom %} makes it easier for you and others to work together on projects and manage code. {% data variables.product.prodname_dotcom %} helps you collaborate, track changes, and organize tasks, making it simpler to build and manage projects. For more information, see [AUTOTITLE](/get-started/start-your-journey/about-github-and-git). diff --git a/data/reusables/repositories/private_forks_inherit_permissions.md b/data/reusables/repositories/private_forks_inherit_permissions.md index b901a5a5b160..5a7765f3a792 100644 --- a/data/reusables/repositories/private_forks_inherit_permissions.md +++ b/data/reusables/repositories/private_forks_inherit_permissions.md @@ -1,4 +1,4 @@ Private forks inherit the permissions structure of the upstream repository. This helps owners of private repositories maintain control over their code. For example, if the upstream repository is private and gives read/write access to a team, then the same team will have read/write access to any forks of the private upstream repository. Only team permissions (not individual permissions) are inherited by private forks. > [!NOTE] -> {% data reusables.repositories.org-base-permissions-private-forks %} For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization#about-base-permissions-for-an-organization)." +> {% data reusables.repositories.org-base-permissions-private-forks %} For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization#about-base-permissions-for-an-organization). diff --git a/data/reusables/repositories/protected-branches-block-web-edits-uploads.md b/data/reusables/repositories/protected-branches-block-web-edits-uploads.md index cd35687abaca..cab9e8197188 100644 --- a/data/reusables/repositories/protected-branches-block-web-edits-uploads.md +++ b/data/reusables/repositories/protected-branches-block-web-edits-uploads.md @@ -1 +1 @@ -If a repository has any protected branches, you can't edit or upload files in the protected branch using {% data variables.product.prodname_dotcom %}. You can use {% data variables.product.prodname_desktop %} to move your changes to a new branch and commit them. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)" and "[AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop)." +If a repository has any protected branches, you can't edit or upload files in the protected branch using {% data variables.product.prodname_dotcom %}. You can use {% data variables.product.prodname_desktop %} to move your changes to a new branch and commit them. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) and [AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop). diff --git a/data/reusables/repositories/repo-rules-permissions.md b/data/reusables/repositories/repo-rules-permissions.md index 0f6c50f17300..d2dc53482c82 100644 --- a/data/reusables/repositories/repo-rules-permissions.md +++ b/data/reusables/repositories/repo-rules-permissions.md @@ -1 +1 @@ -Anyone with read access to a repository can view the repository's rulesets. People with admin access to a repository{% ifversion edit-repository-rules %}, or a custom role with the "edit repository rules" permission,{% endif %} can create, edit, and delete rulesets for a repository{% ifversion fpt %}.{% else %} and view ruleset insights. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles)."{% endif %} +Anyone with read access to a repository can view the repository's rulesets. People with admin access to a repository{% ifversion edit-repository-rules %}, or a custom role with the "edit repository rules" permission,{% endif %} can create, edit, and delete rulesets for a repository{% ifversion fpt %}.{% else %} and view ruleset insights. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles).{% endif %} diff --git a/data/reusables/repositories/rulesets-about-enforcement-statuses.md b/data/reusables/repositories/rulesets-about-enforcement-statuses.md index 32ef826e835f..b8f8f17e558a 100644 --- a/data/reusables/repositories/rulesets-about-enforcement-statuses.md +++ b/data/reusables/repositories/rulesets-about-enforcement-statuses.md @@ -8,6 +8,6 @@ You can select any of the following enforcement statuses for your ruleset. {% ifversion repo-rules-enterprise %} -Using "Evaluate" mode is a great option for testing your ruleset without enforcing it. You can use the "Rule Insights" page to see if the contribution would have violated the rule. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." +Using "Evaluate" mode is a great option for testing your ruleset without enforcing it. You can use the "Rule Insights" page to see if the contribution would have violated the rule. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets). {% endif %} diff --git a/data/reusables/repositories/rulesets-alternative.md b/data/reusables/repositories/rulesets-alternative.md index 0721248105b2..df8fc237a49a 100644 --- a/data/reusables/repositories/rulesets-alternative.md +++ b/data/reusables/repositories/rulesets-alternative.md @@ -1 +1 @@ -As an alternative to branch protection rules{% ifversion ghes < 3.16 %} or tag protection rules{% endif %}, you can create rulesets. Rulesets have a few advantages over branch{% ifversion ghes < 3.16 %} and tag{% endif %} protection rules, such as statuses, and better discoverability without requiring admin access. You can also apply multiple rulesets at the same time. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." +As an alternative to branch protection rules{% ifversion ghes < 3.16 %} or tag protection rules{% endif %}, you can create rulesets. Rulesets have a few advantages over branch{% ifversion ghes < 3.16 %} and tag{% endif %} protection rules, such as statuses, and better discoverability without requiring admin access. You can also apply multiple rulesets at the same time. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets). diff --git a/data/reusables/repositories/rulesets-bypass-step.md b/data/reusables/repositories/rulesets-bypass-step.md index e92e6c3da36f..158b97c2430e 100644 --- a/data/reusables/repositories/rulesets-bypass-step.md +++ b/data/reusables/repositories/rulesets-bypass-step.md @@ -7,7 +7,7 @@ You can grant certain roles, teams, or apps bypass permissions {% ifversion push * Deploy keys {%- endif %} * {% data variables.product.prodname_github_apps %}{% ifversion repo-rules-dependabot-bypass %} -* {% data variables.product.prodname_dependabot %}. For more information about {% data variables.product.prodname_dependabot %}, see "[AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide)."{% endif %} +* {% data variables.product.prodname_dependabot %}. For more information about {% data variables.product.prodname_dependabot %}, see [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide).{% endif %} 1. To grant bypass permissions for the ruleset, in the "Bypass list" section, click **{% octicon "plus" aria-hidden="true" %} Add bypass**. 1. In the "Add bypass" modal dialog that appears, search for the role, team, or app you would like to grant bypass permissions, then select the role, team, or app from the "Suggestions" section and click **Add Selected**. diff --git a/data/reusables/repositories/rulesets-commit-regex.md b/data/reusables/repositories/rulesets-commit-regex.md index 9f0a4e57f554..8c0d3a2b5267 100644 --- a/data/reusables/repositories/rulesets-commit-regex.md +++ b/data/reusables/repositories/rulesets-commit-regex.md @@ -9,7 +9,7 @@ By default, regular expressions in metadata restrictions do not consider multipl The negative lookahead assertion, denoted `?!`, is not supported. However, for cases where you need to look for a given string that is not followed by another given string, you can use the positive lookahead assertion, denoted `?`, combined with the "Must not match a given regex pattern" requirement. > [!NOTE] -> If you require contributors to sign off on commits, this may interfere with your regular expression patterns. When someone signs off, {% data variables.product.prodname_dotcom %} adds a string like `Signed-off-by: #AUTHOR-NAME <#AUTHOR-EMAIL>` to the commit message. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)." +> If you require contributors to sign off on commits, this may interfere with your regular expression patterns. When someone signs off, {% data variables.product.prodname_dotcom %} adds a string like `Signed-off-by: #AUTHOR-NAME <#AUTHOR-EMAIL>` to the commit message. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization). #### Useful regular expression patterns diff --git a/data/reusables/repositories/rulesets-create-and-insights-step.md b/data/reusables/repositories/rulesets-create-and-insights-step.md index a00fd1f7fbfb..4da7a0887a30 100644 --- a/data/reusables/repositories/rulesets-create-and-insights-step.md +++ b/data/reusables/repositories/rulesets-create-and-insights-step.md @@ -1,5 +1,5 @@ To finish creating your ruleset, click **Create**. If the enforcement status of the ruleset is set to "Active", the ruleset takes effect immediately. {% ifversion repo-rules-enterprise %} -You can view insights for the ruleset to see how the rules are affecting your contributors. If the enforcement status is set to "Evaluate", you can see which actions would have passed or failed if the ruleset was active. For more information on insights for rulesets, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." +You can view insights for the ruleset to see how the rules are affecting your contributors. If the enforcement status is set to "Evaluate", you can see which actions would have passed or failed if the ruleset was active. For more information on insights for rulesets, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets). {% endif %} diff --git a/data/reusables/repositories/rulesets-general-step.md b/data/reusables/repositories/rulesets-general-step.md index 2414ee9ac6df..260ee2742f99 100644 --- a/data/reusables/repositories/rulesets-general-step.md +++ b/data/reusables/repositories/rulesets-general-step.md @@ -1,2 +1,2 @@ 1. Under "Ruleset name," type a name for the ruleset. -1. Optionally, to change the default enforcement status, click **{% octicon "skip" aria-hidden="true" %} Disabled** {% octicon "triangle-down" aria-hidden="true" %} and select an enforcement status. For more information about enforcement statuses, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#using-ruleset-enforcement-statuses)." +1. Optionally, to change the default enforcement status, click **{% octicon "skip" aria-hidden="true" %} Disabled** {% octicon "triangle-down" aria-hidden="true" %} and select an enforcement status. For more information about enforcement statuses, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#using-ruleset-enforcement-statuses). diff --git a/data/reusables/repositories/rulesets-metadata-step.md b/data/reusables/repositories/rulesets-metadata-step.md index 35971d10f0fe..939a9eee09e6 100644 --- a/data/reusables/repositories/rulesets-metadata-step.md +++ b/data/reusables/repositories/rulesets-metadata-step.md @@ -9,8 +9,8 @@ Your metadata restrictions should be intended to increase consistency between co For most requirements, such as "Must start with a matching pattern," the pattern you enter is interpreted literally, and wildcards are not supported. For example, the `*` character only represents the literal `*` character. - For more complex patterns, you can select "Must match a given regex pattern" or "Must not match a given regex pattern," then use regular expression syntax to define the matching pattern. For more information, see "[About regular expressions for commit metadata](/enterprise-cloud@latest/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization#using-regular-expressions-for-commit-metadata){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} + For more complex patterns, you can select "Must match a given regex pattern" or "Must not match a given regex pattern," then use regular expression syntax to define the matching pattern. For more information, see [About regular expressions for commit metadata](/enterprise-cloud@latest/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization#using-regular-expressions-for-commit-metadata){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} Anyone who views the rulesets for a repository will be able to see the description you provide. -1. Optionally, before enacting your ruleset with metadata restrictions, select the "Evaluate" enforcement status for your ruleset to test the effects of any metadata restrictions without impacting contributors. For more information on metadata restrictions, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#important-considerations-for-metadata-restrictions)." +1. Optionally, before enacting your ruleset with metadata restrictions, select the "Evaluate" enforcement status for your ruleset to test the effects of any metadata restrictions without impacting contributors. For more information on metadata restrictions, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#important-considerations-for-metadata-restrictions). diff --git a/data/reusables/repositories/rulesets-protections-step.md b/data/reusables/repositories/rulesets-protections-step.md index ec6512cbfb8c..281b48b55197 100644 --- a/data/reusables/repositories/rulesets-protections-step.md +++ b/data/reusables/repositories/rulesets-protections-step.md @@ -1,4 +1,4 @@ -In the "Branch protections" or "Tag protections" section, select the rules you want to include in the ruleset. When you select a rule, you may be able to enter additional settings for the rule. For more information on the rules, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets)." +In the "Branch protections" or "Tag protections" section, select the rules you want to include in the ruleset. When you select a rule, you may be able to enter additional settings for the rule. For more information on the rules, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets). > [!NOTE] > If you select **Require status checks before merging**, in the "Additional settings" section: diff --git a/data/reusables/repositories/rulesets-push-rules-general-info-for-related-articles.md b/data/reusables/repositories/rulesets-push-rules-general-info-for-related-articles.md index 6683e290ac3b..6ffb9ded8965 100644 --- a/data/reusables/repositories/rulesets-push-rules-general-info-for-related-articles.md +++ b/data/reusables/repositories/rulesets-push-rules-general-info-for-related-articles.md @@ -1 +1 @@ -Your repository may have push rulesets enabled. Push rulesets may block creating a new file in the repository based on certain restrictions. Push rulesets apply to the repository's entire fork network. Which means that any push rulesets that are configured in the root repository will also apply to every fork of the repository. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#about-rulesets)." +Your repository may have push rulesets enabled. Push rulesets may block creating a new file in the repository based on certain restrictions. Push rulesets apply to the repository's entire fork network. Which means that any push rulesets that are configured in the root repository will also apply to every fork of the repository. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#about-rulesets). diff --git a/data/reusables/repositories/rulesets-push-rules-path-example.md b/data/reusables/repositories/rulesets-push-rules-path-example.md index 1de03c3ccf52..9de89c655692 100644 --- a/data/reusables/repositories/rulesets-push-rules-path-example.md +++ b/data/reusables/repositories/rulesets-push-rules-path-example.md @@ -1 +1 @@ -You can use `fnmatch` syntax for this. For example, a restriction targeting `test/demo/**/*` prevents any pushes to files or folders in the `test/demo/` directory. A restriction targeting `test/docs/pushrules.md` prevents pushes specifically to the `pushrules.md` file in the `test/docs/` directory. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#using-fnmatch-syntax)." +You can use `fnmatch` syntax for this. For example, a restriction targeting `test/demo/**/*` prevents any pushes to files or folders in the `test/demo/` directory. A restriction targeting `test/docs/pushrules.md` prevents pushes specifically to the `pushrules.md` file in the `test/docs/` directory. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#using-fnmatch-syntax). diff --git a/data/reusables/repositories/rulesets-require-code-scanning-results.md b/data/reusables/repositories/rulesets-require-code-scanning-results.md index 83df1a2353e4..041aed307bae 100644 --- a/data/reusables/repositories/rulesets-require-code-scanning-results.md +++ b/data/reusables/repositories/rulesets-require-code-scanning-results.md @@ -6,4 +6,4 @@ ![Screenshot of the "Required tools and alert thresholds" section of "Rulesets" settings.](/assets/images/help/repository/rulesets-require-code-scanning.png) -For more information about alert severity and security severity levels, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." +For more information about alert severity and security severity levels, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels). diff --git a/data/reusables/repositories/rulesets-target-branches.md b/data/reusables/repositories/rulesets-target-branches.md index 60ac2411db07..cf3cd5af7899 100644 --- a/data/reusables/repositories/rulesets-target-branches.md +++ b/data/reusables/repositories/rulesets-target-branches.md @@ -1,3 +1,3 @@ -To target branches or tags, in the "Target branches" or "Target tags" section, select **Add a target**, then select how you want to include or exclude branches or tags. You can use `fnmatch` syntax to include or exclude branches or tags based on a pattern. For more information, see "[Using `fnmatch` syntax](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#using-fnmatch-syntax)." +To target branches or tags, in the "Target branches" or "Target tags" section, select **Add a target**, then select how you want to include or exclude branches or tags. You can use `fnmatch` syntax to include or exclude branches or tags based on a pattern. For more information, see [Using `fnmatch` syntax](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#using-fnmatch-syntax). You can add multiple targeting criteria to the same ruleset. For example, you could include the default branch, include any branches matching the pattern `*feature*`, and then specifically exclude a branch matching the pattern `not-a-feature`. diff --git a/data/reusables/repositories/rulest-workflows-intro-paragraph.md b/data/reusables/repositories/rulest-workflows-intro-paragraph.md index 9d97184b4900..a45e81152095 100644 --- a/data/reusables/repositories/rulest-workflows-intro-paragraph.md +++ b/data/reusables/repositories/rulest-workflows-intro-paragraph.md @@ -1 +1 @@ -Ruleset workflows can be configured at the organization level to require workflows to pass before merging pull requests. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization)." +Ruleset workflows can be configured at the organization level to require workflows to pass before merging pull requests. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization). diff --git a/data/reusables/repositories/security-advisory-edit-cve.md b/data/reusables/repositories/security-advisory-edit-cve.md index 2272f2e73914..0c2558f4b74f 100644 --- a/data/reusables/repositories/security-advisory-edit-cve.md +++ b/data/reusables/repositories/security-advisory-edit-cve.md @@ -1 +1 @@ -1. Use the **CVE identifier** dropdown menu to specify whether you already have a CVE identifier or plan to request one from {% data variables.product.prodname_dotcom %} later. If you have an existing CVE identifier, select **I have an existing CVE identifier** to display an **Existing CVE** field, and type the CVE identifier in the field. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories#cve-identification-numbers)." +1. Use the **CVE identifier** dropdown menu to specify whether you already have a CVE identifier or plan to request one from {% data variables.product.prodname_dotcom %} later. If you have an existing CVE identifier, select **I have an existing CVE identifier** to display an **Existing CVE** field, and type the CVE identifier in the field. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories#cve-identification-numbers). diff --git a/data/reusables/repositories/security-advisory-edit-cwe.md b/data/reusables/repositories/security-advisory-edit-cwe.md index fec0959abe68..21208a6e768b 100644 --- a/data/reusables/repositories/security-advisory-edit-cwe.md +++ b/data/reusables/repositories/security-advisory-edit-cwe.md @@ -1 +1 @@ -1. Under "Weaknesses", in the **Common weakness enumerator** field, type common weakness enumerators (CWEs) that describe the kinds of security weaknesses that this security advisory reports. For a full list of CWEs, see the "[Common Weakness Enumeration](https://cwe.mitre.org/index.html)" from MITRE. +1. Under "Weaknesses", in the **Common weakness enumerator** field, type common weakness enumerators (CWEs) that describe the kinds of security weaknesses that this security advisory reports. For a full list of CWEs, see the [Common Weakness Enumeration](https://cwe.mitre.org/index.html) from MITRE. diff --git a/data/reusables/repositories/security-advisory-edit-details.md b/data/reusables/repositories/security-advisory-edit-details.md index 4c94ee0e0647..eed54dbaaee4 100644 --- a/data/reusables/repositories/security-advisory-edit-details.md +++ b/data/reusables/repositories/security-advisory-edit-details.md @@ -1,3 +1,3 @@ 1. Under "Affected products", define the ecosystem, package name, affected/patched versions, and vulnerable functions for the security vulnerability that this security advisory describes. If applicable, you can add multiple affected products to the same advisory by clicking **Add another affected product**. - For information about how to specify information on the form, including affected versions, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories)." + For information about how to specify information on the form, including affected versions, see [AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories). diff --git a/data/reusables/repositories/security-guidelines.md b/data/reusables/repositories/security-guidelines.md index a0d73b79fa78..aa2568527770 100644 --- a/data/reusables/repositories/security-guidelines.md +++ b/data/reusables/repositories/security-guidelines.md @@ -1 +1 @@ -You can create a security policy to give people instructions for reporting security vulnerabilities in your project. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository)." +You can create a security policy to give people instructions for reporting security vulnerabilities in your project. For more information, see [AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository). diff --git a/data/reusables/repositories/sensitive-info-warning.md b/data/reusables/repositories/sensitive-info-warning.md index 2b67f0629b91..9917235eb095 100644 --- a/data/reusables/repositories/sensitive-info-warning.md +++ b/data/reusables/repositories/sensitive-info-warning.md @@ -1,2 +1,2 @@ > [!WARNING] -> Never `git add`, `commit`, or `push` sensitive information, for example passwords or API keys, to a remote repository. If you've already added this information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." +> Never `git add`, `commit`, or `push` sensitive information, for example passwords or API keys, to a remote repository. If you've already added this information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository). diff --git a/data/reusables/repositories/settings-permissions-org-policy-note.md b/data/reusables/repositories/settings-permissions-org-policy-note.md index 4ff117f228d4..6562e5d3e9bd 100644 --- a/data/reusables/repositories/settings-permissions-org-policy-note.md +++ b/data/reusables/repositories/settings-permissions-org-policy-note.md @@ -1,2 +1,2 @@ > [!NOTE] -> You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" or "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." +> You might not be able to manage these settings if your organization has an overriding policy or is managed by an enterprise that has overriding policy. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization) or [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise). diff --git a/data/reusables/repositories/sidebar-dependabot-alerts.md b/data/reusables/repositories/sidebar-dependabot-alerts.md index 055b480b5fda..044cd3ba9532 100644 --- a/data/reusables/repositories/sidebar-dependabot-alerts.md +++ b/data/reusables/repositories/sidebar-dependabot-alerts.md @@ -1,4 +1,4 @@ -1. In the "Vulnerability alerts" sidebar of security overview, click **{% data variables.product.prodname_dependabot %}**. If this option is missing, it means you don't have access to security alerts and need to be given access. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."{% ifversion fpt or ghec %} +1. In the "Vulnerability alerts" sidebar of security overview, click **{% data variables.product.prodname_dependabot %}**. If this option is missing, it means you don't have access to security alerts and need to be given access. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).{% ifversion fpt or ghec %} ![Screenshot of security overview, with the "Dependabot" tab highlighted with a dark orange outline.](/assets/images/help/repository/dependabot-tab.png){% else %} ![Screenshot of security overview, with the "Dependabot" tab highlighted with a dark orange outline.](/assets/images/enterprise/repository/dependabot-alerts-tab.png){% endif %} diff --git a/data/reusables/repositories/squash-and-rebase-linear-commit-history.md b/data/reusables/repositories/squash-and-rebase-linear-commit-history.md index 838f4a265a88..de25eb745cd8 100644 --- a/data/reusables/repositories/squash-and-rebase-linear-commit-history.md +++ b/data/reusables/repositories/squash-and-rebase-linear-commit-history.md @@ -1 +1 @@ -If there is a protected branch rule in your repository that requires a linear commit history, you must allow squash merging, rebase merging, or both. 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)." +If there is a protected branch rule in your repository that requires a linear commit history, you must allow squash merging, rebase merging, or both. 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). diff --git a/data/reusables/repositories/workflow-notifications.md b/data/reusables/repositories/workflow-notifications.md index 78c342996e0c..9cdfd2012f7f 100644 --- a/data/reusables/repositories/workflow-notifications.md +++ b/data/reusables/repositories/workflow-notifications.md @@ -1,5 +1,5 @@ -If you enable email or web notifications for {% data variables.product.prodname_actions %}, you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow run has failed. For more information about enabling or disabling notifications, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." +If you enable email or web notifications for {% data variables.product.prodname_actions %}, you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow run has failed. For more information about enabling or disabling notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). Notifications for scheduled workflows are sent to the user who initially created the workflow. If a different user updates the cron syntax in the workflow file, subsequent notifications will be sent to that user instead. If a scheduled workflow is disabled and then re-enabled, notifications will be sent to the user who re-enabled the workflow rather than the user who last modified the cron syntax. -You can also see the status of workflow runs on a repository's Actions tab. For more information, see "[AUTOTITLE](/actions/managing-workflow-runs)." +You can also see the status of workflow runs on a repository's Actions tab. For more information, see [AUTOTITLE](/actions/managing-workflow-runs). diff --git a/data/reusables/repositories/you-can-fork.md b/data/reusables/repositories/you-can-fork.md index 085a45dc1404..8db7307364b3 100644 --- a/data/reusables/repositories/you-can-fork.md +++ b/data/reusables/repositories/you-can-fork.md @@ -2,5 +2,5 @@ You can fork a private or internal repository to your personal account or to an organization on {% data variables.product.prodname_dotcom %} where you have permission to create repositories, provided that the settings for the repository and your enterprise policies allow forking. Generally, you can fork any public repository to your personal account or to an organization where you have permission to create repositories{% ifversion ghec %}, unless you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}{% endif %}. {% elsif fpt %} -You can fork any public repository to your personal account, or to an organization where you have permission to create repositories. If you have access to a private repository and the owner permits forking, you can fork the repository to your personal account, or to an organization on {% data variables.product.prodname_team %} where you have permission to create repositories. You cannot fork a private repository to an organization using {% data variables.product.prodname_free_team %}. For more information about {% data variables.product.prodname_team %} and {% data variables.product.prodname_free_team %}, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)." +You can fork any public repository to your personal account, or to an organization where you have permission to create repositories. If you have access to a private repository and the owner permits forking, you can fork the repository to your personal account, or to an organization on {% data variables.product.prodname_team %} where you have permission to create repositories. You cannot fork a private repository to an organization using {% data variables.product.prodname_free_team %}. For more information about {% data variables.product.prodname_team %} and {% data variables.product.prodname_free_team %}, see [AUTOTITLE](/get-started/learning-about-github/githubs-plans). {% endif %} diff --git a/data/reusables/rest-api/permission-header.md b/data/reusables/rest-api/permission-header.md index 53672d977a88..ab9b265d0b93 100644 --- a/data/reusables/rest-api/permission-header.md +++ b/data/reusables/rest-api/permission-header.md @@ -1,5 +1,5 @@ {% ifversion rest-permissions-header %} -To help you choose the correct permissions, you will receive the `X-Accepted-GitHub-Permissions` header in the REST API response. The header will tell you what permissions are required in order to access the endpoint. For more information, see "[AUTOTITLE](/rest/overview/troubleshooting#resource-not-accessible)." +To help you choose the correct permissions, you will receive the `X-Accepted-GitHub-Permissions` header in the REST API response. The header will tell you what permissions are required in order to access the endpoint. For more information, see [AUTOTITLE](/rest/overview/troubleshooting#resource-not-accessible). {% endif %} diff --git a/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md b/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md index 4f747331fc7f..5ce6995cb118 100644 --- a/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md +++ b/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md @@ -3,7 +3,7 @@ In addition to primary rate limits, {% data variables.product.company_short %} e You may encounter a secondary rate limit if you: * _Make too many concurrent requests._ No more than 100 concurrent requests are allowed. This limit is shared across the REST API and GraphQL API. -* _Make too many requests to a single endpoint per minute._ No more than 900 points per minute are allowed for REST API endpoints, and no more than 2,000 points per minute are allowed for the GraphQL API endpoint. For more information about points, see "[Calculating points for the secondary rate limit](#calculating-points-for-the-secondary-rate-limit)." +* _Make too many requests to a single endpoint per minute._ No more than 900 points per minute are allowed for REST API endpoints, and no more than 2,000 points per minute are allowed for the GraphQL API endpoint. For more information about points, see [Calculating points for the secondary rate limit](#calculating-points-for-the-secondary-rate-limit). * _Make too many requests per minute._ No more than 90 seconds of CPU time per 60 seconds of real time is allowed. No more than 60 seconds of this CPU time may be for the GraphQL API. You can roughly estimate the CPU time by measuring the total response time for your API requests. * _Make too many requests that consume excessive compute resources in a short period of time._ * _Create too much content on {% data variables.product.company_short %} in a short amount of time._ In general, no more than 80 content-generating requests per minute and no more than 500 content-generating requests per hour are allowed. Some endpoints have lower content creation limits. Content creation limits include actions taken on the {% data variables.product.company_short %} web interface as well as via the REST API and GraphQL API. diff --git a/data/reusables/saml/authenticate-with-saml-at-least-once.md b/data/reusables/saml/authenticate-with-saml-at-least-once.md index 5f875ce71ae6..06f8ff59ca78 100644 --- a/data/reusables/saml/authenticate-with-saml-at-least-once.md +++ b/data/reusables/saml/authenticate-with-saml-at-least-once.md @@ -1 +1 @@ -If you don't see **Configure SSO**, ensure that you have authenticated at least once through your SAML IdP to access resources on {% data variables.product.github %}. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)." +If you don't see **Configure SSO**, ensure that you have authenticated at least once through your SAML IdP to access resources on {% data variables.product.github %}. For more information, see [AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on). diff --git a/data/reusables/saml/authentication-loop.md b/data/reusables/saml/authentication-loop.md index 27e82269313f..69c0d7c9d1de 100644 --- a/data/reusables/saml/authentication-loop.md +++ b/data/reusables/saml/authentication-loop.md @@ -4,4 +4,4 @@ If users are repeatedly redirected to the SAML authentication prompt in a loop, The `SessionNotOnOrAfter` value sent in a SAML response determines when a user will be redirected back to the IdP to authenticate. If a SAML session duration is configured for 2 hours or less, {% data variables.product.prodname_dotcom %} will refresh a SAML session 5 minutes before it expires. If your session duration is configured as 5 minutes or less, users can get stuck in a SAML authentication loop. -To fix this problem, we recommend configuring a minimum SAML session duration of 4 hours. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference#session-duration-and-timeout)." +To fix this problem, we recommend configuring a minimum SAML session duration of 4 hours. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference#session-duration-and-timeout). diff --git a/data/reusables/saml/authorized-creds-info.md b/data/reusables/saml/authorized-creds-info.md index 5ae13046ddf7..8570c945458d 100644 --- a/data/reusables/saml/authorized-creds-info.md +++ b/data/reusables/saml/authorized-creds-info.md @@ -1,4 +1,4 @@ -Before you can authorize a {% data variables.product.pat_generic %} or SSH key, you must have a linked SAML identity. If you're a member of an organization where SAML SSO is enabled, you can create a linked identity by authenticating to your organization with your IdP at least once. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)." +Before you can authorize a {% data variables.product.pat_generic %} or SSH key, you must have a linked SAML identity. If you're a member of an organization where SAML SSO is enabled, you can create a linked identity by authenticating to your organization with your IdP at least once. For more information, see [AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on). After you authorize a {% data variables.product.pat_generic %} or SSH key, the token or key will stay authorized until revoked in one of the following ways. * An organization or enterprise owner revokes the authorization. diff --git a/data/reusables/saml/create-a-machine-user.md b/data/reusables/saml/create-a-machine-user.md index bfceee863d6d..824ba759e8aa 100644 --- a/data/reusables/saml/create-a-machine-user.md +++ b/data/reusables/saml/create-a-machine-user.md @@ -1 +1 @@ -You must create and use a dedicated machine user account on your IdP to associate with an enterprise owner account on {% data variables.product.product_name %}. Store the credentials for the user account securely in a password manager. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise)." +You must create and use a dedicated machine user account on your IdP to associate with an enterprise owner account on {% data variables.product.product_name %}. Store the credentials for the user account securely in a password manager. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise#enabling-user-provisioning-for-your-enterprise). diff --git a/data/reusables/saml/current-time-earlier-than-notbefore-condition.md b/data/reusables/saml/current-time-earlier-than-notbefore-condition.md index 1e7f25f7c7c4..a8e470ba3a0d 100644 --- a/data/reusables/saml/current-time-earlier-than-notbefore-condition.md +++ b/data/reusables/saml/current-time-earlier-than-notbefore-condition.md @@ -2,6 +2,6 @@ This error can occur when there's too large of a time difference between your IdP and {% data variables.product.product_name %}, which commonly occurs with self-hosted IdPs. -{% ifversion ghes %}To prevent this problem, we recommend pointing your appliance to the same Network Time Protocol (NTP) source as your IdP, if possible. {% endif %}If you encounter this error, make sure the time on your {% ifversion ghes %}appliance{% else %}IdP{% endif %} is properly synced with your NTP server. {% ifversion ghes %}You can use the `chronyc` command on the administrative shell to synchronize time immediately. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-time-synchronization#correcting-a-large-time-drift)."{% endif %} +{% ifversion ghes %}To prevent this problem, we recommend pointing your appliance to the same Network Time Protocol (NTP) source as your IdP, if possible. {% endif %}If you encounter this error, make sure the time on your {% ifversion ghes %}appliance{% else %}IdP{% endif %} is properly synced with your NTP server. {% ifversion ghes %}You can use the `chronyc` command on the administrative shell to synchronize time immediately. For more information, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-time-synchronization#correcting-a-large-time-drift).{% endif %} If you use ADFS as your IdP, also set `NotBeforeSkew` in ADFS to 1 minute for {% data variables.product.prodname_dotcom %}. If `NotBeforeSkew` is set to 0, even very small time differences, including milliseconds, can cause authentication problems. diff --git a/data/reusables/saml/ghes-you-must-configure-saml-sso.md b/data/reusables/saml/ghes-you-must-configure-saml-sso.md index ad73f790d3de..1a19dadb59af 100644 --- a/data/reusables/saml/ghes-you-must-configure-saml-sso.md +++ b/data/reusables/saml/ghes-you-must-configure-saml-sso.md @@ -1 +1 @@ -You must configure SAML SSO for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise)." +You must configure SAML SSO for {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise). diff --git a/data/reusables/saml/must-authorize-linked-identity.md b/data/reusables/saml/must-authorize-linked-identity.md index 4697c484ca5a..cd478ccd58e7 100644 --- a/data/reusables/saml/must-authorize-linked-identity.md +++ b/data/reusables/saml/must-authorize-linked-identity.md @@ -1,2 +1,2 @@ > [!NOTE] -> If you have a linked identity for an organization, you can only use authorized {% data variables.product.pat_generic %}s and SSH keys with that organization, even if SAML is not enforced. You have a linked identity for an organization if you've ever authenticated via SAML SSO for that organization, unless an organization or enterprise owner later revoked the linked identity. For more information about revoking linked identities, see "[AUTOTITLE](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)" and "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise)." +> If you have a linked identity for an organization, you can only use authorized {% data variables.product.pat_generic %}s and SSH keys with that organization, even if SAML is not enforced. You have a linked identity for an organization if you've ever authenticated via SAML SSO for that organization, unless an organization or enterprise owner later revoked the linked identity. For more information about revoking linked identities, see [AUTOTITLE](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization) and [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise). diff --git a/data/reusables/saml/no-scim-for-enterprises.md b/data/reusables/saml/no-scim-for-enterprises.md index d38ac64856d9..7b5a32e96e1e 100644 --- a/data/reusables/saml/no-scim-for-enterprises.md +++ b/data/reusables/saml/no-scim-for-enterprises.md @@ -1,8 +1,8 @@ {% ifversion ghec %} > [!NOTE] -> You cannot configure SCIM for your enterprise account unless your account was created for {% data variables.product.prodname_emus %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." +> You cannot configure SCIM for your enterprise account unless your account was created for {% data variables.product.prodname_emus %}. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). > -> If you do not use {% data variables.product.prodname_emus %}, and you want to use SCIM provisioning, you must configure SAML SSO at the organization level, not the enterprise level. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)." +> If you do not use {% data variables.product.prodname_emus %}, and you want to use SCIM provisioning, you must configure SAML SSO at the organization level, not the enterprise level. For more information, see [AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on). {% endif %} diff --git a/data/reusables/saml/okta-edit-provisioning.md b/data/reusables/saml/okta-edit-provisioning.md index bb531cf84920..0ae36891b280 100644 --- a/data/reusables/saml/okta-edit-provisioning.md +++ b/data/reusables/saml/okta-edit-provisioning.md @@ -1,4 +1,4 @@ -1. To avoid syncing errors and confirm that your users have SAML enabled and SCIM linked identities, we recommend you audit your organization's users. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization)." +1. To avoid syncing errors and confirm that your users have SAML enabled and SCIM linked identities, we recommend you audit your organization's users. For more information, see [AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/troubleshooting-identity-and-access-management-for-your-organization). 1. To the right of "Provisioning to App", click **Edit**. 1. To the right of "Create Users," select **Enable**. diff --git a/data/reusables/saml/outside-collaborators-exemption.md b/data/reusables/saml/outside-collaborators-exemption.md index da0ee78b56ee..394417801b9c 100644 --- a/data/reusables/saml/outside-collaborators-exemption.md +++ b/data/reusables/saml/outside-collaborators-exemption.md @@ -1,2 +1,2 @@ > [!NOTE] -> SAML authentication is not required for outside collaborators. For more information about outside collaborators, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)." +> SAML authentication is not required for outside collaborators. For more information about outside collaborators, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators). diff --git a/data/reusables/saml/saml-accounts.md b/data/reusables/saml/saml-accounts.md index 7e3a87806fa1..f8422db900f4 100644 --- a/data/reusables/saml/saml-accounts.md +++ b/data/reusables/saml/saml-accounts.md @@ -1,4 +1,4 @@ -If you configure SAML SSO, members of your organization will continue to sign into their personal accounts on {% data variables.product.prodname_dotcom_the_website %}. When a member accesses most resources within your organization, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. After successful authentication, your IdP redirects the member back to {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)." +If you configure SAML SSO, members of your organization will continue to sign into their personal accounts on {% data variables.product.prodname_dotcom_the_website %}. When a member accesses most resources within your organization, {% data variables.product.prodname_dotcom %} redirects the member to your IdP to authenticate. After successful authentication, your IdP redirects the member back to {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on). > [!NOTE] > SAML SSO does not replace the normal sign-in process for {% data variables.product.prodname_dotcom %}. Unless you use {% data variables.product.prodname_emus %}, members will continue to sign into their personal accounts on {% data variables.product.prodname_dotcom_the_website %}, and each personal account will be linked to an external identity in your IdP. diff --git a/data/reusables/saml/saml-ghes-account-revocation.md b/data/reusables/saml/saml-ghes-account-revocation.md index 3414df8fb983..fb87f5cb0c6a 100644 --- a/data/reusables/saml/saml-ghes-account-revocation.md +++ b/data/reusables/saml/saml-ghes-account-revocation.md @@ -1,5 +1,5 @@ {% ifversion ghes %} -With JIT provisioning, if you remove a user from your IdP, you must also manually suspend the user's account on {% data variables.location.product_location %}. Otherwise, the account's owner can continue to authenticate using access tokens or SSH keys. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users)". +With JIT provisioning, if you remove a user from your IdP, you must also manually suspend the user's account on {% data variables.location.product_location %}. Otherwise, the account's owner can continue to authenticate using access tokens or SSH keys. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users). {% endif %} diff --git a/data/reusables/saml/saml-session-oauth.md b/data/reusables/saml/saml-session-oauth.md index c1359ad5a22d..fb3edcc45694 100644 --- a/data/reusables/saml/saml-session-oauth.md +++ b/data/reusables/saml/saml-session-oauth.md @@ -1 +1 @@ -If you belong to any organizations that enforce SAML single sign-on, you may be prompted to authenticate through your identity provider before you can authorize an {% data variables.product.prodname_oauth_app %}. For more information about SAML, see "[AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +If you belong to any organizations that enforce SAML single sign-on, you may be prompted to authenticate through your identity provider before you can authorize an {% data variables.product.prodname_oauth_app %}. For more information about SAML, see [AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} diff --git a/data/reusables/saml/use-api-to-get-externalidentity.md b/data/reusables/saml/use-api-to-get-externalidentity.md index b94c5989ce1f..36feac3f2781 100644 --- a/data/reusables/saml/use-api-to-get-externalidentity.md +++ b/data/reusables/saml/use-api-to-get-externalidentity.md @@ -1 +1 @@ -1. Use the GraphQL API to retrieve the `ExternalIdentity` for each member. For more information, see "[AUTOTITLE](/graphql/overview/about-the-graphql-api)" and "[AUTOTITLE](/graphql/reference/objects#externalidentity)" in the GraphQL API documentation. +1. Use the GraphQL API to retrieve the `ExternalIdentity` for each member. For more information, see [AUTOTITLE](/graphql/overview/about-the-graphql-api) and [AUTOTITLE](/graphql/reference/objects#externalidentity) in the GraphQL API documentation. diff --git a/data/reusables/saml/you-must-periodically-authenticate.md b/data/reusables/saml/you-must-periodically-authenticate.md index 5aa3092a7c75..0330e8c11550 100644 --- a/data/reusables/saml/you-must-periodically-authenticate.md +++ b/data/reusables/saml/you-must-periodically-authenticate.md @@ -1 +1 @@ -You must periodically authenticate with your SAML IdP to authenticate and gain access to the organization's resources on {% data variables.product.prodname_dotcom %}. The duration of this login period is specified by your IdP and is generally 24 hours. This periodic login requirement limits the length of access and requires you to re-identify yourself to continue. You can view and manage your active SAML sessions in your security settings. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions)." +You must periodically authenticate with your SAML IdP to authenticate and gain access to the organization's resources on {% data variables.product.prodname_dotcom %}. The duration of this login period is specified by your IdP and is generally 24 hours. This periodic login requirement limits the length of access and requires you to re-identify yourself to continue. You can view and manage your active SAML sessions in your security settings. For more information, see [AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/viewing-and-managing-your-active-saml-sessions). diff --git a/data/reusables/scim/emu-prerequisite-authentication.md b/data/reusables/scim/emu-prerequisite-authentication.md index 73ed8d333dfe..d72008ef97a3 100644 --- a/data/reusables/scim/emu-prerequisite-authentication.md +++ b/data/reusables/scim/emu-prerequisite-authentication.md @@ -1 +1 @@ -Before you configure provisioning, you must configure authentication for your users. This configuration requires setup on both your identity management system and {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users)." +Before you configure provisioning, you must configure authentication for your users. This configuration requires setup on both your identity management system and {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users). diff --git a/data/reusables/scim/emu-scim-rate-limit.md b/data/reusables/scim/emu-scim-rate-limit.md index b113dc48dcb3..c26453c3626b 100644 --- a/data/reusables/scim/emu-scim-rate-limit.md +++ b/data/reusables/scim/emu-scim-rate-limit.md @@ -1,2 +1,2 @@ > [!NOTE] -> {% data reusables.scim.emu-scim-rate-limit-details %} For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise#scim-provisioning-errors)." +> {% data reusables.scim.emu-scim-rate-limit-details %} For more information, see [AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise#scim-provisioning-errors). diff --git a/data/reusables/scim/enterprise-account-scim.md b/data/reusables/scim/enterprise-account-scim.md index 4f3fdf04e360..9d050d5fb9f3 100644 --- a/data/reusables/scim/enterprise-account-scim.md +++ b/data/reusables/scim/enterprise-account-scim.md @@ -1 +1 @@ -You cannot use this implementation of SCIM with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. If your enterprise is enabled for {% data variables.product.prodname_emus %}, you must use a different implementation of SCIM. Otherwise, SCIM is not available at the enterprise level. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users)." +You cannot use this implementation of SCIM with an enterprise account or with an {% data variables.enterprise.prodname_emu_org %}. If your enterprise is enabled for {% data variables.product.prodname_emus %}, you must use a different implementation of SCIM. Otherwise, SCIM is not available at the enterprise level. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/configuring-scim-provisioning-for-enterprise-managed-users). diff --git a/data/reusables/scim/ghec-open-scim-operation-differentiation.md b/data/reusables/scim/ghec-open-scim-operation-differentiation.md index b2ee52efbcc7..fe4c95e135df 100644 --- a/data/reusables/scim/ghec-open-scim-operation-differentiation.md +++ b/data/reusables/scim/ghec-open-scim-operation-differentiation.md @@ -1 +1 @@ -These endpoints allow you to provision user accounts for your enterprise on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is only available for use with {% data variables.product.prodname_emus %}. If you don't use {% data variables.product.prodname_emus %} and want to provision access to your organizations using SCIM, see "[AUTOTITLE](/rest/enterprise-admin/scim)." +These endpoints allow you to provision user accounts for your enterprise on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is only available for use with {% data variables.product.prodname_emus %}. If you don't use {% data variables.product.prodname_emus %} and want to provision access to your organizations using SCIM, see [AUTOTITLE](/rest/enterprise-admin/scim). diff --git a/data/reusables/scim/ghes-beta-note.md b/data/reusables/scim/ghes-beta-note.md index a93e819a7a94..02d0e930baf4 100644 --- a/data/reusables/scim/ghes-beta-note.md +++ b/data/reusables/scim/ghes-beta-note.md @@ -1,11 +1,11 @@ {% ifversion scim-for-ghes-public-beta %} ->[!NOTE] SCIM for {% data variables.product.product_name %} is currently in {% data variables.release-phases.public_preview %} and subject to change. {% data variables.product.company_short %} recommends testing with a staging instance first. See "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." +>[!NOTE] SCIM for {% data variables.product.product_name %} is currently in {% data variables.release-phases.public_preview %} and subject to change. {% data variables.product.company_short %} recommends testing with a staging instance first. See [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance). {% elsif ghes < 3.14 %} >[!NOTE] This is an outdated, {% data variables.release-phases.private_preview %} version of SCIM for {% data variables.product.product_name %}. Customers must upgrade to 3.14 or newer and use the {% data variables.product.product_name %} SCIM {% data variables.release-phases.public_preview %} in order for their SCIM feedback or bug reports to be considered. ->[!WARNING] The {% data variables.release-phases.public_preview %} is exclusively for testing and feedback, and no support is available. {% data variables.product.company_short %} recommends testing with a staging instance. For more information, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)." +>[!WARNING] The {% data variables.release-phases.public_preview %} is exclusively for testing and feedback, and no support is available. {% data variables.product.company_short %} recommends testing with a staging instance. For more information, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance). {% endif %} diff --git a/data/reusables/scim/organization-rest-api-ghec-deployment-option.md b/data/reusables/scim/organization-rest-api-ghec-deployment-option.md index b0af51674215..e7e47081e103 100644 --- a/data/reusables/scim/organization-rest-api-ghec-deployment-option.md +++ b/data/reusables/scim/organization-rest-api-ghec-deployment-option.md @@ -1,2 +1,2 @@ > [!NOTE] -> This operation allows you to provision access to an organization on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is not available for use with {% data variables.product.prodname_emus %}. For more information about provisioning {% data variables.enterprise.prodname_managed_users %} using SCIM, see "[AUTOTITLE](/rest/enterprise-admin/scim)." +> This operation allows you to provision access to an organization on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is not available for use with {% data variables.product.prodname_emus %}. For more information about provisioning {% data variables.enterprise.prodname_managed_users %} using SCIM, see [AUTOTITLE](/rest/enterprise-admin/scim). diff --git a/data/reusables/scim/public-scim-more-info-about-deprovisioning-and-reactivating.md b/data/reusables/scim/public-scim-more-info-about-deprovisioning-and-reactivating.md index f06293c5a347..8d55d6e07e79 100644 --- a/data/reusables/scim/public-scim-more-info-about-deprovisioning-and-reactivating.md +++ b/data/reusables/scim/public-scim-more-info-about-deprovisioning-and-reactivating.md @@ -1 +1 @@ -For more information, see "[Soft-deprovisioning users with the REST API](#soft-deprovisioning-users-with-the-rest-api)" and "[Reactivating users with the REST API](#reactivating-users-with-the-rest-api)." +For more information, see [Soft-deprovisioning users with the REST API](#soft-deprovisioning-users-with-the-rest-api) and [Reactivating users with the REST API](#reactivating-users-with-the-rest-api). diff --git a/data/reusables/search/date_gt_lt.md b/data/reusables/search/date_gt_lt.md index cb3ff27d3833..921cffe335e1 100644 --- a/data/reusables/search/date_gt_lt.md +++ b/data/reusables/search/date_gt_lt.md @@ -1 +1 @@ -When you search for a date, you can use greater than, less than, and range qualifiers to further filter results. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)." +When you search for a date, you can use greater than, less than, and range qualifiers to further filter results. For more information, see [AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). diff --git a/data/reusables/search/non-code-search-explanation.md b/data/reusables/search/non-code-search-explanation.md index ef9a04224b13..464fc341d3b1 100644 --- a/data/reusables/search/non-code-search-explanation.md +++ b/data/reusables/search/non-code-search-explanation.md @@ -1 +1 @@ -Note that the syntax and qualifiers for searching for non-code content, such as issues, users, and discussions, is not the same as the syntax for code search. For more information on non-code search, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)" and "[AUTOTITLE](/search-github/searching-on-github)." +Note that the syntax and qualifiers for searching for non-code content, such as issues, users, and discussions, is not the same as the syntax for code search. For more information on non-code search, see [AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github) and [AUTOTITLE](/search-github/searching-on-github). diff --git a/data/reusables/search/requested_reviews_search.md b/data/reusables/search/requested_reviews_search.md index 52116ed91316..394caf94df7d 100644 --- a/data/reusables/search/requested_reviews_search.md +++ b/data/reusables/search/requested_reviews_search.md @@ -1 +1 @@ -You can find a pull request where you or a team you're a member of is requested for review with the search qualifier `review-requested:[USERNAME]` or `team-review-requested:[TEAMNAME]`. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests)." +You can find a pull request where you or a team you're a member of is requested for review with the search qualifier `review-requested:[USERNAME]` or `team-review-requested:[TEAMNAME]`. For more information, see [AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests). diff --git a/data/reusables/search/requested_reviews_search_tip.md b/data/reusables/search/requested_reviews_search_tip.md index b7d581a53d6f..8a6ecf2e0f50 100644 --- a/data/reusables/search/requested_reviews_search_tip.md +++ b/data/reusables/search/requested_reviews_search_tip.md @@ -1,2 +1,2 @@ > [!TIP] -> You can find a pull request where you or a team you're a member of is requested for review with the search qualifier `review-requested:[USERNAME]` or `team-review-requested:[TEAMNAME]`. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests)." +> You can find a pull request where you or a team you're a member of is requested for review with the search qualifier `review-requested:[USERNAME]` or `team-review-requested:[TEAMNAME]`. For more information, see [AUTOTITLE](/search-github/searching-on-github/searching-issues-and-pull-requests). diff --git a/data/reusables/search/search_issues_and_pull_requests_shortcut.md b/data/reusables/search/search_issues_and_pull_requests_shortcut.md index 98f5077b2e48..01ea200878bd 100644 --- a/data/reusables/search/search_issues_and_pull_requests_shortcut.md +++ b/data/reusables/search/search_issues_and_pull_requests_shortcut.md @@ -1 +1 @@ -You can focus your cursor on the search bar above the issue or pull request list with a keyboard shortcut. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#issue-and-pull-request-lists)." +You can focus your cursor on the search bar above the issue or pull request list with a keyboard shortcut. For more information, see [AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#issue-and-pull-request-lists). diff --git a/data/reusables/search/syntax_tips.md b/data/reusables/search/syntax_tips.md index 7cfe15d39dbc..4ff59b106870 100644 --- a/data/reusables/search/syntax_tips.md +++ b/data/reusables/search/syntax_tips.md @@ -2,5 +2,5 @@ {% ifversion ghes %} > * This article contains links to example searches on the {% data variables.product.prodname_dotcom_the_website %} website, but you can use the same search filters with {% data variables.product.product_name %}. In the linked example searches, replace `github.com` with the hostname for {% data variables.location.product_location %}. {% endif %} -> * For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". +> * For a list of search syntaxes that you can add to any search qualifier to further improve your results, see [AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax). > * Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. diff --git a/data/reusables/secret-scanning/alert-type-links.md b/data/reusables/secret-scanning/alert-type-links.md index d7c998acc2e2..d8947273130d 100644 --- a/data/reusables/secret-scanning/alert-type-links.md +++ b/data/reusables/secret-scanning/alert-type-links.md @@ -1 +1 @@ -For more information, see {% ifversion fpt or ghec %}"[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts#about-user-alerts){% elsif ghes %}"[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts#about-secret-scanning-alerts){% endif %}." +For more information, see {% ifversion fpt or ghec %}"[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts#about-user-alerts){% elsif ghes %}[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts#about-secret-scanning-alerts){% endif %}. diff --git a/data/reusables/secret-scanning/audit-secret-scanning-events.md b/data/reusables/secret-scanning/audit-secret-scanning-events.md index 6e2211b543ba..c52f9d67c878 100644 --- a/data/reusables/secret-scanning/audit-secret-scanning-events.md +++ b/data/reusables/secret-scanning/audit-secret-scanning-events.md @@ -1 +1 @@ -You can audit the actions taken in response to {% data variables.product.prodname_secret_scanning %} alerts using {% data variables.product.prodname_dotcom %} tools. For more information, see "[AUTOTITLE](/code-security/getting-started/auditing-security-alerts)." +You can audit the actions taken in response to {% data variables.product.prodname_secret_scanning %} alerts using {% data variables.product.prodname_dotcom %} tools. For more information, see [AUTOTITLE](/code-security/getting-started/auditing-security-alerts). diff --git a/data/reusables/secret-scanning/dry-runs-enterprise-permissions.md b/data/reusables/secret-scanning/dry-runs-enterprise-permissions.md index a794b142e24a..8f033ee835e4 100644 --- a/data/reusables/secret-scanning/dry-runs-enterprise-permissions.md +++ b/data/reusables/secret-scanning/dry-runs-enterprise-permissions.md @@ -1 +1 @@ -You can only perform a dry run on repositories that you have administration access to. If an enterprise owner wants access to perform dry runs on any repository in an organization, they must be assigned the organization owner role. For more information, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)." +You can only perform a dry run on repositories that you have administration access to. If an enterprise owner wants access to perform dry runs on any repository in an organization, they must be assigned the organization owner role. 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/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md b/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md index da15e6d0215a..6af5cc3aedcb 100644 --- a/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md +++ b/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md @@ -1,8 +1,8 @@ {% ifversion ghes %} > [!NOTE] -> Your site administrator must enable {% data variables.product.prodname_secret_scanning %} for the instance before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance)." +> Your site administrator must enable {% data variables.product.prodname_secret_scanning %} for the instance before you can use this feature. For more information, see [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance). > -> You may not be able to enable or disable {% data variables.product.prodname_secret_scanning %}, if an enterprise owner has set a policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." +> You may not be able to enable or disable {% data variables.product.prodname_secret_scanning %}, if an enterprise owner has set a policy at the enterprise level. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise). {% endif %} diff --git a/data/reusables/secret-scanning/link-to-push-protection.md b/data/reusables/secret-scanning/link-to-push-protection.md index 5975dd27ff60..af54281313c7 100644 --- a/data/reusables/secret-scanning/link-to-push-protection.md +++ b/data/reusables/secret-scanning/link-to-push-protection.md @@ -1 +1 @@ -You can configure {% data variables.product.prodname_secret_scanning %} to check pushes for custom patterns before commits are merged into the default branch. For more information, see "[Enabling push protection for a custom pattern](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns#enabling-push-protection-for-a-custom-pattern)." +You can configure {% data variables.product.prodname_secret_scanning %} to check pushes for custom patterns before commits are merged into the default branch. For more information, see [Enabling push protection for a custom pattern](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns#enabling-push-protection-for-a-custom-pattern). diff --git a/data/reusables/secret-scanning/partner-program-link.md b/data/reusables/secret-scanning/partner-program-link.md index 4d358da42e48..b6554a9eac25 100644 --- a/data/reusables/secret-scanning/partner-program-link.md +++ b/data/reusables/secret-scanning/partner-program-link.md @@ -1,5 +1,5 @@ {% ifversion fpt or ghec %} -To find out about our partner program, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program)." +To find out about our partner program, see [AUTOTITLE](/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program). {% else %} -To find out about our partner program, see "[AUTOTITLE](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program)" in the {% data variables.product.prodname_ghe_cloud %} documentation. +To find out about our partner program, see [AUTOTITLE](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program) in the {% data variables.product.prodname_ghe_cloud %} documentation. {% endif %} diff --git a/data/reusables/secret-scanning/push-protection-allow-secrets-alerts.md b/data/reusables/secret-scanning/push-protection-allow-secrets-alerts.md index 39009a081ba3..35ed2f133385 100644 --- a/data/reusables/secret-scanning/push-protection-allow-secrets-alerts.md +++ b/data/reusables/secret-scanning/push-protection-allow-secrets-alerts.md @@ -1 +1 @@ -When you allow a secret to be pushed, an alert is created in the **Security** tab. {% data variables.product.prodname_dotcom %} closes the alert and doesn't send a notification if you specify that the secret is a false positive or used only in tests. If you specify that the secret is real and that you will fix it later, {% data variables.product.prodname_dotcom %} keeps the security alert open and sends notifications to the author of the commit, as well as to repository administrators. For more information, see "[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning)." +When you allow a secret to be pushed, an alert is created in the **Security** tab. {% data variables.product.prodname_dotcom %} closes the alert and doesn't send a notification if you specify that the secret is a false positive or used only in tests. If you specify that the secret is real and that you will fix it later, {% data variables.product.prodname_dotcom %} keeps the security alert open and sends notifications to the author of the commit, as well as to repository administrators. For more information, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning). diff --git a/data/reusables/secret-scanning/push-protection-enterprise-note.md b/data/reusables/secret-scanning/push-protection-enterprise-note.md index e780bc770143..b06fd932e33f 100644 --- a/data/reusables/secret-scanning/push-protection-enterprise-note.md +++ b/data/reusables/secret-scanning/push-protection-enterprise-note.md @@ -1,3 +1,3 @@ > [!NOTE] -> * To enable push protection for custom patterns, {% data variables.product.prodname_secret_scanning %} as push protection needs to be enabled at the enterprise level. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-your-enterprise)." +> * To enable push protection for custom patterns, {% data variables.product.prodname_secret_scanning %} as push protection needs to be enabled at the enterprise level. For more information, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-your-enterprise). > * Enabling push protection for commonly found custom patterns can be disruptive to contributors. diff --git a/data/reusables/secret-scanning/push-protection-org-notes.md b/data/reusables/secret-scanning/push-protection-org-notes.md index b15d2405f563..76c1e6c4fb22 100644 --- a/data/reusables/secret-scanning/push-protection-org-notes.md +++ b/data/reusables/secret-scanning/push-protection-org-notes.md @@ -1,4 +1,4 @@ > [!NOTE] > * The option to enable push protection is visible for published patterns only. -> * Push protection for custom patterns will only apply to repositories in your organization that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization)." +> * Push protection for custom patterns will only apply to repositories in your organization that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see [AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization). > * Enabling push protection for commonly found custom patterns can be disruptive to contributors. diff --git a/data/reusables/secret-scanning/push-protection-public-repos-bypass.md b/data/reusables/secret-scanning/push-protection-public-repos-bypass.md index 3380b58a469f..1b3cfdc0b01d 100644 --- a/data/reusables/secret-scanning/push-protection-public-repos-bypass.md +++ b/data/reusables/secret-scanning/push-protection-public-repos-bypass.md @@ -5,6 +5,6 @@ > > When pushing to a _public_ repository that doesn't have secret scanning enabled, you are still protected from accidentally pushing secrets thanks to _push protection for users_, which is on by default for your user account. > - > With push protection for users, GitHub will automatically block pushes to public repositories if these pushes contain supported secrets, but you won't need to specify a reason for allowing the secret, and {% data variables.product.prodname_dotcom %} won't generate an alert. For more information, see "[AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users)." + > With push protection for users, GitHub will automatically block pushes to public repositories if these pushes contain supported secrets, but you won't need to specify a reason for allowing the secret, and {% data variables.product.prodname_dotcom %} won't generate an alert. For more information, see [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users). {% endif %} diff --git a/data/reusables/secret-scanning/secret-scanning-enterprise-level-api.md b/data/reusables/secret-scanning/secret-scanning-enterprise-level-api.md index ae6501e9a00c..03e4381e379f 100644 --- a/data/reusables/secret-scanning/secret-scanning-enterprise-level-api.md +++ b/data/reusables/secret-scanning/secret-scanning-enterprise-level-api.md @@ -1 +1 @@ -You can also enable or disable {% data variables.product.prodname_advanced_security %} features via the API. For more information, see "[AUTOTITLE](/rest/secret-scanning#enable-or-disable-security-features-for-an-enterprise)" in the REST API documentation. +You can also enable or disable {% data variables.product.prodname_advanced_security %} features via the API. For more information, see [AUTOTITLE](/rest/secret-scanning#enable-or-disable-security-features-for-an-enterprise) in the REST API documentation. diff --git a/data/reusables/secret-scanning/view-custom-pattern.md b/data/reusables/secret-scanning/view-custom-pattern.md index be93ccf9d8cd..35957abf6e75 100644 --- a/data/reusables/secret-scanning/view-custom-pattern.md +++ b/data/reusables/secret-scanning/view-custom-pattern.md @@ -1,3 +1,3 @@ 1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account. - * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization)". - * For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account)." + * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see [Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository) or [Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization). + * For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see [Defining a custom pattern for an enterprise account](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account). diff --git a/data/reusables/security-advisory/link-browsing-advisory-db.md b/data/reusables/security-advisory/link-browsing-advisory-db.md index 45c87d77c45a..e084d3a38d21 100644 --- a/data/reusables/security-advisory/link-browsing-advisory-db.md +++ b/data/reusables/security-advisory/link-browsing-advisory-db.md @@ -1 +1 @@ -For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database)." +For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database). diff --git a/data/reusables/security-advisory/private-vulnerability-api.md b/data/reusables/security-advisory/private-vulnerability-api.md index 48407e60d7e7..51b98f9e100f 100644 --- a/data/reusables/security-advisory/private-vulnerability-api.md +++ b/data/reusables/security-advisory/private-vulnerability-api.md @@ -1 +1 @@ -Security researchers can also use the REST API to privately report security vulnerabilities. For more information, see "[Privately report a security vulnerability](/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability)." +Security researchers can also use the REST API to privately report security vulnerabilities. For more information, see [Privately report a security vulnerability](/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability). diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md b/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md index 0ddf3d9eb746..d8b3775cc185 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-disabled.md @@ -1,2 +1,2 @@ > [!NOTE] -> If the repository doesn't have private vulnerability reporting enabled, you need to initiate the reporting process by following the instructions in the security policy for the repository, or create an issue asking the maintainers for a preferred security contact. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github)." +> If the repository doesn't have private vulnerability reporting enabled, you need to initiate the reporting process by following the instructions in the security policy for the repository, or create an issue asking the maintainers for a preferred security contact. For more information, see [AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github). diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-enable.md b/data/reusables/security-advisory/private-vulnerability-reporting-enable.md index 3fe79290571c..4b64ebfc6f6b 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-enable.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-enable.md @@ -1 +1 @@ -Owners and administrators of public repositories can enable private vulnerability reporting on their repositories. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository)." +Owners and administrators of public repositories can enable private vulnerability reporting on their repositories. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository). diff --git a/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md b/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md index 05f90d79bb07..0c9fd6c15a47 100644 --- a/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md +++ b/data/reusables/security-advisory/reporting-a-vulnerability-non-admin.md @@ -4,9 +4,9 @@ 1. Fill in the advisory details form. > [!TIP] - > In this form, only the title and description are mandatory. (In the general draft security advisory form, which the repository maintainer initiates, specifying the ecosystem is also required.) However, we recommend security researchers provide as much information as possible on the form so that the maintainers can make an informed decision about the submitted report. You can adopt the template used by our security researchers from the {% data variables.product.prodname_security %}, which is available on the "[`github/securitylab` repository](https://github.com/github/securitylab/blob/main/docs/report-template.md)." + > In this form, only the title and description are mandatory. (In the general draft security advisory form, which the repository maintainer initiates, specifying the ecosystem is also required.) However, we recommend security researchers provide as much information as possible on the form so that the maintainers can make an informed decision about the submitted report. You can adopt the template used by our security researchers from the {% data variables.product.prodname_security %}, which is available on the [`github/securitylab` repository](https://github.com/github/securitylab/blob/main/docs/report-template.md). - For more information about the fields available and guidance on filling in the form, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory)" and "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories)." + For more information about the fields available and guidance on filling in the form, see [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory) and [AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories). 1. At the bottom of the form, click **Submit report**. {% data variables.product.prodname_dotcom %} will display a message letting you know that maintainers have been notified and that you have a pending credit for this security advisory. diff --git a/data/reusables/security-advisory/repository-level-advisory-note.md b/data/reusables/security-advisory/repository-level-advisory-note.md index 99b078df658e..fb7f927ad71a 100644 --- a/data/reusables/security-advisory/repository-level-advisory-note.md +++ b/data/reusables/security-advisory/repository-level-advisory-note.md @@ -1,4 +1,4 @@ > [!NOTE] > This article applies to editing repository-level advisories as an owner of a public repository. > -> Users who are not repository owners can contribute to global security advisories in the {% data variables.product.prodname_advisory_database %} at [github.com/advisories](https://github.com/advisories). Edits to global advisories will not change or affect how the advisory appears on the repository. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database)." +> Users who are not repository owners can contribute to global security advisories in the {% data variables.product.prodname_advisory_database %} at [github.com/advisories](https://github.com/advisories). Edits to global advisories will not change or affect how the advisory appears on the repository. For more information, see [AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database). diff --git a/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md b/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md index be9570614881..c55350db8572 100644 --- a/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md +++ b/data/reusables/security-advisory/security-researcher-cannot-create-advisory.md @@ -1,2 +1,2 @@ > [!NOTE] -> If you are a security researcher, you should directly contact maintainers to ask them to create security advisories or issue CVEs on your behalf in repositories that you don't administer. However, if private vulnerability reporting is enabled for the repository, you can _privately_ report a vulnerability yourself. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability)." +> If you are a security researcher, you should directly contact maintainers to ask them to create security advisories or issue CVEs on your behalf in repositories that you don't administer. However, if private vulnerability reporting is enabled for the repository, you can _privately_ report a vulnerability yourself. For more information, see [AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability). diff --git a/data/reusables/security-configurations/edit-configuration-next-step.md b/data/reusables/security-configurations/edit-configuration-next-step.md index bb6eb69ea438..84aa7d24c33f 100644 --- a/data/reusables/security-configurations/edit-configuration-next-step.md +++ b/data/reusables/security-configurations/edit-configuration-next-step.md @@ -1 +1 @@ -To learn how to edit your {% data variables.product.prodname_custom_security_configuration %}, see "[AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/editing-a-custom-security-configuration)." +To learn how to edit your {% data variables.product.prodname_custom_security_configuration %}, see [AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/editing-a-custom-security-configuration). diff --git a/data/reusables/security-configurations/enable-security-features-with-gh-config.md b/data/reusables/security-configurations/enable-security-features-with-gh-config.md index 11fe44f5b24b..45448dd345b1 100644 --- a/data/reusables/security-configurations/enable-security-features-with-gh-config.md +++ b/data/reusables/security-configurations/enable-security-features-with-gh-config.md @@ -1 +1 @@ -You can quickly enable security features at scale with {% ifversion security-configurations-cloud %}the {% data variables.product.prodname_github_security_configuration %}{% else %}a {% data variables.product.prodname_security_configuration %}{% endif %}, a collection of security enablement settings you can apply to repositories in an organization. You can then further customize {% data variables.product.prodname_GH_advanced_security %} features at the organization level with {% data variables.product.prodname_global_settings %}. See "[AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." +You can quickly enable security features at scale with {% ifversion security-configurations-cloud %}the {% data variables.product.prodname_github_security_configuration %}{% else %}a {% data variables.product.prodname_security_configuration %}{% endif %}, a collection of security enablement settings you can apply to repositories in an organization. You can then further customize {% data variables.product.prodname_GH_advanced_security %} features at the organization level with {% data variables.product.prodname_global_settings %}. See [AUTOTITLE](/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale). diff --git a/data/reusables/security-configurations/managing-GHAS-licenses.md b/data/reusables/security-configurations/managing-GHAS-licenses.md index beaf38038c30..86947a356ea5 100644 --- a/data/reusables/security-configurations/managing-GHAS-licenses.md +++ b/data/reusables/security-configurations/managing-GHAS-licenses.md @@ -1,2 +1,2 @@ >[!NOTE] -> With {% data variables.product.prodname_security_configurations %}, you can manage {% data variables.product.prodname_GH_advanced_security %} feature enablement and license usage for your organization. See "[AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage)." +> With {% data variables.product.prodname_security_configurations %}, you can manage {% data variables.product.prodname_GH_advanced_security %} feature enablement and license usage for your organization. See [AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage). diff --git a/data/reusables/security-configurations/troubleshooting-next-step.md b/data/reusables/security-configurations/troubleshooting-next-step.md index b8ca485bd428..eaa344147f0c 100644 --- a/data/reusables/security-configurations/troubleshooting-next-step.md +++ b/data/reusables/security-configurations/troubleshooting-next-step.md @@ -1 +1 @@ -You may encounter an error when you attempt to apply a {% data variables.product.prodname_security_configuration %}. For more information, see "[AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures)" and "[AUTOTITLE](/code-security/securing-your-organization/troubleshooting-security-configurations/)." +You may encounter an error when you attempt to apply a {% data variables.product.prodname_security_configuration %}. For more information, see [AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures) and [AUTOTITLE](/code-security/securing-your-organization/troubleshooting-security-configurations/). diff --git a/data/reusables/security-overview/enterprise-filters-tip.md b/data/reusables/security-overview/enterprise-filters-tip.md index 96826857b416..9e8d068ff421 100644 --- a/data/reusables/security-overview/enterprise-filters-tip.md +++ b/data/reusables/security-overview/enterprise-filters-tip.md @@ -1,2 +1,2 @@ > [!TIP] -> You can use the `owner` filter in the search field to filter the data by organization. {% ifversion ghec %}If you're an owner of an {% data variables.enterprise.prodname_emu_enterprise %}, you can use the `owner-type` filter to filter the data by the type of repository owner, so that you can view data from either organization-owned repositories or user-owned repositories. {% endif %}For more information, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview#repository-owner-name-and-type-filters)." +> You can use the `owner` filter in the search field to filter the data by organization. {% ifversion ghec %}If you're an owner of an {% data variables.enterprise.prodname_emu_enterprise %}, you can use the `owner-type` filter to filter the data by the type of repository owner, so that you can view data from either organization-owned repositories or user-owned repositories. {% endif %}For more information, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview#repository-owner-name-and-type-filters). diff --git a/data/reusables/security-overview/filter-and-toggle.md b/data/reusables/security-overview/filter-and-toggle.md index 72a4d3991c2e..961ea62da1d9 100644 --- a/data/reusables/security-overview/filter-and-toggle.md +++ b/data/reusables/security-overview/filter-and-toggle.md @@ -7,5 +7,5 @@ {% endif %} {% ifversion security-overview-3-tab-dashboard %}{% else %} -1. For the alert trends graph at the top of the page, you can click **{% octicon "shield" aria-hidden="true" %} Open alerts** or **{% octicon "shield-x" aria-hidden="true" %} Closed alerts** to toggle between showing the trends for open or closed alerts. The toggle will only affect the alert trends graph. For more information, see "[Alert trends graph](#alert-trends-graph)." +1. For the alert trends graph at the top of the page, you can click **{% octicon "shield" aria-hidden="true" %} Open alerts** or **{% octicon "shield-x" aria-hidden="true" %} Closed alerts** to toggle between showing the trends for open or closed alerts. The toggle will only affect the alert trends graph. For more information, see [Alert trends graph](#alert-trends-graph). {% endif %} diff --git a/data/reusables/security-overview/filter-secret-scanning-metrics.md b/data/reusables/security-overview/filter-secret-scanning-metrics.md index 813b810b707b..252f6585829f 100644 --- a/data/reusables/security-overview/filter-secret-scanning-metrics.md +++ b/data/reusables/security-overview/filter-secret-scanning-metrics.md @@ -1,3 +1,3 @@ 1. You can use the options at the top of the page to filter the group of repositories that you want to see {% data variables.product.prodname_secret_scanning %} metrics for. * Use the date picker to set the time range that you want to view metrics for. Note that the date used by the date picker corresponds to the date a secret was bypassed on. - * Click in the search box to add further filters on the {% data variables.product.prodname_secret_scanning %} metrics displayed. For more information, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)." + * Click in the search box to add further filters on the {% data variables.product.prodname_secret_scanning %} metrics displayed. For more information, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview). diff --git a/data/reusables/security-overview/information-varies-GHAS.md b/data/reusables/security-overview/information-varies-GHAS.md index b9d2d67fe56d..396077af616f 100644 --- a/data/reusables/security-overview/information-varies-GHAS.md +++ b/data/reusables/security-overview/information-varies-GHAS.md @@ -1 +1 @@ -The information shown by security overview varies according to your access to repositories and organizations, and according to whether {% data variables.product.prodname_GH_advanced_security %} is used by those repositories and organizations. For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview#permission-to-view-data-in-security-overview)." +The information shown by security overview varies according to your access to repositories and organizations, and according to whether {% data variables.product.prodname_GH_advanced_security %} is used by those repositories and organizations. For more information, see [AUTOTITLE](/code-security/security-overview/about-security-overview#permission-to-view-data-in-security-overview). diff --git a/data/reusables/security-overview/security-information-about-actions.md b/data/reusables/security-overview/security-information-about-actions.md index 63bb4f75ecf6..6ea22b02855a 100644 --- a/data/reusables/security-overview/security-information-about-actions.md +++ b/data/reusables/security-overview/security-information-about-actions.md @@ -1 +1 @@ -If you use {% data variables.product.prodname_actions %}, you can use {% data variables.product.prodname_dotcom %}'s security features to increase the security of your workflows. For more information, see "[AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions)." +If you use {% data variables.product.prodname_actions %}, you can use {% data variables.product.prodname_dotcom %}'s security features to increase the security of your workflows. For more information, see [AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions). diff --git a/data/reusables/security-overview/settings-limitations.md b/data/reusables/security-overview/settings-limitations.md index 86ba27f1619a..d4a7f0c85f0a 100644 --- a/data/reusables/security-overview/settings-limitations.md +++ b/data/reusables/security-overview/settings-limitations.md @@ -2,7 +2,7 @@ > [!NOTE] > * Enabling {% data variables.product.prodname_code_scanning %} default setup _will not_ override any existing configurations of advanced setup for the selected repositories, but it _will_ override any existing configurations of default setup. -> * Enabling "Alerts" for {% data variables.product.prodname_secret_scanning %} enables {% ifversion secret-scanning-alert-experimental-list %}default{% else %}high confidence{% endif %} alerts. If you want to enable non-provider alerts, you need to edit the repository, organization, or enterprise settings. For more information about alert types, see "[Supported secrets](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." +> * Enabling "Alerts" for {% data variables.product.prodname_secret_scanning %} enables {% ifversion secret-scanning-alert-experimental-list %}default{% else %}high confidence{% endif %} alerts. If you want to enable non-provider alerts, you need to edit the repository, organization, or enterprise settings. For more information about alert types, see [Supported secrets](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets). {% elsif bulk-code-scanning-query-suite and not fpt %} diff --git a/data/reusables/security/note-securing-your-org.md b/data/reusables/security/note-securing-your-org.md index 21652afeb7a7..0a476d84341a 100644 --- a/data/reusables/security/note-securing-your-org.md +++ b/data/reusables/security/note-securing-your-org.md @@ -1 +1 @@ -For more information about enabling security features across an organization, see {% ifversion security-configurations %}"[AUTOTITLE](/code-security/securing-your-organization)."{% else %}"[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization)."{% endif %} +For more information about enabling security features across an organization, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization).{% else %}[AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization).{% endif %} diff --git a/data/reusables/shortdesc/authenticating_github_app.md b/data/reusables/shortdesc/authenticating_github_app.md index cf4967a3c760..beec810d01f0 100644 --- a/data/reusables/shortdesc/authenticating_github_app.md +++ b/data/reusables/shortdesc/authenticating_github_app.md @@ -1 +1 @@ -For information on how to authenticate as a GitHub App, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)." +For information on how to authenticate as a GitHub App, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app). diff --git a/data/reusables/sponsors/feedback.md b/data/reusables/sponsors/feedback.md index f361a00f6c94..861b6e4c7f3b 100644 --- a/data/reusables/sponsors/feedback.md +++ b/data/reusables/sponsors/feedback.md @@ -1 +1 @@ -You can share your feedback about {% data variables.product.prodname_sponsors %} with {% data variables.product.company_short %}. To join the conversation, see "[Sponsors Feedback](https://github.com/orgs/community/discussions/categories/sponsors)." +You can share your feedback about {% data variables.product.prodname_sponsors %} with {% data variables.product.company_short %}. To join the conversation, see [Sponsors Feedback](https://github.com/orgs/community/discussions/categories/sponsors). diff --git a/data/reusables/sponsors/legal-additional-terms.md b/data/reusables/sponsors/legal-additional-terms.md index 79e7153fcb35..85e5b3d8b8d9 100644 --- a/data/reusables/sponsors/legal-additional-terms.md +++ b/data/reusables/sponsors/legal-additional-terms.md @@ -1 +1 @@ -The {% data variables.product.prodname_matching_fund %} is a gift designed to encourage community funding of work on open source and is subject to additional terms and conditions. For detailed information about the {% data variables.product.prodname_matching_fund %}, see the "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-sponsors-additional-terms)." +The {% data variables.product.prodname_matching_fund %} is a gift designed to encourage community funding of work on open source and is subject to additional terms and conditions. For detailed information about the {% data variables.product.prodname_matching_fund %}, see the [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-sponsors-additional-terms). diff --git a/data/reusables/sponsors/manage-updates-for-orgs.md b/data/reusables/sponsors/manage-updates-for-orgs.md index 7628782c846e..913d0204651c 100644 --- a/data/reusables/sponsors/manage-updates-for-orgs.md +++ b/data/reusables/sponsors/manage-updates-for-orgs.md @@ -1 +1 @@ -You can designate which email address receives updates from the accounts your organization sponsors. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors)." +You can designate which email address receives updates from the accounts your organization sponsors. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors). diff --git a/data/reusables/sponsors/no-fees.md b/data/reusables/sponsors/no-fees.md index b16728241a5c..a2879c57f224 100644 --- a/data/reusables/sponsors/no-fees.md +++ b/data/reusables/sponsors/no-fees.md @@ -3,4 +3,4 @@ * 3% credit card processing fee * 3% {% data variables.product.company_short %} service processing fee -Organizations can save the 3% credit card processing fee by switching to invoiced billing for sponsorships. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice)." +Organizations can save the 3% credit card processing fee by switching to invoiced billing for sponsorships. For more information, see [AUTOTITLE](/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice). diff --git a/data/reusables/sponsors/payout-choice.md b/data/reusables/sponsors/payout-choice.md index de550db7de98..e6eebd1aa794 100644 --- a/data/reusables/sponsors/payout-choice.md +++ b/data/reusables/sponsors/payout-choice.md @@ -1,3 +1,3 @@ -1. Decide whether to receive sponsorship payouts via a bank account or through a fiscal host. For more information about setting up and using fiscal hosts, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts)." +1. Decide whether to receive sponsorship payouts via a bank account or through a fiscal host. For more information about setting up and using fiscal hosts, see [AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/using-a-fiscal-host-to-receive-github-sponsors-payouts). Note that you can only set up your fiscal host information at the time you sign up for {% data variables.product.prodname_sponsors %}. If you decide you want to switch to using a fiscal host after your profile has been set up, please contact us through the {% data variables.contact.contact_support_portal %}. diff --git a/data/reusables/sponsors/payout-info.md b/data/reusables/sponsors/payout-info.md index 581d2ef34fb7..0e20aaf11f49 100644 --- a/data/reusables/sponsors/payout-info.md +++ b/data/reusables/sponsors/payout-info.md @@ -1 +1 @@ -For information about timing for payments from {% data variables.product.prodname_sponsors %}, see "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-sponsors-additional-terms#43-payment-timing)." +For information about timing for payments from {% data variables.product.prodname_sponsors %}, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-sponsors-additional-terms#43-payment-timing). diff --git a/data/reusables/sponsors/sponsor-as-business.md b/data/reusables/sponsors/sponsor-as-business.md index efc9f841fb47..29a303c43bb7 100644 --- a/data/reusables/sponsors/sponsor-as-business.md +++ b/data/reusables/sponsors/sponsor-as-business.md @@ -1,4 +1,4 @@ -1. If you are sponsoring an account as a business, click **Yes**. Filling out the related fields will help your sponsored accounts calculate and pay taxes where appropriate. For more information, see "[Tax information for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors#sales-tax)." +1. If you are sponsoring an account as a business, click **Yes**. Filling out the related fields will help your sponsored accounts calculate and pay taxes where appropriate. For more information, see [Tax information for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors#sales-tax). * Select the "Country" dropdown menu, then click your business' country. * Next, select the "Region" dropdown menu and click your business' region within your country. * If applicable, click the "VAT number" text field, then type your value-added tax (VAT) identification number. diff --git a/data/reusables/sponsors/tier-details.md b/data/reusables/sponsors/tier-details.md index 6a0e5851c42d..39e6ffbf190e 100644 --- a/data/reusables/sponsors/tier-details.md +++ b/data/reusables/sponsors/tier-details.md @@ -6,7 +6,7 @@ You can customize the rewards for each tier. For example, rewards for a tier cou * Weekly newsletter updates * Other rewards your sponsors would enjoy ✨ -{% data reusables.sponsors.sponsors-only-repos %} For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)." +{% data reusables.sponsors.sponsors-only-repos %} For more information, see [AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier). You can include a welcome message with information about accessing or receiving rewards, which will be visible after payment and in the welcome email. diff --git a/data/reusables/ssh/add-public-key-to-github.md b/data/reusables/ssh/add-public-key-to-github.md index 644b59a7e049..1df775a08a95 100644 --- a/data/reusables/ssh/add-public-key-to-github.md +++ b/data/reusables/ssh/add-public-key-to-github.md @@ -1 +1 @@ -1. Add the SSH public key to your account on {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)." +1. Add the SSH public key to your account on {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). diff --git a/data/reusables/ssh/apple-use-keychain.md b/data/reusables/ssh/apple-use-keychain.md index fa630a7aa688..0930c400005a 100644 --- a/data/reusables/ssh/apple-use-keychain.md +++ b/data/reusables/ssh/apple-use-keychain.md @@ -3,6 +3,6 @@ > > The `--apple-use-keychain` option is in Apple's standard version of `ssh-add`. In macOS versions prior to Monterey (12.0), the `--apple-use-keychain` and `--apple-load-keychain` flags used the syntax `-K` and `-A`, respectively. > -> If you don't have Apple's standard version of `ssh-add` installed, you may receive an error. For more information, see "[AUTOTITLE](/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain)." +> If you don't have Apple's standard version of `ssh-add` installed, you may receive an error. For more information, see [AUTOTITLE](/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain). > > If you continue to be prompted for your passphrase, you may need to add the command to your `~/.zshrc` file (or your `~/.bashrc` file for bash). diff --git a/data/reusables/support/ask-and-answer-forum.md b/data/reusables/support/ask-and-answer-forum.md index 923b039be77d..6058a4a7bc5f 100644 --- a/data/reusables/support/ask-and-answer-forum.md +++ b/data/reusables/support/ask-and-answer-forum.md @@ -1 +1 @@ -You can connect with developers around the world to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. To get the conversation started, see "[{% data variables.product.prodname_gcf %}](https://github.com/orgs/community/discussions/)." +You can connect with developers around the world to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. To get the conversation started, see [{% data variables.product.prodname_gcf %}](https://github.com/orgs/community/discussions/). diff --git a/data/reusables/support/enterprise-comment-on-support-tickets.md b/data/reusables/support/enterprise-comment-on-support-tickets.md index c07ac5110468..86bbab54ca52 100644 --- a/data/reusables/support/enterprise-comment-on-support-tickets.md +++ b/data/reusables/support/enterprise-comment-on-support-tickets.md @@ -3,4 +3,4 @@ To comment on a ticket associated with your enterprise account that was opened b * An email address associated with your {% data variables.product.prodname_dotcom %} account is copied on the ticket * Your enterprise on {% data variables.product.prodname_ghe_cloud %} has a verified domain and the person who opened the ticket selected their verified-domain email -For more information about verifying a domain, see "[AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)" and "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." +For more information about verifying a domain, see [AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise) and [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization). diff --git a/data/reusables/support/entitlements-note.md b/data/reusables/support/entitlements-note.md index 0a29c64e1cbe..5e6fdcea118a 100644 --- a/data/reusables/support/entitlements-note.md +++ b/data/reusables/support/entitlements-note.md @@ -1,2 +1,2 @@ > [!NOTE] -> You must have an enterprise support entitlement to view tickets associated with an organization or enterprise account. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)." +> You must have an enterprise support entitlement to view tickets associated with an organization or enterprise account. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise). diff --git a/data/reusables/support/submit-a-ticket.md b/data/reusables/support/submit-a-ticket.md index d57348a1f966..cd3ef282be0c 100644 --- a/data/reusables/support/submit-a-ticket.md +++ b/data/reusables/support/submit-a-ticket.md @@ -9,8 +9,8 @@ 1. Select the **Select personal account, enterprise account or organization** dropdown menu and click the name of the account your support ticket is regarding. > [!NOTE] - > * For Premium, Premium Plus, or Engineering Direct support, you need to choose an enterprise account with a {% data variables.contact.premium_support %} plan. If you don't see an Enterprises section in the dropdown menu, you're not entitled to open support tickets on behalf of an enterprise account. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-support#about-support-entitlement)" - > * To see a list of your enterprise accounts with a {% data variables.contact.premium_support %} plan, you must be signed into the {% data variables.contact.enterprise_portal %}. For more information, see "[AUTOTITLE](/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal)." + > * For Premium, Premium Plus, or Engineering Direct support, you need to choose an enterprise account with a {% data variables.contact.premium_support %} plan. If you don't see an Enterprises section in the dropdown menu, you're not entitled to open support tickets on behalf of an enterprise account. For more information, see [AUTOTITLE](/support/learning-about-github-support/about-github-support#about-support-entitlement) + > * To see a list of your enterprise accounts with a {% data variables.contact.premium_support %} plan, you must be signed into the {% data variables.contact.enterprise_portal %}. For more information, see [AUTOTITLE](/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal). {% endif %} 1. Select the **From** dropdown menu and click the email address you'd like {% data variables.contact.github_support %} to contact. @@ -59,10 +59,10 @@ * Any special circumstances surrounding the discovery of the issue (for example, the first occurrence or occurrence after a specific event, frequency of occurrence, business impact of the problem, and suggested urgency) * Exact wording of error messages - You can attach files up to 50MB.{% ifversion ghes %} For larger attachments, such as support bundles, see "[AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)."{% endif %} + You can attach files up to 50MB.{% ifversion ghes %} For larger attachments, such as support bundles, see [AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles).{% endif %} > [!WARNING] - > When you upload an image or video to a pull request or issue comment, or upload a file to a ticket in the {% data variables.contact.landing_page_portal %}, anyone can view the anonymized URL without authentication, even if the pull request or issue is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. To keep sensitive media files private, serve them from a private network or server that requires authentication. {% ifversion fpt or ghec %}For more information on anonymized URLs see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-anonymized-urls)."{% endif %} + > When you upload an image or video to a pull request or issue comment, or upload a file to a ticket in the {% data variables.contact.landing_page_portal %}, anyone can view the anonymized URL without authentication, even if the pull request or issue is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. To keep sensitive media files private, serve them from a private network or server that requires authentication. {% ifversion fpt or ghec %}For more information on anonymized URLs see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-anonymized-urls).{% endif %} {%- ifversion ghes %} 1. Optionally, attach diagnostics files and other files by dragging and dropping, uploading, or pasting from the clipboard. diff --git a/data/reusables/support/support-ticket-translation-option.md b/data/reusables/support/support-ticket-translation-option.md index 1ef9cf75c9ec..4c25dfa9ceb6 100644 --- a/data/reusables/support/support-ticket-translation-option.md +++ b/data/reusables/support/support-ticket-translation-option.md @@ -1 +1 @@ -You can translate English comments on a ticket into Chinese (Simplified), French, German, Japanese, Portuguese (Brazil), or Spanish. However, when responding to tickets, you should use English, unless your {% data variables.product.prodname_dotcom %} plan permits you to respond in Japanese. For more information, see "[AUTOTITLE](/support/contacting-github-support/viewing-and-updating-support-tickets)." +You can translate English comments on a ticket into Chinese (Simplified), French, German, Japanese, Portuguese (Brazil), or Spanish. However, when responding to tickets, you should use English, unless your {% data variables.product.prodname_dotcom %} plan permits you to respond in Japanese. For more information, see [AUTOTITLE](/support/contacting-github-support/viewing-and-updating-support-tickets). diff --git a/data/reusables/two_fa/after-2fa-add-security-key.md b/data/reusables/two_fa/after-2fa-add-security-key.md index fabb671a9d2c..f2b19abf7f82 100644 --- a/data/reusables/two_fa/after-2fa-add-security-key.md +++ b/data/reusables/two_fa/after-2fa-add-security-key.md @@ -1 +1 @@ -After you configure 2FA, using a time-based one-time password (TOTP) mobile app{% ifversion fpt or ghec %}, or via text message{% endif %}, you can add a security key, like a FIDO2 hardware security key, Apple Touch ID or Windows Hello. The technology that enables authentication with a security key is called WebAuthn. WebAuthn is the successor to U2F and works in all modern browsers. For more information, see "[WebAuthn](https://webauthn.guide/)" and "[Can I Use](https://caniuse.com/#search=webauthn)." +After you configure 2FA, using a time-based one-time password (TOTP) mobile app{% ifversion fpt or ghec %}, or via text message{% endif %}, you can add a security key, like a FIDO2 hardware security key, Apple Touch ID or Windows Hello. The technology that enables authentication with a security key is called WebAuthn. WebAuthn is the successor to U2F and works in all modern browsers. For more information, see [WebAuthn](https://webauthn.guide/) and [Can I Use](https://caniuse.com/#search=webauthn). diff --git a/data/reusables/two_fa/backup_options_during_2fa_enrollment.md b/data/reusables/two_fa/backup_options_during_2fa_enrollment.md index 4f859c5b0e5c..9a5de682aea2 100644 --- a/data/reusables/two_fa/backup_options_during_2fa_enrollment.md +++ b/data/reusables/two_fa/backup_options_during_2fa_enrollment.md @@ -1 +1 @@ -1. Optionally, you can configure additional 2FA methods to reduce your risk of account lockout. For more details on how to configure each additional method, see "[Configuring two-factor authentication using a security key](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)"{% ifversion fpt or ghec %} and "[Configuring two-factor authentication using {% data variables.product.prodname_mobile %}](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-github-mobile)."{% endif %} +1. Optionally, you can configure additional 2FA methods to reduce your risk of account lockout. For more details on how to configure each additional method, see [Configuring two-factor authentication using a security key](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key){% ifversion fpt or ghec %} and [Configuring two-factor authentication using {% data variables.product.prodname_mobile %}](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-github-mobile).{% endif %} diff --git a/data/reusables/two_fa/ghes_ntp.md b/data/reusables/two_fa/ghes_ntp.md index 0ff685c247f7..4ae17c1109a1 100644 --- a/data/reusables/two_fa/ghes_ntp.md +++ b/data/reusables/two_fa/ghes_ntp.md @@ -1 +1 @@ -{% ifversion ghes %}The verification of two-factor authentication codes requires an accurate time on both the client's device and server. Site administrators should ensure time synchronization is configured and accurate. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-time-synchronization)."{% endif %} +{% ifversion ghes %}The verification of two-factor authentication codes requires an accurate time on both the client's device and server. Site administrators should ensure time synchronization is configured and accurate. For more information, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-time-synchronization).{% endif %} diff --git a/data/reusables/two_fa/sms-warning.md b/data/reusables/two_fa/sms-warning.md index a1f9ae80048a..ce00d5d52583 100644 --- a/data/reusables/two_fa/sms-warning.md +++ b/data/reusables/two_fa/sms-warning.md @@ -1,4 +1,4 @@ Before using this method, be sure that you can receive text messages. Carrier rates may apply. > [!WARNING] -> We **strongly recommend** using a TOTP application for two-factor authentication instead of SMS, and security keys as backup methods instead of SMS. {% data variables.product.product_name %} doesn't support sending SMS messages to phones in every country. Before configuring authentication via text message, review the list of countries where {% data variables.product.product_name %} supports authentication via SMS. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported)." +> We **strongly recommend** using a TOTP application for two-factor authentication instead of SMS, and security keys as backup methods instead of SMS. {% data variables.product.product_name %} doesn't support sending SMS messages to phones in every country. Before configuring authentication via text message, review the list of countries where {% data variables.product.product_name %} supports authentication via SMS. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported). diff --git a/data/reusables/two_fa/unlink-email-address.md b/data/reusables/two_fa/unlink-email-address.md index b09f2e507357..13c528b6b657 100644 --- a/data/reusables/two_fa/unlink-email-address.md +++ b/data/reusables/two_fa/unlink-email-address.md @@ -1 +1 @@ -If you cannot use any recovery methods, you have permanently lost access to your account. However, you can unlink an email address tied to the locked account. The unlinked email address can then be linked to a new or existing account. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account)." +If you cannot use any recovery methods, you have permanently lost access to your account. However, you can unlink an email address tied to the locked account. The unlinked email address can then be linked to a new or existing account. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account). diff --git a/data/reusables/user-settings/about-commit-email-addresses.md b/data/reusables/user-settings/about-commit-email-addresses.md index 956a7e316a92..d1e02d844052 100644 --- a/data/reusables/user-settings/about-commit-email-addresses.md +++ b/data/reusables/user-settings/about-commit-email-addresses.md @@ -1 +1 @@ -For more information on commit email addresses,{% ifversion fpt or ghec %} including your `noreply` email address for {% data variables.product.product_name %},{% endif %} see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)." +For more information on commit email addresses,{% ifversion fpt or ghec %} including your `noreply` email address for {% data variables.product.product_name %},{% endif %} see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address). diff --git a/data/reusables/user-settings/context_switcher.md b/data/reusables/user-settings/context_switcher.md index cb722803a32b..e1daeffab4c2 100644 --- a/data/reusables/user-settings/context_switcher.md +++ b/data/reusables/user-settings/context_switcher.md @@ -1 +1 @@ -You must manage billing settings and paid features for each of your accounts separately. You can switch between settings for your personal account, organization accounts, and enterprise accounts using the context switcher on each settings page. See "[AUTOTITLE](/billing/using-the-billing-platform/about-billing-on-github#switching-between-settings-for-your-different-accounts)." +You must manage billing settings and paid features for each of your accounts separately. You can switch between settings for your personal account, organization accounts, and enterprise accounts using the context switcher on each settings page. See [AUTOTITLE](/billing/using-the-billing-platform/about-billing-on-github#switching-between-settings-for-your-different-accounts). diff --git a/data/reusables/user-settings/enabling-fixed-width-fonts.md b/data/reusables/user-settings/enabling-fixed-width-fonts.md index 8a641f49d461..bcd0555fc663 100644 --- a/data/reusables/user-settings/enabling-fixed-width-fonts.md +++ b/data/reusables/user-settings/enabling-fixed-width-fonts.md @@ -1,5 +1,5 @@ {% ifversion fixed-width-font-gfm-fields %} -If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor)." +If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor). {% endif %} diff --git a/data/reusables/user-settings/link_email_with_your_account.md b/data/reusables/user-settings/link_email_with_your_account.md index 491fdb03bc51..cf3ee0d5cb02 100644 --- a/data/reusables/user-settings/link_email_with_your_account.md +++ b/data/reusables/user-settings/link_email_with_your_account.md @@ -1 +1 @@ -Add the email address to your account on {% data variables.product.product_name %}, so that your commits are attributed to you and appear in your contributions graph. 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)." +Add the email address to your account on {% data variables.product.product_name %}, so that your commits are attributed to you and appear in your contributions graph. 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). diff --git a/data/reusables/user-settings/no-verification-disposable-emails.md b/data/reusables/user-settings/no-verification-disposable-emails.md index 687a0bef6ab3..584cf640713a 100644 --- a/data/reusables/user-settings/no-verification-disposable-emails.md +++ b/data/reusables/user-settings/no-verification-disposable-emails.md @@ -1 +1 @@ -You cannot verify email addresses from disposable email address services (services that allow you to receive email at a temporary address that expires after a certain time). If you'd like to keep your email address private, you can use a {% data variables.product.prodname_dotcom %}-provided `noreply` email address. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-on-github)." +You cannot verify email addresses from disposable email address services (services that allow you to receive email at a temporary address that expires after a certain time). If you'd like to keep your email address private, you can use a {% data variables.product.prodname_dotcom %}-provided `noreply` email address. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-on-github). diff --git a/data/reusables/user-settings/password-authentication-deprecation.md b/data/reusables/user-settings/password-authentication-deprecation.md index 0f57fc8b51d0..055b57f67113 100644 --- a/data/reusables/user-settings/password-authentication-deprecation.md +++ b/data/reusables/user-settings/password-authentication-deprecation.md @@ -1 +1 @@ -When Git prompts you for your password, enter your {% data variables.product.pat_generic %}. Alternatively, you can use a credential helper like [Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager/blob/main/README.md). Password-based authentication for Git has been removed in favor of more secure authentication methods. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." +When Git prompts you for your password, enter your {% data variables.product.pat_generic %}. Alternatively, you can use a credential helper like [Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager/blob/main/README.md). Password-based authentication for Git has been removed in favor of more secure authentication methods. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). diff --git a/data/reusables/user-settings/patv2-limitations.md b/data/reusables/user-settings/patv2-limitations.md index e64a0e6bc9b7..bb2532b82fb2 100644 --- a/data/reusables/user-settings/patv2-limitations.md +++ b/data/reusables/user-settings/patv2-limitations.md @@ -4,4 +4,4 @@ * Only {% data variables.product.pat_v1_plural %} automatically have write access for internal repositories that are owned by your enterprise. {% data variables.product.pat_v2_caps %}s must be granted access to internal repositories.{% endif %} * Outside collaborators can only use {% data variables.product.pat_v1_plural %} to access organization repositories that they are a collaborator on.{% ifversion ghec or ghes %} * Only {% data variables.product.pat_v1_plural %} can access enterprises. ({% data variables.product.pat_v2_caps %} can access organizations owned by enterprises.){% endif %} -* A few REST API endpoints are only available with a {% data variables.product.pat_v1_plural %}. To check whether an endpoint also supports {% data variables.product.pat_v2 %}s, see the documentation for that endpoint, or see "[AUTOTITLE](/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens)." +* A few REST API endpoints are only available with a {% data variables.product.pat_v1_plural %}. To check whether an endpoint also supports {% data variables.product.pat_v2 %}s, see the documentation for that endpoint, or see [AUTOTITLE](/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens). diff --git a/data/reusables/user-settings/review_oauth_tokens_tip.md b/data/reusables/user-settings/review_oauth_tokens_tip.md index c4ae4e507cbc..60c11ce92074 100644 --- a/data/reusables/user-settings/review_oauth_tokens_tip.md +++ b/data/reusables/user-settings/review_oauth_tokens_tip.md @@ -1 +1 @@ -We recommend that you regularly review your authorized integrations. Remove any applications and tokens that haven't been used in a while. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/reviewing-your-authorized-applications-oauth)." +We recommend that you regularly review your authorized integrations. Remove any applications and tokens that haven't been used in a while. For more information, see [AUTOTITLE](/apps/oauth-apps/using-oauth-apps/reviewing-your-authorized-applications-oauth). diff --git a/data/reusables/user-settings/sudo-mode-popup.md b/data/reusables/user-settings/sudo-mode-popup.md index b36b47448ce5..da6beaba005d 100644 --- a/data/reusables/user-settings/sudo-mode-popup.md +++ b/data/reusables/user-settings/sudo-mode-popup.md @@ -1 +1 @@ -1. If prompted, confirm access to your account on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/sudo-mode)." +1. If prompted, confirm access to your account on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/sudo-mode). diff --git a/data/reusables/user-settings/verify-org-approved-email-domain.md b/data/reusables/user-settings/verify-org-approved-email-domain.md index fa4bac197760..1dd11924d4d0 100644 --- a/data/reusables/user-settings/verify-org-approved-email-domain.md +++ b/data/reusables/user-settings/verify-org-approved-email-domain.md @@ -1 +1 @@ -If an organization you're a member of restricts email notifications to an approved email domain, you'll need to verify an email address in that domain to receive email notifications about activity in the organization. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization)." +If an organization you're a member of restricts email notifications to an approved email domain, you'll need to verify an email address in that domain to receive email notifications about activity in the organization. For more information, see [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization). diff --git a/data/reusables/webhooks/commit_comment_short_desc.md b/data/reusables/webhooks/commit_comment_short_desc.md index 934d56572da2..7b73f7be3328 100644 --- a/data/reusables/webhooks/commit_comment_short_desc.md +++ b/data/reusables/webhooks/commit_comment_short_desc.md @@ -1 +1 @@ -A commit comment is created. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/commits/comments)." +A commit comment is created. {% data reusables.webhooks.action_type_desc %} For more information, see [AUTOTITLE](/rest/commits/comments). diff --git a/data/reusables/webhooks/content_type_and_secret.md b/data/reusables/webhooks/content_type_and_secret.md index 44d3004ec437..8874fa023778 100644 --- a/data/reusables/webhooks/content_type_and_secret.md +++ b/data/reusables/webhooks/content_type_and_secret.md @@ -1,4 +1,4 @@ 1. Optionally, select the **Content type** drop-down menu, and click a data format to receive the webhook payload in. * **application/json** will deliver the JSON payload directly as the body of the `POST` request. * **application/x-www-form-urlencoded** will send the JSON payload as a form parameter called `payload`. -1. Optionally, under "Secret", type a string to use as a `secret` key. You should choose a random string of text with high entropy. You can use the webhook secret to limit incoming requests to only those originating from {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks)." +1. Optionally, under "Secret", type a string to use as a `secret` key. You should choose a random string of text with high entropy. You can use the webhook secret to limit incoming requests to only those originating from {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks). diff --git a/data/reusables/webhooks/create_short_desc.md b/data/reusables/webhooks/create_short_desc.md index 2ad4e5009e44..9d0ff086250a 100644 --- a/data/reusables/webhooks/create_short_desc.md +++ b/data/reusables/webhooks/create_short_desc.md @@ -1 +1 @@ -A Git branch or tag is created. For more information, see "[AUTOTITLE](/rest/git#create-a-reference)." +A Git branch or tag is created. For more information, see [AUTOTITLE](/rest/git#create-a-reference). diff --git a/data/reusables/webhooks/delete_short_desc.md b/data/reusables/webhooks/delete_short_desc.md index c3e310817930..87db31da3c6d 100644 --- a/data/reusables/webhooks/delete_short_desc.md +++ b/data/reusables/webhooks/delete_short_desc.md @@ -1 +1 @@ -A Git branch or tag is deleted. For more information, see the "[AUTOTITLE](/rest/git#delete-a-reference)" REST API. +A Git branch or tag is deleted. For more information, see the [AUTOTITLE](/rest/git#delete-a-reference) REST API. diff --git a/data/reusables/webhooks/fork_short_desc.md b/data/reusables/webhooks/fork_short_desc.md index bf72500c2b3d..fb7cfe4209ca 100644 --- a/data/reusables/webhooks/fork_short_desc.md +++ b/data/reusables/webhooks/fork_short_desc.md @@ -1 +1 @@ -A user forks a repository. For more information, see "[AUTOTITLE](/rest/repos#forks)." +A user forks a repository. For more information, see [AUTOTITLE](/rest/repos#forks). diff --git a/data/reusables/webhooks/gollum_short_desc.md b/data/reusables/webhooks/gollum_short_desc.md index de44fc9c3d43..96d59511ff9d 100644 --- a/data/reusables/webhooks/gollum_short_desc.md +++ b/data/reusables/webhooks/gollum_short_desc.md @@ -1 +1 @@ -A wiki page is created or updated. For more information, see "[AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis)." +A wiki page is created or updated. For more information, see [AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis). diff --git a/data/reusables/webhooks/issue_comment_short_desc.md b/data/reusables/webhooks/issue_comment_short_desc.md index 6fac504acd13..5aaca54014a1 100644 --- a/data/reusables/webhooks/issue_comment_short_desc.md +++ b/data/reusables/webhooks/issue_comment_short_desc.md @@ -1 +1 @@ -Activity related to an issue or pull request comment. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/issues#comments)." +Activity related to an issue or pull request comment. {% data reusables.webhooks.action_type_desc %} For more information, see the [AUTOTITLE](/rest/issues#comments). diff --git a/data/reusables/webhooks/issues_short_desc.md b/data/reusables/webhooks/issues_short_desc.md index 05950ca16854..dc8c03ee7b72 100644 --- a/data/reusables/webhooks/issues_short_desc.md +++ b/data/reusables/webhooks/issues_short_desc.md @@ -1 +1 @@ -Activity related to an issue. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/issues)." +Activity related to an issue. {% data reusables.webhooks.action_type_desc %} For more information, see the [AUTOTITLE](/rest/issues). diff --git a/data/reusables/webhooks/member_short_desc.md b/data/reusables/webhooks/member_short_desc.md index 8ab0fa01981f..142b64763459 100644 --- a/data/reusables/webhooks/member_short_desc.md +++ b/data/reusables/webhooks/member_short_desc.md @@ -1 +1 @@ -Activity related to repository collaborators. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/collaborators/collaborators)." +Activity related to repository collaborators. {% data reusables.webhooks.action_type_desc %} For more information, see [AUTOTITLE](/rest/collaborators/collaborators). diff --git a/data/reusables/webhooks/pull_request_review_comment_short_desc.md b/data/reusables/webhooks/pull_request_review_comment_short_desc.md index 9dcaf2c993bd..1f4e6d3a1926 100644 --- a/data/reusables/webhooks/pull_request_review_comment_short_desc.md +++ b/data/reusables/webhooks/pull_request_review_comment_short_desc.md @@ -1 +1 @@ -Activity related to pull request review comments in the pull request's unified diff. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/pulls#comments)." +Activity related to pull request review comments in the pull request's unified diff. {% data reusables.webhooks.action_type_desc %} For more information, see [AUTOTITLE](/rest/pulls#comments). diff --git a/data/reusables/webhooks/pull_request_review_short_desc.md b/data/reusables/webhooks/pull_request_review_short_desc.md index c2047a187a31..e814e93e851e 100644 --- a/data/reusables/webhooks/pull_request_review_short_desc.md +++ b/data/reusables/webhooks/pull_request_review_short_desc.md @@ -1 +1 @@ -Activity related to pull request reviews. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/pulls#reviews)." +Activity related to pull request reviews. {% data reusables.webhooks.action_type_desc %} For more information, see [AUTOTITLE](/rest/pulls#reviews). diff --git a/data/reusables/webhooks/pull_request_short_desc.md b/data/reusables/webhooks/pull_request_short_desc.md index c3c12fc45860..bb9dda0e4997 100644 --- a/data/reusables/webhooks/pull_request_short_desc.md +++ b/data/reusables/webhooks/pull_request_short_desc.md @@ -1 +1 @@ -Activity related to pull requests. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/pulls)." +Activity related to pull requests. {% data reusables.webhooks.action_type_desc %} For more information, see [AUTOTITLE](/rest/pulls). diff --git a/data/reusables/webhooks/release_short_desc.md b/data/reusables/webhooks/release_short_desc.md index 60502ba9019c..e3f8945738e0 100644 --- a/data/reusables/webhooks/release_short_desc.md +++ b/data/reusables/webhooks/release_short_desc.md @@ -1 +1 @@ -Activity related to a release. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/releases)" REST API. +Activity related to a release. {% data reusables.webhooks.action_type_desc %} For more information, see the [AUTOTITLE](/rest/releases) REST API. diff --git a/data/reusables/webhooks/secret.md b/data/reusables/webhooks/secret.md index f581dfb01f89..6edd53e6f5bb 100644 --- a/data/reusables/webhooks/secret.md +++ b/data/reusables/webhooks/secret.md @@ -1 +1 @@ -Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the `X-Hub-Signature` and `X-Hub-Signature-256` headers in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[AUTOTITLE](/webhooks-and-events/webhooks/securing-your-webhooks)." +Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the `X-Hub-Signature` and `X-Hub-Signature-256` headers in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see [AUTOTITLE](/webhooks-and-events/webhooks/securing-your-webhooks). diff --git a/data/reusables/webhooks/signature-troubleshooting.md b/data/reusables/webhooks/signature-troubleshooting.md index 6cc4dbbbd745..259300181fed 100644 --- a/data/reusables/webhooks/signature-troubleshooting.md +++ b/data/reusables/webhooks/signature-troubleshooting.md @@ -1,8 +1,8 @@ If you are sure that the payload is from {% data variables.product.company_short %} but the signature verification fails: -* Make sure that you have configured a secret for your webhook. The `X-Hub-Signature-256` header will not be present if you have not configured a secret for your webhook. For more information about configuring a secret for your webhook, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." +* Make sure that you have configured a secret for your webhook. The `X-Hub-Signature-256` header will not be present if you have not configured a secret for your webhook. For more information about configuring a secret for your webhook, see [AUTOTITLE](/webhooks/using-webhooks/editing-webhooks). * Make sure you are using the correct header. {% data variables.product.company_short %} recommends that you use the `X-Hub-Signature-256` header, which uses the HMAC-SHA256 algorithm. The `X-Hub-Signature` header uses the HMAC-SHA1 algorithm and is only included for legacy purposes. * Make sure that you are using the correct algorithm. If you are using the `X-Hub-Signature-256` header, you should use the HMAC-SHA256 algorithm. -* Make sure you are using the correct webhook secret. If you don't know the value of your webhook secret, you can update your webhook's secret. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." +* Make sure you are using the correct webhook secret. If you don't know the value of your webhook secret, you can update your webhook's secret. For more information, see [AUTOTITLE](/webhooks/using-webhooks/editing-webhooks). * Make sure that the payload and headers are not modified before verification. For example, if you use a proxy or load balancer, make sure that the proxy or load balancer does not modify the payload or headers. * If your language and server implementation specifies a character encoding, ensure that you handle the payload as UTF-8. Webhook payloads can contain unicode characters. diff --git a/data/reusables/webhooks/sponsorship_short_desc.md b/data/reusables/webhooks/sponsorship_short_desc.md index f23c71e98b76..d8c74695df85 100644 --- a/data/reusables/webhooks/sponsorship_short_desc.md +++ b/data/reusables/webhooks/sponsorship_short_desc.md @@ -1 +1 @@ -Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)". +Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see [AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors). diff --git a/data/reusables/webhooks/watch_short_desc.md b/data/reusables/webhooks/watch_short_desc.md index 19cb6e0bed21..c833bc57eb0c 100644 --- a/data/reusables/webhooks/watch_short_desc.md +++ b/data/reusables/webhooks/watch_short_desc.md @@ -1 +1 @@ -When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/activity#starring)." +When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see [AUTOTITLE](/rest/activity#starring). diff --git a/data/reusables/webhooks/webhooks-as-audit-log-alternative.md b/data/reusables/webhooks/webhooks-as-audit-log-alternative.md index 83e1754e71d5..b86179721518 100644 --- a/data/reusables/webhooks/webhooks-as-audit-log-alternative.md +++ b/data/reusables/webhooks/webhooks-as-audit-log-alternative.md @@ -1 +1 @@ -Webhooks might be a good alternative to the audit log or API polling for certain use cases. Webhooks are a way for {% data variables.product.company_short %} to notify your server when specific events occur for a repository, organization, or enterprise. Compared to the API or searching the audit log, webhooks can be more efficient if you just want to learn and possibly log when certain events occur on your enterprise, organization, or repository. See "[AUTOTITLE](/webhooks)." +Webhooks might be a good alternative to the audit log or API polling for certain use cases. Webhooks are a way for {% data variables.product.company_short %} to notify your server when specific events occur for a repository, organization, or enterprise. Compared to the API or searching the audit log, webhooks can be more efficient if you just want to learn and possibly log when certain events occur on your enterprise, organization, or repository. See [AUTOTITLE](/webhooks).