From 95d266b96e3859028273ddb229dc20cb9ecb96ad Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 13 Jan 2025 08:40:37 -0800 Subject: [PATCH 1/2] GraphQL schema update (#53877) Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com> --- src/graphql/data/fpt/changelog.json | 14 ++++++++ src/graphql/data/fpt/schema.docs.graphql | 36 +++++++++++++++++++++ src/graphql/data/fpt/schema.json | 39 +++++++++++++++++++++++ src/graphql/data/ghec/schema.docs.graphql | 36 +++++++++++++++++++++ src/graphql/data/ghec/schema.json | 39 +++++++++++++++++++++++ 5 files changed, 164 insertions(+) diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index 5c91b41196f6..b9f18e8c3c61 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,18 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Type CopilotLicenseType was added

", + "

Field copilotLicenseType was added to object type User

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2025-01-13" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index 67382fce723d..0605be039ea8 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -6979,6 +6979,36 @@ type CopilotEndpoints { telemetry: String! } +""" +Indicates the type of access a user has to GitHub Copilot +""" +enum CopilotLicenseType @requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"]) { + """ + Business access + """ + COPILOT_BUSINESS + + """ + Enterprise access + """ + COPILOT_ENTERPRISE + + """ + Limited free access + """ + COPILOT_FREE + + """ + Individual access + """ + COPILOT_INDIVIDUAL + + """ + No access found + """ + NO_ACCESS +} + """ The type of the activity that was performed. """ @@ -63233,6 +63263,12 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ copilotEndpoints: CopilotEndpoints + """ + The user's license type for Copilot + """ + copilotLicenseType: CopilotLicenseType + @requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"]) + """ Properties of the current Copilot user, if limited by Copilot Free. """ diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index 37846aa85d10..3732d42aaf8d 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -76727,6 +76727,15 @@ "kind": "objects", "href": "/graphql/reference/objects#copilotendpoints" }, + { + "name": "copilotLicenseType", + "description": "

The user's license type for Copilot.

", + "type": "CopilotLicenseType", + "id": "copilotlicensetype", + "kind": "enums", + "href": "/graphql/reference/enums#copilotlicensetype", + "isDeprecated": false + }, { "name": "copilotLimitedUser", "description": "

Properties of the current Copilot user, if limited by Copilot Free.

", @@ -85740,6 +85749,36 @@ } ] }, + { + "name": "CopilotLicenseType", + "kind": "enums", + "id": "copilotlicensetype", + "href": "/graphql/reference/enums#copilotlicensetype", + "description": "

Indicates the type of access a user has to GitHub Copilot.

", + "isDeprecated": false, + "values": [ + { + "name": "COPILOT_BUSINESS", + "description": "

Business access.

" + }, + { + "name": "COPILOT_ENTERPRISE", + "description": "

Enterprise access.

" + }, + { + "name": "COPILOT_FREE", + "description": "

Limited free access.

" + }, + { + "name": "COPILOT_INDIVIDUAL", + "description": "

Individual access.

" + }, + { + "name": "NO_ACCESS", + "description": "

No access found.

" + } + ] + }, { "name": "CopilotLimitedFeature", "kind": "enums", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index 67382fce723d..0605be039ea8 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -6979,6 +6979,36 @@ type CopilotEndpoints { telemetry: String! } +""" +Indicates the type of access a user has to GitHub Copilot +""" +enum CopilotLicenseType @requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"]) { + """ + Business access + """ + COPILOT_BUSINESS + + """ + Enterprise access + """ + COPILOT_ENTERPRISE + + """ + Limited free access + """ + COPILOT_FREE + + """ + Individual access + """ + COPILOT_INDIVIDUAL + + """ + No access found + """ + NO_ACCESS +} + """ The type of the activity that was performed. """ @@ -63233,6 +63263,12 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ copilotEndpoints: CopilotEndpoints + """ + The user's license type for Copilot + """ + copilotLicenseType: CopilotLicenseType + @requiredCapabilities(requiredCapabilities: ["access_copilot_limited_graphql_api"]) + """ Properties of the current Copilot user, if limited by Copilot Free. """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 37846aa85d10..3732d42aaf8d 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -76727,6 +76727,15 @@ "kind": "objects", "href": "/graphql/reference/objects#copilotendpoints" }, + { + "name": "copilotLicenseType", + "description": "

The user's license type for Copilot.

", + "type": "CopilotLicenseType", + "id": "copilotlicensetype", + "kind": "enums", + "href": "/graphql/reference/enums#copilotlicensetype", + "isDeprecated": false + }, { "name": "copilotLimitedUser", "description": "

Properties of the current Copilot user, if limited by Copilot Free.

", @@ -85740,6 +85749,36 @@ } ] }, + { + "name": "CopilotLicenseType", + "kind": "enums", + "id": "copilotlicensetype", + "href": "/graphql/reference/enums#copilotlicensetype", + "description": "

Indicates the type of access a user has to GitHub Copilot.

", + "isDeprecated": false, + "values": [ + { + "name": "COPILOT_BUSINESS", + "description": "

Business access.

" + }, + { + "name": "COPILOT_ENTERPRISE", + "description": "

Enterprise access.

" + }, + { + "name": "COPILOT_FREE", + "description": "

Limited free access.

" + }, + { + "name": "COPILOT_INDIVIDUAL", + "description": "

Individual access.

" + }, + { + "name": "NO_ACCESS", + "description": "

No access found.

" + } + ] + }, { "name": "CopilotLimitedFeature", "kind": "enums", From 7d5aca1efa469f9eb0f3ba472ddb6ffea16d74d2 Mon Sep 17 00:00:00 2001 From: Ashish Keshan Date: Mon, 13 Jan 2025 13:11:04 -0500 Subject: [PATCH 2/2] Get remaining quotes from md files (#53858) Co-authored-by: Felicity Chapman --- README.md | 4 ++-- content/README.md | 10 +++++----- .../best-practices-for-leaving-your-company.md | 2 +- .../managing-multiple-accounts.md | 2 +- .../about-self-hosted-runners.md | 2 +- .../managing-environments-for-deployment.md | 2 +- .../configuring-email-for-notifications.md | 4 ++-- .../enforcing-policies-for-code-governance.md | 2 +- .../creating-a-pre-receive-hook-script.md | 2 +- ...troubleshooting-resource-allocation-problems.md | 2 +- .../making-a-github-app-public-or-private.md | 2 +- ...a-github-app-that-responds-to-webhook-events.md | 2 +- ...naging-allowed-ip-addresses-for-a-github-app.md | 4 ++-- .../about-per-user-pricing.md | 4 ++-- ...iption-and-usage-for-your-enterprise-account.md | 2 +- .../about-licenses-for-github-enterprise.md | 4 ++-- ...nterprise-server-and-github-enterprise-cloud.md | 4 ++-- .../about-billing-for-your-enterprise.md | 6 +++--- .../kotlin-detected-in-no-build.md | 2 +- .../publishing-and-using-codeql-packs.md | 4 ++-- ...defining-custom-patterns-for-secret-scanning.md | 2 +- ...ic-dependency-submission-for-your-repository.md | 6 +++--- ...ling-github-codespaces-for-your-organization.md | 2 +- .../contents-of-a-github-docs-article.md | 2 +- .../style-guide-and-content-model/style-guide.md | 4 ++-- .../writing-for-github-docs/templates.md | 8 ++++---- .../using-markdown-and-liquid-in-github-docs.md | 2 +- .../writing-content-to-be-translated.md | 2 +- .../learning-about-github/githubs-plans.md | 6 +++--- content/get-started/using-github/github-mobile.md | 2 +- ...ur-migration-with-github-enterprise-importer.md | 2 +- ...enterprise-server-to-github-enterprise-cloud.md | 2 +- ...permissions-for-adding-outside-collaborators.md | 2 +- ...ganization-member-to-an-outside-collaborator.md | 2 +- .../about-github-pages.md | 2 +- .../about-searching-on-github.md | 2 +- .../searching-for-repositories.md | 2 +- ...g-failed-deliveries-for-a-github-app-webhook.md | 8 ++++---- ...g-failed-deliveries-for-a-repository-webhook.md | 8 ++++---- ...ailed-deliveries-for-an-organization-webhook.md | 8 ++++---- .../using-webhooks/handling-webhook-deliveries.md | 14 +++++++------- contributing/README.md | 2 +- contributing/code-annotations.md | 2 +- contributing/codespace.md | 2 +- contributing/content-markup-reference.md | 2 +- contributing/content-model.md | 2 +- contributing/content-style-guide.md | 2 +- contributing/content-templates.md | 2 +- contributing/development.md | 2 +- contributing/how-to-use-labels.md | 2 +- contributing/images-and-versioning.md | 2 +- contributing/liquid-helpers.md | 2 +- contributing/redirects.md | 2 +- contributing/self-review.md | 2 +- contributing/tool-switcher.md | 2 +- contributing/translations-for-writers.md | 2 +- contributing/troubleshooting.md | 2 +- contributing/videos.md | 2 +- .../actions/actions-use-policy-settings.md | 2 +- data/reusables/actions/viewing-actions-metrics.md | 2 +- .../workflow-basic-example-and-explanation.md | 6 +++--- data/reusables/actions/workflow-dispatch-inputs.md | 2 +- .../dependabot/access-private-dependencies-link.md | 2 +- .../dependabot/dependabot-ignore-dependencies.md | 2 +- .../dependabot/supported-package-managers.md | 2 +- .../blob-storage-management-console.md | 4 ++-- .../enterprise/azure-maps-auth-deprecation-link.md | 2 +- data/reusables/enterprise/enterprise-types.md | 2 +- .../enterprise_installation/ssh-into-instance.md | 2 +- .../ssh-into-target-instance.md | 2 +- .../gated-features/enterprise-accounts.md | 2 +- .../organizations/team-synchronization.md | 2 +- .../package_registry/publish-docker-image.md | 4 ++-- ...lic-scim-put-or-patch-group-audit-log-events.md | 2 +- data/reusables/secret-scanning/alert-type-links.md | 2 +- src/content-linter/README.md | 4 ++-- .../content/get-started/foo/anchor-autotitling.md | 2 +- .../content/get-started/foo/autotitling.md | 2 +- .../content/get-started/foo/typo-autotitling.md | 4 ++-- .../get-started/start-your-journey/hello-world.md | 4 ++-- .../start-your-journey/link-rewriting.md | 2 +- src/fixtures/fixtures/content/pages/quickstart.md | 4 ++-- .../data/reusables/gated-features/more-info.md | 2 +- .../get-started/start-your-journey/hello-world.md | 2 +- .../lib/release-templates/release-steps-1.md | 4 ++-- .../lib/release-templates/release-steps-2.md | 8 ++++---- .../lib/release-templates/release-steps-5.md | 2 +- 87 files changed, 135 insertions(+), 135 deletions(-) diff --git a/README.md b/README.md index 69090a601896..bd02c836ac79 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ Use the table of contents icon Table of contents icon diff --git a/content/README.md b/content/README.md index 19e57200b888..672c9629c755 100644 --- a/content/README.md +++ b/content/README.md @@ -196,7 +196,7 @@ featuredLinks: ### `allowTitleToDifferFromFilename` -- Purpose: Indicates whether a page is allowed to have a title that differs from its filename. Pages with this frontmatter set to `true` will not be flagged in tests or updated by `src/content-render/scripts/reconcile-filenames-with-ids.js`. Use this value if a file's `title` frontmatter includes Liquid or punctuation that cannot be part of the filename. For example, the article "[About Enterprise Managed Users](https://docs.github.com/en/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)" uses a Liquid reusable in its title, `'About {% data variables.product.prodname_emus %}'`, which cannot be in the filename, `about-enterprise-managed-users.md`, so the `allowTitleToDifferFromFilename` frontmatter is set to `true`. +- Purpose: Indicates whether a page is allowed to have a title that differs from its filename. Pages with this frontmatter set to `true` will not be flagged in tests or updated by `src/content-render/scripts/reconcile-filenames-with-ids.js`. Use this value if a file's `title` frontmatter includes Liquid or punctuation that cannot be part of the filename. For example, the article [About Enterprise Managed Users](https://docs.github.com/en/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users) uses a Liquid reusable in its title, `'About {% data variables.product.prodname_emus %}'`, which cannot be in the filename, `about-enterprise-managed-users.md`, so the `allowTitleToDifferFromFilename` frontmatter is set to `true`. - Type: `Boolean`. Default is `false`. - Optional. @@ -293,15 +293,15 @@ Do not add hardcoded "In this article" sections in the Markdown source or else t A content file can have **two** types of versioning: - [`versions`](#versions) frontmatter (**required**) - - Determines in which versions the page is available. See "[Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation)" for more info. + - Determines in which versions the page is available. See [Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation) for more info. - Liquid statements in content (**optional**) - - Conditionally render content depending on the current version being viewed. See "[Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation#versioning-with-liquid-conditional-operators)" for more info. Note Liquid conditionals can also appear in `data` and `include` files. + - Conditionally render content depending on the current version being viewed. See [Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation#versioning-with-liquid-conditional-operators) for more info. Note Liquid conditionals can also appear in `data` and `include` files. **Note**: As of early 2021, the `free-pro-team@latest` version is not included URLs. A helper function called `src/versions/lib/remove-fpt-from-path.js` removes the version from URLs. ## Filenames -When adding a new article, the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of the article's [`title`](#title) frontmatter. For example, the article "[About GitHub CLI](https://docs.github.com/en/github-cli/github-cli/about-github-cli)" has a `title` frontmatter of `About GitHub CLI` and a filename of `about-github-cli.md`. +When adding a new article, the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Kebab_case) version of the article's [`title`](#title) frontmatter. For example, the article [About GitHub CLI](https://docs.github.com/en/github-cli/github-cli/about-github-cli) has a `title` frontmatter of `About GitHub CLI` and a filename of `about-github-cli.md`. Directory names for categories and map topics can match the `title` or `shortTitle` frontmatter. @@ -383,7 +383,7 @@ You can link directly to a different version of the page using the `currentArtic Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, you should include the preferred version in the path. ```markdown -"[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service)" +[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service) ``` Sometimes the canonical home of content moves outside the docs site. None of the links included in [`src/redirects/lib/external-sites.json`](/src/redirects/lib/external-sites.json) get rewritten. See [`contributing/redirects.md`](/contributing/redirects.md) for more info about this type of redirect. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md index 920d3e2a1834..c7231449f744 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md @@ -27,7 +27,7 @@ Before you leave your company, make sure you update the following information in If you've been working with repositories that belong to an organization, you'll want to [remove yourself as a member of the organization](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization). Note that if you are the organization owner, you should first [transfer ownership of the organization](/organizations/managing-organization-settings/transferring-organization-ownership) to another person. -Unless you're using a {% data variables.enterprise.prodname_managed_user %}, you'll still be able to access your personal account, even after leaving the organization. For more information about {% data variables.product.prodname_emus %}, see "[About {% data variables.product.prodname_emus %}]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +Unless you're using a {% data variables.enterprise.prodname_managed_user %}, you'll still be able to access your personal account, even after leaving the organization. For more information about {% data variables.product.prodname_emus %}, see [About {% data variables.product.prodname_emus %}]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users){% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} ## Removing professional associations with personal repositories diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md index 101cbc2ba216..7ed17840b271 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -14,7 +14,7 @@ shortTitle: Manage multiple accounts In some cases, you may need to use multiple accounts on {% data variables.product.github %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. -You cannot use a {% data variables.enterprise.prodname_managed_user %} to contribute to public projects on {% data variables.location.product_location %}, so you must contribute to those resources using your personal account. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} +You cannot use a {% data variables.enterprise.prodname_managed_user %} to contribute to public projects on {% data variables.location.product_location %}, so you must contribute to those resources using your personal account. For more information, see [About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}.{% endif %} {% ifversion account-switcher %} diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index 2a1ddb51f9cb..e25539a24b0d 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -162,7 +162,7 @@ You can use the REST API to get meta information about {% data variables.product In addition, your workflow may require access to other network resources. -If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing policies for security settings in your enterprise](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see [Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list) or [Enforcing policies for security settings in your enterprise](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} {% else %} diff --git a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md index ff1b2db5ede4..6cc71fcfa935 100644 --- a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md +++ b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md @@ -205,7 +205,7 @@ Variables stored in an environment are only available to workflow jobs that refe 1. Select the custom protection rule you want to enable. 1. Click **Save protection rules**. {%- endif %} -1. Optionally, specify what branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %} can deploy to this environment. For more information, see "[Deployment branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %}](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-branches{% ifversion deployment-protections-tag-patterns %}-and-tags{% endif %})." +1. Optionally, specify what branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %} can deploy to this environment. For more information, see [Deployment branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %}](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-branches{% ifversion deployment-protections-tag-patterns %}-and-tags{% endif %}). 1. Select the desired option in the **Deployment branches** dropdown. 1. If you chose **Selected branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %}**, to add a new rule, click **Add deployment branch{% ifversion deployment-protections-tag-patterns %} or tag{% endif %} rule** {% ifversion deployment-protections-tag-patterns %}1. In the "Ref type" dropdown menu, depending on what rule you want to apply, click **{% octicon "git-branch" aria-hidden="true" %} Branch** or **{% octicon "tag" aria-hidden="true" %} Tag**.{% endif %} diff --git a/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-email-for-notifications.md b/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-email-for-notifications.md index d23c23ea1960..449b0bd6798d 100644 --- a/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-email-for-notifications.md +++ b/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-email-for-notifications.md @@ -25,8 +25,8 @@ shortTitle: Configure email notifications ## Configuring SMTP for your enterprise {% data reusables.enterprise_site_admin_settings.email-settings %} -1. Select **Enable email**. This will enable both outbound and inbound email. However, for inbound email to work you will also need to configure your DNS settings as described below in "[Configuring DNS and firewall -settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." +1. Select **Enable email**. This will enable both outbound and inbound email. However, for inbound email to work you will also need to configure your DNS settings as described below in [Configuring DNS and firewall +settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails). 1. Type the settings for your SMTP server. * In the **Server address** field, type the address of your SMTP server. * In the **Port** field, type the port that your SMTP server uses to send email. diff --git a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md index 82863cbb6955..0de725a8aa1a 100644 --- a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md +++ b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md @@ -91,7 +91,7 @@ Within the selected organizations, you can target all repositories or target a d ### Selecting branch or tag protections -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). ### Adding metadata restrictions diff --git a/content/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md b/content/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md index 4ec6c82120bb..2ad63fa8fe1b 100644 --- a/content/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md +++ b/content/admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md @@ -55,7 +55,7 @@ The exit status of a pre-receive script determines if the push will be accepted. ### Environment variables -In addition to the standard input for your pre-receive hook script, `stdin`, {% data variables.product.prodname_ghe_server %} makes the following variables available in the Bash environment for your script's execution. For more information about `stdin` for your pre-receive hook script, see "[Input (`stdin`)](#input-stdin)." +In addition to the standard input for your pre-receive hook script, `stdin`, {% data variables.product.prodname_ghe_server %} makes the following variables available in the Bash environment for your script's execution. For more information about `stdin` for your pre-receive hook script, see [Input (`stdin`)](#input-stdin). Different environment variables are available to your pre-receive hook script depending on what triggers the script to run. diff --git a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/troubleshooting-resource-allocation-problems.md b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/troubleshooting-resource-allocation-problems.md index fb7aa5366772..975f78c3b226 100644 --- a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/troubleshooting-resource-allocation-problems.md +++ b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/troubleshooting-resource-allocation-problems.md @@ -27,7 +27,7 @@ shortTitle: Troubleshooting resource allocation problems We recommend using the monitor dashboard to stay informed on your appliance's resource health and make decisions on how to fix high usage issues, such as the ones outlined on this page. -For system-critical issues, and prior to making modifications to your appliance, we highly recommend contacting us by visiting {% data variables.contact.contact_ent_support %} and including your support bundle. For more information, see "[Providing data to {% data variables.product.prodname_enterprise %} Support](/enterprise/{{ currentVersion}}/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-support-bundles)." +For system-critical issues, and prior to making modifications to your appliance, we highly recommend contacting us by visiting {% data variables.contact.contact_ent_support %} and including your support bundle. For more information, see [Providing data to {% data variables.product.prodname_enterprise %} Support](/enterprise/{{ currentVersion}}/admin/guides/enterprise-support/providing-data-to-github-support#creating-and-sharing-support-bundles). ## High CPU usage diff --git a/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md b/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md index fe003e890faf..173d9f1c2b2c 100644 --- a/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md +++ b/content/apps/creating-github-apps/registering-a-github-app/making-a-github-app-public-or-private.md @@ -38,7 +38,7 @@ Additionally, you can register a {% data variables.product.prodname_github_app % If you want your {% data variables.product.prodname_github_app %} to be available to organizations in a {% data variables.product.prodname_ghe_server %} instance that you are not part of, then you need to take additional steps. For more information, see [AUTOTITLE](/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server). -If it is important for {% ifversion ghes %}other {% endif %}{% data variables.product.prodname_ghe_server %} users to be able to use your tool, consider using {% data variables.product.prodname_actions %} instead of a {% data variables.product.prodname_github_app %}. Public actions are available on {% data variables.product.prodname_ghe_server %} instances with GitHub Connect. For more information, see "[AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)" and "[AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises){% ifversion ghes %}."{% else %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% endif %} +If it is important for {% ifversion ghes %}other {% endif %}{% data variables.product.prodname_ghe_server %} users to be able to use your tool, consider using {% data variables.product.prodname_actions %} instead of a {% data variables.product.prodname_github_app %}. Public actions are available on {% data variables.product.prodname_ghe_server %} instances with GitHub Connect. For more information, see [AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect) and [AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises){% ifversion ghes %}.{% else %} in the {% data variables.product.prodname_ghe_server %} documentation.{% endif %} For information about changing the visibility of a {% data variables.product.prodname_github_app %} registration, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app). diff --git a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md index 3adb6fbb2085..81436821cfdf 100644 --- a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md +++ b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md @@ -211,7 +211,7 @@ app.webhooks.onError((error) => { // This determines where your server will listen. // -// For local development, your server will listen to port 3000 on `localhost`. When you deploy your app, you will change these values. For more information, see "[Deploy your app](#deploy-your-app)." +// For local development, your server will listen to port 3000 on `localhost`. When you deploy your app, you will change these values. For more information, see [Deploy your app](#deploy-your-app). const port = 3000; const host = 'localhost'; const path = "/api/webhook"; diff --git a/content/apps/maintaining-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/content/apps/maintaining-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index 1fe6a4942f1a..2265f13240b8 100644 --- a/content/apps/maintaining-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/content/apps/maintaining-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -18,11 +18,11 @@ Enterprise and organization owners can restrict access to assets by configuring When an organization has an allow list, third-party applications that connect via a {% data variables.product.prodname_github_app %} will be denied access unless either of the following condition sets are true: * The creator of the {% data variables.product.prodname_github_app %} has configured an allow list for the application that specifies the IP addresses at which their application runs. See below for details of how to do this, and -* The organization owner has chosen to permit the addresses in the {% data variables.product.prodname_github_app %}'s allow list to be added to their own allow list. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#allowing-access-by-github-apps){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +* The organization owner has chosen to permit the addresses in the {% data variables.product.prodname_github_app %}'s allow list to be added to their own allow list. For more information, see [Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#allowing-access-by-github-apps){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} or -* The organization owner has added an IP allow list entry for the IP addresses from which the application runs. See "[Adding an allowed IP address](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#adding-an-allowed-ip-address){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +* The organization owner has added an IP allow list entry for the IP addresses from which the application runs. See [Adding an allowed IP address](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#adding-an-allowed-ip-address){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} {% data reusables.apps.ip-allow-list-only-apps %} diff --git a/content/billing/managing-the-plan-for-your-github-account/about-per-user-pricing.md b/content/billing/managing-the-plan-for-your-github-account/about-per-user-pricing.md index 019cd3af4fa3..3ff6a735b197 100644 --- a/content/billing/managing-the-plan-for-your-github-account/about-per-user-pricing.md +++ b/content/billing/managing-the-plan-for-your-github-account/about-per-user-pricing.md @@ -112,9 +112,9 @@ If your enterprise does not use {% data variables.product.prodname_emus %}, you After a user successfully authenticates to a {% data variables.product.prodname_ghe_server %} instance for the first time, the user consumes a seat. -Suspended users are not counted when calculating the number of licensed users consuming seats. For more information, see "[Suspending and unsuspending users]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} +Suspended users are not counted when calculating the number of licensed users consuming seats. For more information, see [Suspending and unsuspending users]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users){% ifversion not ghes %} in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}.{% endif %} -Dormant users do occupy a seat license. Administrators can suspend dormant users to free licenses. For more information, see "[Managing dormant users]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} +Dormant users do occupy a seat license. Administrators can suspend dormant users to free licenses. For more information, see [Managing dormant users]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users){% ifversion not ghes %} in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}.{% endif %} {% endif %} diff --git a/content/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account.md b/content/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account.md index 963017894301..2bca2edbdd6a 100644 --- a/content/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account.md +++ b/content/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account.md @@ -26,7 +26,7 @@ shortTitle: View subscription & usage You can view an overview of {% ifversion ghec %}your subscription and paid{% elsif ghes %}the license{% endif %} usage for {% ifversion ghec %}your{% elsif ghes %}the{% endif %} enterprise account on {% ifversion ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.location.product_location %}{% endif %}.{% ifversion ghec %} {% data reusables.enterprise.create-an-enterprise-account %} For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/managing-your-enterprise-account/creating-an-enterprise-account).{% endif %} -For invoiced {% data variables.product.prodname_enterprise %} customers{% ifversion ghes %} who use both {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}{% endif %}, each invoice includes details about billed services for all products. For example, in addition to your usage for {% ifversion ghec %}{% data variables.product.prodname_ghe_cloud %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, you may have usage for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghec %}, {% elsif ghes %}. You may also have usage on {% data variables.product.prodname_dotcom_the_website %}, like {% endif %}paid licenses in organizations outside of your enterprise account, data packs for {% data variables.large_files.product_name_long %}, or subscriptions to apps in {% data variables.product.prodname_marketplace %}. For more information about invoices, see "[Managing invoices for your enterprise]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/managing-invoices-for-your-enterprise){% ifversion ghec %}."{% elsif ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +For invoiced {% data variables.product.prodname_enterprise %} customers{% ifversion ghes %} who use both {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}{% endif %}, each invoice includes details about billed services for all products. For example, in addition to your usage for {% ifversion ghec %}{% data variables.product.prodname_ghe_cloud %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, you may have usage for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghec %}, {% elsif ghes %}. You may also have usage on {% data variables.product.prodname_dotcom_the_website %}, like {% endif %}paid licenses in organizations outside of your enterprise account, data packs for {% data variables.large_files.product_name_long %}, or subscriptions to apps in {% data variables.product.prodname_marketplace %}. For more information about invoices, see [Managing invoices for your enterprise]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/managing-invoices-for-your-enterprise){% ifversion ghec %}.{% elsif ghes %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} {% ifversion ghec %} diff --git a/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md b/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md index bca69cc07b7b..0feb5c32dd45 100644 --- a/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md +++ b/content/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise.md @@ -46,6 +46,6 @@ If you have any questions about renewing your license, contact {% data variables ## Further reading * [AUTOTITLE](/billing/managing-your-github-billing-settings/about-billing-for-your-enterprise) -* The [People that consume a license](/billing/managing-the-plan-for-your-github-account/about-per-user-pricing#people-that-consume-a-license)" section in "About per-user pricing" -* "[Setting up a {% data variables.product.prodname_ghe_server %} instance]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/installation/setting-up-a-github-enterprise-server-instance)" +* The [People that consume a license](/billing/managing-the-plan-for-your-github-account/about-per-user-pricing#people-that-consume-a-license) section in "About per-user pricing" +* [Setting up a {% data variables.product.prodname_ghe_server %} instance]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/installation/setting-up-a-github-enterprise-server-instance) * The [{% data variables.product.prodname_enterprise %} Releases](https://enterprise.github.com/releases/) website diff --git a/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md index 62f57ba35a6a..c973e125586c 100644 --- a/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/content/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -18,7 +18,7 @@ shortTitle: Sync license usage {% data reusables.enterprise-licensing.about-license-sync %} -To ensure that you see up-to-date license details on {% data variables.product.prodname_ghe_cloud %}, you can sync license usage to {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-license-sync %} or {% data variables.enterprise.data_residency_site %}{% endif %} automatically, using {% data variables.product.prodname_github_connect %}. For more information about {% data variables.product.prodname_github_connect %}, see "[About {% data variables.product.prodname_github_connect %}]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/about-github-connect){% ifversion ghec %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}."{% endif %} +To ensure that you see up-to-date license details on {% data variables.product.prodname_ghe_cloud %}, you can sync license usage to {% data variables.product.prodname_dotcom_the_website %}{% ifversion ghecom-license-sync %} or {% data variables.enterprise.data_residency_site %}{% endif %} automatically, using {% data variables.product.prodname_github_connect %}. For more information about {% data variables.product.prodname_github_connect %}, see [About {% data variables.product.prodname_github_connect %}]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/about-github-connect){% ifversion ghec %} in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}.{% endif %} If you don't want to enable {% data variables.product.prodname_github_connect %}, you can manually sync license usage by uploading a file from {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_dotcom_the_website %}. @@ -30,7 +30,7 @@ When you synchronize license usage, only the user ID and email addresses for eac ## Automatically syncing license usage -You can use {% data variables.product.prodname_github_connect %} to automatically synchronize user license count and usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} weekly. For more information, see "[Enabling automatic user license sync for your enterprise]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise){% ifversion ghec %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}."{% endif %} +You can use {% data variables.product.prodname_github_connect %} to automatically synchronize user license count and usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} weekly. For more information, see [Enabling automatic user license sync for your enterprise]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise){% ifversion ghec %} in the {% data variables.product.prodname_ghe_server %} documentation.{% elsif ghes %}.{% endif %} {% ifversion ghec or ghes %} After you enable {% data variables.product.prodname_github_connect %}, license data will be automatically synchronized weekly. You can also manually synchronize your license data at any time, by triggering a license sync job. diff --git a/content/billing/using-the-billing-platform/about-billing-for-your-enterprise.md b/content/billing/using-the-billing-platform/about-billing-for-your-enterprise.md index e07f8a7e94fa..419a03097703 100644 --- a/content/billing/using-the-billing-platform/about-billing-for-your-enterprise.md +++ b/content/billing/using-the-billing-platform/about-billing-for-your-enterprise.md @@ -40,10 +40,10 @@ Each user on {% data variables.location.product_location %} consumes a seat on y {%- ifversion ghes %} * [AUTOTITLE](/enterprise-cloud@latest/billing/managing-the-plan-for-your-github-account/about-per-user-pricing) {%- endif %} -* "[Viewing the subscription and usage for your enterprise account]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)" -* "[Managing invoices for your enterprise]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/managing-invoices-for-your-enterprise)" +* [Viewing the subscription and usage for your enterprise account]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account) +* [Managing invoices for your enterprise]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/managing-invoices-for-your-enterprise) -Administrators for your enterprise account on {% data variables.product.prodname_dotcom_the_website %} can access and manage billing for the enterprise. For more information, see "[Roles in an enterprise]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise){% ifversion ghec %}."{% elsif ghes %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +Administrators for your enterprise account on {% data variables.product.prodname_dotcom_the_website %} can access and manage billing for the enterprise. For more information, see [Roles in an enterprise]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise){% ifversion ghec %}.{% elsif ghes %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} {% ifversion ghec %} {% data reusables.enterprise-accounts.billing-azure-subscription-enterprise-only %} See [AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription). diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md b/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md index ca0c7c65b316..4c1caf0ec1db 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md +++ b/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md @@ -55,6 +55,6 @@ Update your calls to run the {% data variables.product.prodname_codeql_cli %} fo ## Further reading * [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning) -* "[Building Java and Kotlin](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#building-java-and-kotlin){% ifversion codeql-no-build %} +* [Building Java and Kotlin](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#building-java-and-kotlin){% ifversion codeql-no-build %} * [CodeQL build modes](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#codeql-build-modes){% elsif ghes %} * [Adding build steps for a compiled language](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages#adding-build-steps-for-a-compiled-language){% endif %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md index ceaad9b38c79..e4b4c1a4555d 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md +++ b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md @@ -138,8 +138,8 @@ query pack to download, keep in mind that when you update your version of also need to switch to a newer version of the query pack. Newer versions of {% data variables.product.prodname_codeql %} _may_ provide degraded performance when used with query packs that have been pinned -to a very old version. For more information, see "[About {% data variables.product.prodname_codeql %} -pack compatibility](#about-codeql-pack-compatibility)." +to a very old version. For more information, see [About {% data variables.product.prodname_codeql %} +pack compatibility](#about-codeql-pack-compatibility). ## Using a {% data variables.product.prodname_codeql %} pack to analyze a {% data variables.product.prodname_codeql %} database diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md index e9754d5cf903..6cbe52227442 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md +++ b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md @@ -135,7 +135,7 @@ After your pattern is created, {% data variables.product.prodname_secret_scannin ## Defining a custom pattern for an enterprise account -Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see "[Enabling {% data variables.product.prodname_GH_advanced_security %} for your enterprise]({% ifversion fpt or ghec %}/enterprise-server@latest/{% endif %}/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise)." +Before defining a custom pattern, you must ensure that you enable secret scanning for your enterprise account. For more information, see [AUTOTITLE]({% ifversion fpt or ghec %}/enterprise-server@latest/{% endif %}/admin/advanced-security/enabling-github-advanced-security-for-your-enterprise). > [!NOTE] > * At the enterprise level, only the creator of a custom pattern can edit the pattern, and use it in a dry run. diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md index 41fcf46baf61..062a1748d3e0 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md @@ -25,9 +25,9 @@ When you enable automatic dependency submission for a repository, {% data variab Using automatic dependency submission counts toward your {% data variables.product.prodname_actions %} minutes. For more information, see [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions). -Optionally, you can choose to configure self-hosted runners or {% data variables.product.company_short %}-hosted {% data variables.actions.hosted_runners %} for automatic dependency submission. For more information, see "[Using self-hosted runners for automatic dependency submission](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository#using-self-hosted-runners-for-automatic-dependency-submission -)" and "[Using GitHub-hosted larger runners for automatic dependency submission](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository#using-github-hosted-larger-runners-for-automatic-dependency-submission -)." +Optionally, you can choose to configure self-hosted runners or {% data variables.product.company_short %}-hosted {% data variables.actions.hosted_runners %} for automatic dependency submission. For more information, see [Using self-hosted runners for automatic dependency submission](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository#using-self-hosted-runners-for-automatic-dependency-submission +) and [Using GitHub-hosted larger runners for automatic dependency submission](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository#using-github-hosted-larger-runners-for-automatic-dependency-submission +). ## Prerequisites diff --git a/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md index 36161b776c18..60791b59aea4 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization.md @@ -39,7 +39,7 @@ Only people who can either push changes to a repository, or fork the repository, In addition, to allow users to create codespaces, you must ensure that{% ifversion ghec %}: * Your enterprise does not use OIDC with CAP. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy). -* Your{% else %} your{% endif %} organization does not have an IP address allow list enabled. For more information, see "[Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +* Your{% else %} your{% endif %} organization does not have an IP address allow list enabled. For more information, see [Managing allowed IP addresses for your organization](/{% ifversion fpt %}enterprise-cloud@latest/{% endif %}organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} {% ifversion fpt %} diff --git a/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md b/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md index 2bd87f5422d6..0229566f0598 100644 --- a/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md +++ b/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md @@ -185,6 +185,6 @@ Format further reading sections using unordered lists. See [AUTOTITLE](/contribu ```markdown ## Further reading -- "[Article title](article-URL)" +- [Article title](article-URL) - [External resource title](external-resource-URL) in External Resource Name ``` diff --git a/content/contributing/style-guide-and-content-model/style-guide.md b/content/contributing/style-guide-and-content-model/style-guide.md index c96297fbe8ec..2bbf7ae6bdc8 100644 --- a/content/contributing/style-guide-and-content-model/style-guide.md +++ b/content/contributing/style-guide-and-content-model/style-guide.md @@ -1007,7 +1007,7 @@ A release note for a feature answers the following questions. 1. What is the functionality? 1. If applicable, where can I read more about the functionality? -> _AUDIENCE_ (**1**) can _DESCRIPTION OF NEED_ (**2**) by _DESCRIPTION OF FEATURE'S USE_ (**3**). For more information, see "[_ARTICLE TITLE_](/)" (**4**). +> _AUDIENCE_ (**1**) can _DESCRIPTION OF NEED_ (**2**) by _DESCRIPTION OF FEATURE'S USE_ (**3**). For more information, see [_ARTICLE TITLE_](/) (**4**) * Categorize each feature in a section, under a feature heading. * Write in the present tense. @@ -1201,7 +1201,7 @@ A release note for a retired feature answers the following questions. 1. If applicable, what replaces the retired functionality? 1. If applicable, where can I read more? -> _AUDIENCE_ (**1**) _DESCRIPTION OF RETIRED FUNCTIONALITY_ (**2**) _REPLACEMENT FUNCTIONALITY_ (**3**) For more information, see "[_ARTICLE TITLE_](/)" (**4**). +> _AUDIENCE_ (**1**) _DESCRIPTION OF RETIRED FUNCTIONALITY_ (**2**) _REPLACEMENT FUNCTIONALITY_ (**3**) For more information, see [_ARTICLE TITLE_](/) (**4**) * Notes are in the present tense. * To reduce repetition and unnecessary words, "now" is usually implied. diff --git a/content/contributing/writing-for-github-docs/templates.md b/content/contributing/writing-for-github-docs/templates.md index f2fcfaa08486..f9756fe8d4c1 100644 --- a/content/contributing/writing-for-github-docs/templates.md +++ b/content/contributing/writing-for-github-docs/templates.md @@ -52,7 +52,7 @@ Keep adding headers and sections until you've completed your article. Optionally, include a bulleted list of related articles the user can reference to extend the concepts covered in this article. Consider linking to procedural articles or tutorials that help the user use the information in your article. {% endcomment %} -- "[Article title](article-URL)"{% endraw %} +- [Article title](article-URL){% endraw %} ``` @@ -104,7 +104,7 @@ Keep adding headers and sections until you've completed your article. Optionally, include a bulleted list of related articles the user can reference to extend the concepts covered in this article. Consider linking to procedural articles or tutorials that help the user use the information in your article. {% endcomment %} -- "[Article title](article-URL)"{% endraw %} +- [Article title](article-URL){% endraw %} ``` @@ -156,7 +156,7 @@ Keep adding procedures until you've finished writing your article. Optionally, include a bulleted list of related articles the user can reference to extend the concepts covered in this article. Consider linking to procedural articles or tutorials that help the user use the information in your article. {% endcomment %} -- "[Article title](article-URL)"{% endraw %} +- [Article title](article-URL){% endraw %} ``` @@ -299,7 +299,7 @@ Remember to show code snippets in context Include a bulleted list of tutorials or articles the user can reference to extend the concepts taught in this tutorial {% endcomment %} -- "[Article title](article-URL)"{% endraw %} +- [Article title](article-URL){% endraw %} ``` diff --git a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md index 928b03f6a1b3..caa058d043de 100644 --- a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md @@ -445,7 +445,7 @@ You can link directly to a different version of the page using the `currentArtic Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, you should include the preferred version in the path. ```markdown -"[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service)" +[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service) ``` Sometimes the canonical home of content moves outside the docs site. None of the links included in [`src/redirects/lib/external-sites.json`](https://github.com/github/docs/blob/main/src/redirects/lib/external-sites.json) get rewritten. See [`contributing/redirects.md`](https://github.com/github/docs/blob/main/contributing/redirects.md) for more info about this type of redirect. diff --git a/content/contributing/writing-for-github-docs/writing-content-to-be-translated.md b/content/contributing/writing-for-github-docs/writing-content-to-be-translated.md index b541b7c5dec3..ac87df26812d 100644 --- a/content/contributing/writing-for-github-docs/writing-content-to-be-translated.md +++ b/content/contributing/writing-for-github-docs/writing-content-to-be-translated.md @@ -72,5 +72,5 @@ Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering You can use this instead: ```markdown -OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)." +OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see [AUTOTITLE](apps/building-integrations/setting-up-and-registering-oauth-apps/) and [Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization). ``` diff --git a/content/get-started/learning-about-github/githubs-plans.md b/content/get-started/learning-about-github/githubs-plans.md index fba86d51fbba..eeac97912f29 100644 --- a/content/get-started/learning-about-github/githubs-plans.md +++ b/content/get-started/learning-about-github/githubs-plans.md @@ -105,13 +105,13 @@ In addition to the features available with {% data variables.product.prodname_fr * Organization owners can choose to enable or disable {% data variables.product.prodname_github_codespaces %} for the organization's private {% ifversion ghec %}and internal {% endif %}repositories, and can pay for the usage of members and collaborators. For more information, see [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization) and [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization). {%- endif %} -{% data variables.product.company_short %} bills for {% data variables.product.prodname_team %} on a per-user basis. For more information, see "[About per-user pricing]({% ifversion not fpt %}/free-pro-team@latest{% endif %}/billing/managing-the-plan-for-your-github-account/about-per-user-pricing){% ifversion fpt %}."{% else %}" in the Free, Pro, & Team documentation.{% endif %} +{% data variables.product.company_short %} bills for {% data variables.product.prodname_team %} on a per-user basis. For more information, see [About per-user pricing]({% ifversion not fpt %}/free-pro-team@latest{% endif %}/billing/managing-the-plan-for-your-github-account/about-per-user-pricing){% ifversion fpt %}.{% else %} in the Free, Pro, & Team documentation.{% endif %} {% data reusables.actions.actions-billing %} ## {% data variables.product.prodname_enterprise %} -{% data variables.product.prodname_enterprise %} includes two deployment options: {% data variables.product.prodname_ghe_cloud %}, which is hosted by {% data variables.product.company_short %} in the cloud, and {% data variables.product.prodname_ghe_server %}, which is self-hosted. For more information, see "[About {% data variables.product.prodname_dotcom %} for enterprises]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/overview/about-github-for-enterprises){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +{% data variables.product.prodname_enterprise %} includes two deployment options: {% data variables.product.prodname_ghe_cloud %}, which is hosted by {% data variables.product.company_short %} in the cloud, and {% data variables.product.prodname_ghe_server %}, which is self-hosted. For more information, see [About {% data variables.product.prodname_dotcom %} for enterprises]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/overview/about-github-for-enterprises){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} In addition to the features available with {% data variables.product.prodname_team %}, {% data variables.product.prodname_enterprise %} includes: @@ -144,4 +144,4 @@ You can set up trials to evaluate {% data variables.product.prodname_ghe_cloud % ## Further reading -* "[About per-user pricing]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/about-per-user-pricing)"{% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %} +* [About per-user pricing]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/billing/managing-the-plan-for-your-github-account/about-per-user-pricing){% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %} diff --git a/content/get-started/using-github/github-mobile.md b/content/get-started/using-github/github-mobile.md index 6bb082fa2c15..2fecc0395e75 100644 --- a/content/get-started/using-github/github-mobile.md +++ b/content/get-started/using-github/github-mobile.md @@ -59,7 +59,7 @@ To access accounts on {% data variables.enterprise.data_residency %} using {% da You must install {% data variables.product.prodname_mobile %} 1.4 or later on your device to use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}. -To use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, {% data variables.product.prodname_dotcom %} must be version 3.0 or greater, and your enterprise owner must enable mobile support for your enterprise. For more information, see {% ifversion ghes %}[AUTOTITLE](/admin/release-notes) and {% endif %}"[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise){% ifversion not ghes %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}."{% endif %} +To use {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, {% data variables.product.prodname_dotcom %} must be version 3.0 or greater, and your enterprise owner must enable mobile support for your enterprise. For more information, see {% ifversion ghes %}[AUTOTITLE](/admin/release-notes) and {% endif %}[Managing {% data variables.product.prodname_mobile %} for your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise){% ifversion not ghes %} in the {% data variables.product.prodname_ghe_server %} documentation.{% else %}.{% endif %} During the {% data variables.release-phases.public_preview %} for {% data variables.product.prodname_mobile %} with {% data variables.product.prodname_ghe_server %}, you must be signed in with a personal account on {% data variables.product.prodname_dotcom_the_website %}. diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md index 22d8cd3d3e22..2cef5626cfae 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/troubleshooting-your-migration-with-github-enterprise-importer.md @@ -81,7 +81,7 @@ First, try excluding releases from the migration by using the `--skip-releases` If that doesn't work, we'd recommend upgrading to {% data variables.product.prodname_ghe_server %} 3.8.0 or later. If you're unable to upgrade, another option is to generate your repository archives manually using `ghe-migrator`: -1. Generate a migration archive for your repository. You must only export one repository at a time. For instructions, see "[Exporting migration data from your enterprise]({% ifversion fpt or ghec %}/enterprise-server@latest{% endif %}/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise){% ifversion ghes %}."{% else %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% endif %} +1. Generate a migration archive for your repository. You must only export one repository at a time. For instructions, see [Exporting migration data from your enterprise]({% ifversion fpt or ghec %}/enterprise-server@latest{% endif %}/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise){% ifversion ghes %}.{% else %} in the {% data variables.product.prodname_ghe_server %} documentation.{% endif %} 1. Upload your migration archive to your choice of blob storage provider. 1. Generate a short-lived URL for your migration archive which is accessible to {% data variables.product.prodname_dotcom %}, such as an AWS S3 pre-signed URL or Azure Blob Storage SAS URL. 1. Call the `migrate-repo` command with the `--git-archive-url` and `--metadata-archive-url` flags both set to the URL of your archive from the previous step. diff --git a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md index eee12e29249d..0f9cad1c8a98 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud.md @@ -211,7 +211,7 @@ For more information, see [Get an organization migration status](/rest/migration > [!NOTE] > If your migration moves to the `failed` state rather than the `exported` state, try starting the migration again. If the migration fails repeatedly, we recommend generating the archives using `ghe-migrator` instead of the API. > ->Follow the steps in "[Exporting migration data from your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise)," adding only one repository to the migration. At the end of the process, you will have a single migration archive with your Git source and metadata, and you can move to step 6 in this article. +>Follow the steps in [Exporting migration data from your enterprise]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise), adding only one repository to the migration. At the end of the process, you will have a single migration archive with your Git source and metadata, and you can move to step 6 in this article. After the `state` of a migration moves to `exported`, you can fetch the migration's URL using the "Download an organization migration archive" API. diff --git a/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md b/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md index 181d0ccb738f..0e6de09c0aa2 100644 --- a/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md +++ b/content/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators.md @@ -27,7 +27,7 @@ By default, anyone with admin access to a repository can invite outside collabor {% endif %} -{% ifversion ghec %}If your organization is owned by an enterprise account, you{% else %}You{% endif %} may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see "[Enforcing repository management policies in your enterprise]{% ifversion ghec %}(/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-collaborators-to-repositories)"{% else %}(/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories){% endif %}." +{% ifversion ghec %}If your organization is owned by an enterprise account, you{% else %}You{% endif %} may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see [Enforcing repository management policies in your enterprise]{% ifversion ghec %}(/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-collaborators-to-repositories){% else %}(/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories){% endif %}. {% data reusables.organizations.outside-collaborators-use-seats %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md index b29635d4581d..0d9d8dbb047d 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md @@ -23,7 +23,7 @@ shortTitle: Convert member to collaborator You can convert a member of an organization to an outside collaborator. For more information about outside collaborators, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization). -{% ifversion fpt or ghec %}If the organization is owned by an enterprise, converting{% elsif ghes %}Converting{% endif %} an organization member to an outside collaborator may be restricted. For more information, see "[Enforcing repository management policies in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-{% ifversion fpt or ghec %}outside-{% endif %}collaborators-to-repositories){% ifversion ghec or ghes %}."{% elsif fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +{% ifversion fpt or ghec %}If the organization is owned by an enterprise, converting{% elsif ghes %}Converting{% endif %} an organization member to an outside collaborator may be restricted. For more information, see [Enforcing repository management policies in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-{% ifversion fpt or ghec %}outside-{% endif %}collaborators-to-repositories){% ifversion ghec or ghes %}.{% elsif fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} {% data reusables.organizations.outside-collaborators-use-seats %} {% data reusables.organizations.outside_collaborator_forks %} diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index e2af4547ee82..6eae3c797ffc 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -28,7 +28,7 @@ You can host your site on {% data variables.product.prodname_dotcom %}'s `github {% endif %} {% ifversion fpt or ghec %} -{% data reusables.pages.about-private-publishing %} For more information, see "[Changing the visibility of your {% data variables.product.prodname_pages %} site]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +{% data reusables.pages.about-private-publishing %} For more information, see [Changing the visibility of your {% data variables.product.prodname_pages %} site]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} {% endif %} To get started, see [AUTOTITLE](/pages/getting-started-with-github-pages/creating-a-github-pages-site). diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index e71b8acb0ce8..49980748888c 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -36,7 +36,7 @@ After typing a search query, you can press **Enter** to go to the full search re > [!NOTE] > * {% data reusables.search.required_login %} -> * {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}." For more information about {% data variables.product.prodname_pages %}, see [AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages) +> * {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see [AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}. For more information about {% data variables.product.prodname_pages %}, see [AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages) > * Currently our search doesn't support exact matching.{% ifversion ghes %} > * Whenever you are searching in code files, only the first two results in each file will be returned.{% endif %} diff --git a/content/search-github/searching-on-github/searching-for-repositories.md b/content/search-github/searching-on-github/searching-for-repositories.md index 1fca0748719f..211ccf86598b 100644 --- a/content/search-github/searching-on-github/searching-for-repositories.md +++ b/content/search-github/searching-on-github/searching-for-repositories.md @@ -36,7 +36,7 @@ With the `in` qualifier you can restrict your search to the repository name, rep You can find a repository by searching for content in the repository's README file using the `in:readme` qualifier. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes). -Besides using `in:readme`, it's not possible to find repositories by searching for specific content within the repository. To search for a specific file or content within a repository, you can use the file finder or code-specific search qualifiers. For more information, see [AUTOTITLE](/search-github/searching-on-github/finding-files-on-github) and "[AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}." +Besides using `in:readme`, it's not possible to find repositories by searching for specific content within the repository. To search for a specific file or content within a repository, you can use the file finder or code-specific search qualifiers. For more information, see [AUTOTITLE](/search-github/searching-on-github/finding-files-on-github) and [AUTOTITLE]{% ifversion code-search-upgrade %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}. | Qualifier | Example | ------------- | ------------- diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md index 9309fe1181fe..c2c23ded569b 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md @@ -86,7 +86,7 @@ jobs: # - Replace `YOUR_APP_ID_SECRET_NAME` with the name of the secret where you stored your app ID. # - Replace `YOUR_PRIVATE_KEY_SECRET_NAME` with the name of the secret where you stored your private key. # - Replace `YOUR_TOKEN_SECRET_NAME` with the name of the secret where you stored your {% data variables.product.pat_generic %}. - # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." + # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). {% ifversion ghes %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} - name: Run script env: @@ -108,7 +108,7 @@ This section demonstrates how you can write a script to find and redeliver faile Copy this script into a file called `.github/workflows/scripts/redeliver-failed-deliveries.mjs` in the same repository where you saved the {% data variables.product.prodname_actions %} workflow file above. ```javascript copy annotate -// This script uses {% data variables.product.company_short %}'s Octokit SDK to make API requests. For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)." +// This script uses {% data variables.product.company_short %}'s Octokit SDK to make API requests. For more information, see [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript). import { App, Octokit } from "octokit"; // @@ -218,7 +218,7 @@ async function checkAndRedeliverWebhooks() { } // This function will fetch all of the webhook deliveries that were delivered since `lastWebhookRedeliveryTime`. -// It uses the `octokit.paginate.iterator()` method to iterate through paginated results. For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript#making-paginated-requests)." +// It uses the `octokit.paginate.iterator()` method to iterate through paginated results. For more information, see [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript#making-paginated-requests). // // If a page of results includes deliveries that occurred before `lastWebhookRedeliveryTime`, // it will store only the deliveries that occurred after `lastWebhookRedeliveryTime` and then stop. @@ -291,7 +291,7 @@ async function getVariable({ variableName, repoOwner, repoName, octokit }) { } } -// This function will update a configuration variable (or create the variable if it doesn't already exist). For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." +// This function will update a configuration variable (or create the variable if it doesn't already exist). For more information, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). async function updateVariable({ variableName, value, diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md index d129e4741e8c..336c24dfca51 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md @@ -83,7 +83,7 @@ jobs: # - Replace `YOUR_REPO_OWNER` with the owner of the repository where the webhook was created. # - Replace `YOUR_REPO_NAME` with the name of the repository where the webhook was created. # - Replace `YOUR_HOOK_ID` with the ID of the webhook. - # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." + # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). {% ifversion ghes %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} - name: Run script env: @@ -106,7 +106,7 @@ This section demonstrates how you can write a script to find and redeliver faile Copy this script into a file called `.github/workflows/scripts/redeliver-failed-deliveries.js` in the same repository where you saved the {% data variables.product.prodname_actions %} workflow file above. ```javascript copy annotate -// This script uses {% data variables.product.company_short %}'s Octokit SDK to make API requests. For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)." +// This script uses {% data variables.product.company_short %}'s Octokit SDK to make API requests. For more information, see [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript). const { Octokit } = require("octokit"); // @@ -215,7 +215,7 @@ async function checkAndRedeliverWebhooks() { } // This function will fetch all of the webhook deliveries that were delivered since `lastWebhookRedeliveryTime`. -// It uses the `octokit.paginate.iterator()` method to iterate through paginated results. For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript#making-paginated-requests)." +// It uses the `octokit.paginate.iterator()` method to iterate through paginated results. For more information, see [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript#making-paginated-requests). // // If a page of results includes deliveries that occurred before `lastWebhookRedeliveryTime`, // it will store only the deliveries that occurred after `lastWebhookRedeliveryTime` and then stop. @@ -309,7 +309,7 @@ async function getVariable({ variableName, repoOwner, repoName, octokit }) { } } -// This function will update a configuration variable (or create the variable if it doesn't already exist). For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." +// This function will update a configuration variable (or create the variable if it doesn't already exist). For more information, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). async function updateVariable({ variableName, value, diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md index a026e1e5320b..b71fbddb162b 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md @@ -82,7 +82,7 @@ jobs: # - Replace `YOUR_SECRET_NAME` with the name of the secret where you stored your {% data variables.product.pat_generic %}. # - Replace `YOUR_ORGANIZATION_NAME` with the name of the organization where the webhook was created. # - Replace `YOUR_HOOK_ID` with the ID of the webhook. - # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." + # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). {% ifversion ghes %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} - name: Run script env: @@ -104,7 +104,7 @@ This section demonstrates how you can write a script to find and redeliver faile Copy this script into a file called `.github/workflows/scripts/redeliver-failed-deliveries.js` in the same repository where you saved the {% data variables.product.prodname_actions %} workflow file above. ```javascript copy annotate -// This script uses {% data variables.product.company_short %}'s Octokit SDK to make API requests. For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript)." +// This script uses {% data variables.product.company_short %}'s Octokit SDK to make API requests. For more information, see [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript). const { Octokit } = require("octokit"); // @@ -210,7 +210,7 @@ async function checkAndRedeliverWebhooks() { } // This function will fetch all of the webhook deliveries that were delivered since `lastWebhookRedeliveryTime`. -// It uses the `octokit.paginate.iterator()` method to iterate through paginated results. For more information, see "[AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript#making-paginated-requests)." +// It uses the `octokit.paginate.iterator()` method to iterate through paginated results. For more information, see [AUTOTITLE](/rest/guides/scripting-with-the-rest-api-and-javascript#making-paginated-requests). // // If a page of results includes deliveries that occurred before `lastWebhookRedeliveryTime`, // it will store only the deliveries that occurred after `lastWebhookRedeliveryTime` and then stop. @@ -300,7 +300,7 @@ async function getVariable({ variableName, repoOwner, repoName, octokit }) { } } -// This function will update a configuration variable (or create the variable if it doesn't already exist). For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." +// This function will update a configuration variable (or create the variable if it doesn't already exist). For more information, see [AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows). async function updateVariable({ variableName, value, diff --git a/content/webhooks/using-webhooks/handling-webhook-deliveries.md b/content/webhooks/using-webhooks/handling-webhook-deliveries.md index ca0699505b49..a05155fe7f26 100644 --- a/content/webhooks/using-webhooks/handling-webhook-deliveries.md +++ b/content/webhooks/using-webhooks/handling-webhook-deliveries.md @@ -119,11 +119,11 @@ To use this example, you must install the sinatra gem in your Ruby project. For Create a Ruby file with the following contents. Modify the code to handle the event types that your webhook is subscribed to, as well as the `ping` event that {% data variables.product.company_short %} sends when you create a webhook. This example handles the `issues` and `ping` events. ```ruby copy annotate -# These are the dependencies for this code. You installed the `sinatra` gem earlier. For more information, see "[Ruby example: Install dependencies](#ruby-example-install-dependencies)." The `json` library is a standard Ruby library, so you don't need to install it. +# These are the dependencies for this code. You installed the `sinatra` gem earlier. For more information, see [Ruby example: Install dependencies](#ruby-example-install-dependencies). The `json` library is a standard Ruby library, so you don't need to install it. require 'sinatra' require 'json' -# The `/webhook` route matches the path that you specified for the smee.io forwarding. For more information, see "[Forward webhooks](#forward-webhooks)." +# The `/webhook` route matches the path that you specified for the smee.io forwarding. For more information, see [Forward webhooks](#forward-webhooks). # # Once you deploy your code to a server and update your webhook URL, you should change this to match the path portion of the URL for your webhook. post '/webhook' do @@ -142,7 +142,7 @@ post '/webhook' do # If any events have an `action` field, you should also add logic to handle each action that you are interested in. # For example, this code handles the `opened` and `closed` actions for the `issue` event. # - # For more information about the data that you can expect for each event type, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads)." + # For more information about the data that you can expect for each event type, see [AUTOTITLE](/webhooks/webhook-events-and-payloads). if github_event == "issues" data = JSON.parse(request.body.read) action = data['action'] @@ -203,13 +203,13 @@ npm install express Create a JavaScript file with the following contents. Modify the code to handle the event types that your webhook is subscribed to, as well as the `ping` event that {% data variables.product.company_short %} sends when you create a webhook. This example handles the `issues` and `ping` events. ```javascript copy annotate -// You installed the `express` library earlier. For more information, see "[JavaScript example: Install dependencies](#javascript-example-install-dependencies)." +// You installed the `express` library earlier. For more information, see [JavaScript example: Install dependencies](#javascript-example-install-dependencies). const express = require('express'); // This initializes a new Express application. const app = express(); -// This defines a POST route at the `/webhook` path. This path matches the path that you specified for the smee.io forwarding. For more information, see "[Forward webhooks](#forward-webhooks)." +// This defines a POST route at the `/webhook` path. This path matches the path that you specified for the smee.io forwarding. For more information, see [Forward webhooks](#forward-webhooks). // // Once you deploy your code to a server and update your webhook URL, you should change this to match the path portion of the URL for your webhook. app.post('/webhook', express.json({type: 'application/json'}), (request, response) => { @@ -227,7 +227,7 @@ app.post('/webhook', express.json({type: 'application/json'}), (request, respons // If any events have an `action` field, you should also add logic to handle each action that you are interested in. // For example, this code handles the `opened` and `closed` actions for the `issue` event. // - // For more information about the data that you can expect for each event type, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads)." + // For more information about the data that you can expect for each event type, see [AUTOTITLE](/webhooks/webhook-events-and-payloads). if (githubEvent === 'issues') { const data = request.body; const action = data.action; @@ -246,7 +246,7 @@ app.post('/webhook', express.json({type: 'application/json'}), (request, respons }); // This defines the port where your server should listen. -// 3000 matches the port that you specified for webhook forwarding. For more information, see "[Forward webhooks](#forward-webhooks)." +// 3000 matches the port that you specified for webhook forwarding. For more information, see [Forward webhooks](#forward-webhooks). // // Once you deploy your code to a server, you should change this to match the port where your server is listening. const port = 3000; diff --git a/contributing/README.md b/contributing/README.md index 4d4322240dbd..848e3d1474e8 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -2,7 +2,7 @@ Check out our [contributing guide](../.github/CONTRIBUTING.md) to see all the ways you can participate in the GitHub docs community :sparkling_heart: -Visit "[Contributing to GitHub Docs documentation](https://docs.github.com/en/contributing)" for additional information about how to write and collaborate the GitHub Docs way. +Visit [Contributing to GitHub Docs documentation](https://docs.github.com/en/contributing) for additional information about how to write and collaborate the GitHub Docs way. Here, you'll find additional information that might be helpful as you work on a pull request in this repo. diff --git a/contributing/code-annotations.md b/contributing/code-annotations.md index ffa0071ee9c7..0f318d3018be 100644 --- a/contributing/code-annotations.md +++ b/contributing/code-annotations.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Annotating code examples](https://docs.github.com/en/contributing/writing-for-github-docs/annotating-code-examples)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Annotating code examples](https://docs.github.com/en/contributing/writing-for-github-docs/annotating-code-examples) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/codespace.md b/contributing/codespace.md index 5ca5171d051a..ee9349ef1598 100644 --- a/contributing/codespace.md +++ b/contributing/codespace.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Working on a GitHub Docs in a codespace](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Working on a GitHub Docs in a codespace](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/content-markup-reference.md b/contributing/content-markup-reference.md index 1d113fa84256..39684f83096a 100644 --- a/contributing/content-markup-reference.md +++ b/contributing/content-markup-reference.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/content-model.md b/contributing/content-model.md index 4bfe68ee0d32..ce214bbc8065 100644 --- a/contributing/content-model.md +++ b/contributing/content-model.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Style guide and content model](https://docs.github.com/en/contributing/style-guide-and-content-model)" in the GitHub Docs for the maintained version of this content. \ No newline at end of file +The content in the `contributing` directory has been deprecated. See [Style guide and content model](https://docs.github.com/en/contributing/style-guide-and-content-model) in the GitHub Docs for the maintained version of this content. \ No newline at end of file diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 0608681e6c22..33ceb7ae80e3 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Style guide](https://docs.github.com/contributing/style-guide-and-content-model/style-guide)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Style guide](https://docs.github.com/contributing/style-guide-and-content-model/style-guide) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/content-templates.md b/contributing/content-templates.md index a23749f93d24..0f3e3cae589e 100644 --- a/contributing/content-templates.md +++ b/contributing/content-templates.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Templates](https://docs.github.com/en/contributing/writing-for-github-docs/templates)" in the GitHub Docs for the maintained version of this content. +The content in the `contributing` directory has been deprecated. See [Templates](https://docs.github.com/en/contributing/writing-for-github-docs/templates) in the GitHub Docs for the maintained version of this content. diff --git a/contributing/development.md b/contributing/development.md index c1c027e96428..ed0e53c5b4b5 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -32,7 +32,7 @@ Power users may want to read more about [debugging the docs application](./debug ### Using GitHub Codespaces -As an alternative, you can simply use [GitHub Codespaces](https://docs.github.com/en/codespaces/overview). For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)." +As an alternative, you can simply use [GitHub Codespaces](https://docs.github.com/en/codespaces/overview). For more information about using a codespace for working on GitHub documentation, see [Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md). In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser. diff --git a/contributing/how-to-use-labels.md b/contributing/how-to-use-labels.md index be900ffd37c8..41e557fd8b18 100644 --- a/contributing/how-to-use-labels.md +++ b/contributing/how-to-use-labels.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" in the GitHub Docs for the maintained version of this content. +The content in the `contributing` directory has been deprecated. See [Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference) in the GitHub Docs for the maintained version of this content. diff --git a/contributing/images-and-versioning.md b/contributing/images-and-versioning.md index 26e9025c19ff..bd7e117c2322 100644 --- a/contributing/images-and-versioning.md +++ b/contributing/images-and-versioning.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Creating screenshots](https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Creating screenshots](https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/liquid-helpers.md b/contributing/liquid-helpers.md index 74c04bb32ff8..bba0c5fcc0ff 100644 --- a/contributing/liquid-helpers.md +++ b/contributing/liquid-helpers.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation#versioning-with-liquid-conditional-operators)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Versioning documentation](https://docs.github.com/en/contributing/writing-for-github-docs/versioning-documentation#versioning-with-liquid-conditional-operators) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/redirects.md b/contributing/redirects.md index eaa8eea18770..4ec4f0e2faf5 100644 --- a/contributing/redirects.md +++ b/contributing/redirects.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Configuring redirects](https://docs.github.com/en/contributing/writing-for-github-docs/configuring-redirects)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Configuring redirects](https://docs.github.com/en/contributing/writing-for-github-docs/configuring-redirects) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/self-review.md b/contributing/self-review.md index 77b24ecbdf86..cb800716dd82 100644 --- a/contributing/self-review.md +++ b/contributing/self-review.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/tool-switcher.md b/contributing/tool-switcher.md index 1ce4a3e33ab2..20a718809047 100644 --- a/contributing/tool-switcher.md +++ b/contributing/tool-switcher.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Creating tool switchers in articles](https://docs.github.com/en/contributing/writing-for-github-docs/creating-tool-switchers-in-articles)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Creating tool switchers in articles](https://docs.github.com/en/contributing/writing-for-github-docs/creating-tool-switchers-in-articles) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/translations-for-writers.md b/contributing/translations-for-writers.md index 78a9cdd9cde6..5fa14a3cf1e9 100644 --- a/contributing/translations-for-writers.md +++ b/contributing/translations-for-writers.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Writing content to be translated](https://docs.github.com/en/contributing/writing-for-github-docs/writing-content-to-be-translated)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Writing content to be translated](https://docs.github.com/en/contributing/writing-for-github-docs/writing-content-to-be-translated) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/troubleshooting.md b/contributing/troubleshooting.md index b9c236c77f15..a2613075d955 100644 --- a/contributing/troubleshooting.md +++ b/contributing/troubleshooting.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Troubleshooting your environment](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Troubleshooting your environment](https://docs.github.com/en/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment) in the GitHub Docs for the maintained version of this article. diff --git a/contributing/videos.md b/contributing/videos.md index c922e6b35af8..41e64cf17d72 100644 --- a/contributing/videos.md +++ b/contributing/videos.md @@ -1 +1 @@ -The content in the `contributing` directory has been deprecated. See "[Using videos in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-videos-in-github-docs)" in the GitHub Docs for the maintained version of this article. +The content in the `contributing` directory has been deprecated. See [Using videos in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-videos-in-github-docs) in the GitHub Docs for the maintained version of this article. diff --git a/data/reusables/actions/actions-use-policy-settings.md b/data/reusables/actions/actions-use-policy-settings.md index 6dfff5f003b7..14d3c9ef5c98 100644 --- a/data/reusables/actions/actions-use-policy-settings.md +++ b/data/reusables/actions/actions-use-policy-settings.md @@ -1,3 +1,3 @@ -If you choose {% data reusables.actions.policy-label-for-select-actions-workflows %}, actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} within your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %} are allowed, and there are additional options for allowing other specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}. For more information, see "[Allowing select actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to run](#allowing-select-actions{% ifversion actions-workflow-policy %}-and-reusable-workflows{% endif %}-to-run)." +If you choose {% data reusables.actions.policy-label-for-select-actions-workflows %}, actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} within your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %} are allowed, and there are additional options for allowing other specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}. For more information, see [Allowing select actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to run](#allowing-select-actions{% ifversion actions-workflow-policy %}-and-reusable-workflows{% endif %}-to-run). {% ifversion ghec or fpt %}When you allow actions{% ifversion actions-workflow-policy %} and reusable workflows from only in{% else %} local to{% endif %} your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %}, the policy blocks all access to actions authored by {% data variables.product.prodname_dotcom %}. For example, the [`actions/checkout`](https://github.com/actions/checkout) action would not be accessible.{% endif %} diff --git a/data/reusables/actions/viewing-actions-metrics.md b/data/reusables/actions/viewing-actions-metrics.md index 765dea68c5a3..27918faf6afc 100644 --- a/data/reusables/actions/viewing-actions-metrics.md +++ b/data/reusables/actions/viewing-actions-metrics.md @@ -1,6 +1,6 @@ 1. In the "Insights" navigation menu, click **Actions Usage Metrics** or click **Actions Performance Metrics**. 1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. For more information, see [Understanding {% data variables.product.prodname_actions %} metrics aggregation](#understanding-github-actions-metrics-aggregation). -1. Click on the tab that contains the metrics you would like to view. For more information, see "[About {% data variables.product.prodname_actions %} usage metrics](#about-github-actions-usage-metrics) or [About {% data variables.product.prodname_actions %} performance metrics](#about-github-actions-performance-metrics). +1. Click on the tab that contains the metrics you would like to view. For more information, see [About {% data variables.product.prodname_actions %} usage metrics](#about-github-actions-usage-metrics) or [About {% data variables.product.prodname_actions %} performance metrics](#about-github-actions-performance-metrics). 1. Optionally, to filter the data displayed in a tab, create a filter. 1. Click on the **{% octicon "filter" aria-hidden="true" %} Filter** button. 1. Click **{% octicon "plus" aria-hidden="true" %} Add a filter**. diff --git a/data/reusables/actions/workflow-basic-example-and-explanation.md b/data/reusables/actions/workflow-basic-example-and-explanation.md index 5b13d6d031c5..8e34e9263e56 100644 --- a/data/reusables/actions/workflow-basic-example-and-explanation.md +++ b/data/reusables/actions/workflow-basic-example-and-explanation.md @@ -35,10 +35,10 @@ To help you understand how YAML syntax is used to create a workflow file, this s # Optional - The name of the workflow as it will appear in the "Actions" tab of the {% data variables.product.prodname_dotcom %} repository. If this field is omitted, the name of the workflow file will be used instead. name: learn-github-actions -# Optional - The name for workflow runs generated from the workflow, which will appear in the list of workflow runs on your repository's "Actions" tab. This example uses an expression with the `github` context to display the username of the actor that triggered the workflow run. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#run-name)." +# Optional - The name for workflow runs generated from the workflow, which will appear in the list of workflow runs on your repository's "Actions" tab. This example uses an expression with the `github` context to display the username of the actor that triggered the workflow run. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#run-name). run-name: {% raw %}${{ github.actor }}{% endraw %} is learning GitHub Actions -# Specifies the trigger for this workflow. This example uses the `push` event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "[AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)." +# Specifies the trigger for this workflow. This example uses the `push` event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see [AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore). on: [push] # Groups together all the jobs that run in the `learn-github-actions` workflow. @@ -47,7 +47,7 @@ jobs: # Defines a job named `check-bats-version`. The child keys will define properties of the job. check-bats-version: -# Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see "[AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)" +# Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see [AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) runs-on: ubuntu-latest # Groups together all the steps that run in the `check-bats-version` job. Each item nested under this section is a separate action or shell script. diff --git a/data/reusables/actions/workflow-dispatch-inputs.md b/data/reusables/actions/workflow-dispatch-inputs.md index 9a8d0db95559..8a777d26d5a7 100644 --- a/data/reusables/actions/workflow-dispatch-inputs.md +++ b/data/reusables/actions/workflow-dispatch-inputs.md @@ -1,3 +1,3 @@ -The triggered workflow receives the inputs in the {% ifversion actions-unified-inputs %}`inputs`{% else %}`github.event.inputs`{% endif %} context. For more information, see "[Contexts]({% ifversion actions-unified-inputs %}/actions/learn-github-actions/contexts#inputs-context{% else %}/actions/learn-github-actions/contexts#github-context{% endif %})." +The triggered workflow receives the inputs in the {% ifversion actions-unified-inputs %}`inputs`{% else %}`github.event.inputs`{% endif %} context. For more information, see [Contexts]({% ifversion actions-unified-inputs %}/actions/learn-github-actions/contexts#inputs-context{% else %}/actions/learn-github-actions/contexts#github-context{% endif %}). {% data reusables.actions.inputs-vs-github-event-inputs %} diff --git a/data/reusables/dependabot/access-private-dependencies-link.md b/data/reusables/dependabot/access-private-dependencies-link.md index 9a640d980514..10e8097a1d5e 100644 --- a/data/reusables/dependabot/access-private-dependencies-link.md +++ b/data/reusables/dependabot/access-private-dependencies-link.md @@ -1 +1 @@ -Dependencies sourced directly from a {% data variables.product.prodname_dotcom %} repository give {% data variables.product.prodname_dependabot %} access to the repository through the {% data variables.product.prodname_dotcom %} UI. For information about allowing {% data variables.product.prodname_dependabot %} to access private {% data variables.product.prodname_dotcom %} dependencies, see "[Allowing {% data variables.product.prodname_dependabot %} to access private dependencies](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private{% ifversion ghec or ghes %}-or-internal{% endif %}-dependencies)." +Dependencies sourced directly from a {% data variables.product.prodname_dotcom %} repository give {% data variables.product.prodname_dependabot %} access to the repository through the {% data variables.product.prodname_dotcom %} UI. For information about allowing {% data variables.product.prodname_dependabot %} to access private {% data variables.product.prodname_dotcom %} dependencies, see [Allowing {% data variables.product.prodname_dependabot %} to access private dependencies](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private{% ifversion ghec or ghes %}-or-internal{% endif %}-dependencies). diff --git a/data/reusables/dependabot/dependabot-ignore-dependencies.md b/data/reusables/dependabot/dependabot-ignore-dependencies.md index a1ef1ce36a97..7da2e35ddf9b 100644 --- a/data/reusables/dependabot/dependabot-ignore-dependencies.md +++ b/data/reusables/dependabot/dependabot-ignore-dependencies.md @@ -1,4 +1,4 @@ If you want to ignore updates for the dependency, you must do one of the following. * Configure an `ignore` rule for the dependency in the `dependabot.yml` file. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#ignore). -* Use the `@dependabot ignore` comment command for the dependency in the pull request for the grouped updates. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-for-grouped-{% ifversion dependabot-grouped-security-updates-config %}{% else %}version-{% endif %}updates-with-comment-commands)." +* Use the `@dependabot ignore` comment command for the dependency in the pull request for the grouped updates. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-for-grouped-{% ifversion dependabot-grouped-security-updates-config %}{% else %}version-{% endif %}updates-with-comment-commands). diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index d9ae8da1eef9..188047409137 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -136,7 +136,7 @@ pnpm is supported for {% data variables.product.prodname_dependabot_version_upda {% ifversion dependabot-updates-pub-private-registry %} -You can use {% data variables.product.prodname_dependabot %} to keep Dart dependencies up-to-date if you use private hosted pub repositories. For information about allowing {% data variables.product.prodname_dependabot %} to access private {% data variables.product.prodname_dotcom %} dependencies, see "[Allowing {% data variables.product.prodname_dependabot %} to access private dependencies](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private{% ifversion ghec or ghes %}-or-internal{% endif %}-dependencies)." +You can use {% data variables.product.prodname_dependabot %} to keep Dart dependencies up-to-date if you use private hosted pub repositories. For information about allowing {% data variables.product.prodname_dependabot %} to access private {% data variables.product.prodname_dotcom %} dependencies, see [Allowing {% data variables.product.prodname_dependabot %} to access private dependencies](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private{% ifversion ghec or ghes %}-or-internal{% endif %}-dependencies). {% endif %} diff --git a/data/reusables/enterprise-migration-tool/blob-storage-management-console.md b/data/reusables/enterprise-migration-tool/blob-storage-management-console.md index 4e5e27a6dea8..fc0db11e20f1 100644 --- a/data/reusables/enterprise-migration-tool/blob-storage-management-console.md +++ b/data/reusables/enterprise-migration-tool/blob-storage-management-console.md @@ -1,4 +1,4 @@ -After you set up an AWS S3 storage bucket or Azure Blob Storage storage account, configure blob storage in the {% data variables.enterprise.management_console %} of {% data variables.location.product_location_enterprise %}. For more information about the {% data variables.enterprise.management_console %}, see "[Administering your instance from the Management Console]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/administering-your-instance-from-the-management-console)." +After you set up an AWS S3 storage bucket or Azure Blob Storage storage account, configure blob storage in the {% data variables.enterprise.management_console %} of {% data variables.location.product_location_enterprise %}. For more information about the {% data variables.enterprise.management_console %}, see [Administering your instance from the Management Console]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/administering-your-instance-from-the-management-console). 1. From an administrative account on {% data variables.product.prodname_ghe_server %}, in the upper-right corner of any page, click {% octicon "rocket" aria-label="Site admin" %}. 1. If you're not already on the "Site admin" page, in the upper-left corner, click **Site admin**. @@ -6,7 +6,7 @@ After you set up an AWS S3 storage bucket or Azure Blob Storage storage account, 1. Log into the {% data variables.enterprise.management_console %}. 1. In the top navigation bar, click **Settings**. 1. Under **Migrations**, click **Enable {% data variables.product.company_short %} Migrations**. -1. Optionally, to import storage settings you configured for {% data variables.product.prodname_actions %}, select **Copy Storage settings from Actions**. For more information see, "[Enabling GitHub Actions with Azure Blob storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage)" and "[Enabling GitHub Actions with Amazon S3 storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage)." +1. Optionally, to import storage settings you configured for {% data variables.product.prodname_actions %}, select **Copy Storage settings from Actions**. For more information see, [Enabling GitHub Actions with Azure Blob storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage) and [Enabling GitHub Actions with Amazon S3 storage]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage). > [!NOTE] > After copying your storage settings, you may still need to update the configuration of your cloud storage account to work with {% data variables.product.prodname_importer_proper_name %}. In particular, you must ensure that {% data variables.product.prodname_dotcom %}'s IP addresses are allowlisted. For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/managing-access-for-a-migration-between-github-products#configuring-ip-allow-lists-for-migrations). diff --git a/data/reusables/enterprise/azure-maps-auth-deprecation-link.md b/data/reusables/enterprise/azure-maps-auth-deprecation-link.md index 825e0b4ba316..2376c34dc315 100644 --- a/data/reusables/enterprise/azure-maps-auth-deprecation-link.md +++ b/data/reusables/enterprise/azure-maps-auth-deprecation-link.md @@ -1 +1 @@ -For more information, see the "[Deprecations](/admin/release-notes#{{ allVersions[currentVersion].currentRelease }}.{% ifversion ghes = 3.10 %}4{% elsif ghes = 3.11 %}1{% endif %}-deprecations)" section in the release notes. +For more information, see the [Deprecations](/admin/release-notes#{{ allVersions[currentVersion].currentRelease }}.{% ifversion ghes = 3.10 %}4{% elsif ghes = 3.11 %}1{% endif %}-deprecations) section in the release notes. diff --git a/data/reusables/enterprise/enterprise-types.md b/data/reusables/enterprise/enterprise-types.md index 00471010324f..a94daa3fd489 100644 --- a/data/reusables/enterprise/enterprise-types.md +++ b/data/reusables/enterprise/enterprise-types.md @@ -5,4 +5,4 @@ While setting up your trial of {% data variables.product.prodname_ghe_cloud %}, * Enterprise with personal accounts * Enterprise with managed users -To help you decide which choice is best for your enterprise, see "[AUTOTITLE]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/understanding-iam-for-enterprises/choosing-an-enterprise-type-for-github-enterprise-cloud){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +To help you decide which choice is best for your enterprise, see [AUTOTITLE]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/understanding-iam-for-enterprises/choosing-an-enterprise-type-for-github-enterprise-cloud){% ifversion not ghec %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} diff --git a/data/reusables/enterprise_installation/ssh-into-instance.md b/data/reusables/enterprise_installation/ssh-into-instance.md index 61a46d915b6b..c5d59428cac0 100644 --- a/data/reusables/enterprise_installation/ssh-into-instance.md +++ b/data/reusables/enterprise_installation/ssh-into-instance.md @@ -1,4 +1,4 @@ -1. SSH into {% data variables.location.product_location %}. If your instance comprises multiple nodes, for example if high availability or geo-replication are configured, SSH into the primary node. If you use a cluster, you can SSH into any node. Replace HOSTNAME with the hostname for your instance, or the hostname or IP address of a node. For more information, see "[AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." +1. SSH into {% data variables.location.product_location %}. If your instance comprises multiple nodes, for example if high availability or geo-replication are configured, SSH into the primary node. If you use a cluster, you can SSH into any node. Replace HOSTNAME with the hostname for your instance, or the hostname or IP address of a node. For more information, see [AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh). ```shell copy ssh -p 122 admin@HOSTNAME diff --git a/data/reusables/enterprise_installation/ssh-into-target-instance.md b/data/reusables/enterprise_installation/ssh-into-target-instance.md index b907c703659c..560bd1a8c7bc 100644 --- a/data/reusables/enterprise_installation/ssh-into-target-instance.md +++ b/data/reusables/enterprise_installation/ssh-into-target-instance.md @@ -1,4 +1,4 @@ -1. SSH into your target {% data variables.product.prodname_ghe_server %} instance. For more information, see "[AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." +1. SSH into your target {% data variables.product.prodname_ghe_server %} instance. For more information, see [AUTOTITLE]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh). ```shell ssh -p 122 admin@HOSTNAME diff --git a/data/reusables/gated-features/enterprise-accounts.md b/data/reusables/gated-features/enterprise-accounts.md index e9af8cba1b5e..26a07384307b 100644 --- a/data/reusables/gated-features/enterprise-accounts.md +++ b/data/reusables/gated-features/enterprise-accounts.md @@ -1 +1 @@ -Enterprise accounts are available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. For more information, see "[About enterprise accounts]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/overview/about-enterprise-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +Enterprise accounts are available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. For more information, see [About enterprise accounts]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/overview/about-enterprise-accounts){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} diff --git a/data/reusables/organizations/team-synchronization.md b/data/reusables/organizations/team-synchronization.md index 72677402e717..1cf827a3d071 100644 --- a/data/reusables/organizations/team-synchronization.md +++ b/data/reusables/organizations/team-synchronization.md @@ -1,3 +1,3 @@ {% ifversion fpt or ghec %} -{% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %}{% else %}You{% endif %} can use team synchronization to automatically add and remove organization members to teams through an identity provider. For more information, see "[Synchronizing a team with an identity provider group]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +{% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %}{% else %}You{% endif %} can use team synchronization to automatically add and remove organization members to teams through an identity provider. For more information, see [Synchronizing a team with an identity provider group]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %} {% endif %} diff --git a/data/reusables/package_registry/publish-docker-image.md b/data/reusables/package_registry/publish-docker-image.md index 1b0a8043029e..32be7c51fd7c 100644 --- a/data/reusables/package_registry/publish-docker-image.md +++ b/data/reusables/package_registry/publish-docker-image.md @@ -44,7 +44,7 @@ jobs: with: images: {% raw %}${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}{% endraw %} # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to {% data variables.product.prodname_registry %}. - # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. + # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see [Usage](https://github.com/docker/build-push-action#usage) in the README of the `docker/build-push-action` repository. # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. - name: Build and push Docker image id: push @@ -55,7 +55,7 @@ jobs: tags: {% raw %}${{ steps.meta.outputs.tags }}{% endraw %} labels: {% raw %}${{ steps.meta.outputs.labels }}{% endraw %} {% ifversion artifact-attestations %} - # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)." + # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). - name: Generate artifact attestation uses: actions/attest-build-provenance@v2 with: diff --git a/data/reusables/scim/public-scim-put-or-patch-group-audit-log-events.md b/data/reusables/scim/public-scim-put-or-patch-group-audit-log-events.md index 51c689c2d6d6..d593623a97ba 100644 --- a/data/reusables/scim/public-scim-put-or-patch-group-audit-log-events.md +++ b/data/reusables/scim/public-scim-put-or-patch-group-audit-log-events.md @@ -1 +1 @@ - + diff --git a/data/reusables/secret-scanning/alert-type-links.md b/data/reusables/secret-scanning/alert-type-links.md index d8947273130d..2726f22f8340 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/src/content-linter/README.md b/src/content-linter/README.md index acd88652f2ca..b4fcea1f8bef 100644 --- a/src/content-linter/README.md +++ b/src/content-linter/README.md @@ -1,6 +1,6 @@ # Content Linter -For an overview of what the content linter is and how to use it, see "[Using the content linter](/content/contributing/collaborating-on-github-docs/using-the-content-linter.md)." +For an overview of what the content linter is and how to use it, see [Using the content linter](/content/contributing/collaborating-on-github-docs/using-the-content-linter.md). This README shows you how to contribute to the content linter code by adding new rules, modifying existing rules, or updating the scripts used to run the content linter. @@ -162,7 +162,7 @@ Severity can be set to either `error` or `warning`. A severity of `warning` is n Ideally, all rules will be set to `error` severity. However, there may be cases when too many violations exist in the content to fix or disable them all. In these cases we can temporarily set a rule to `warning`, and then update the rule to `error` severity after all cases have been fixed or disabled. However, there may be a case at some point where we need to keep a rule set to `warning` indefinitely. -For more info, see "[Updating content to adhere to a new rule](#updating-content-to-adhere-to-a-new-rule)." +For more info, see [Updating content to adhere to a new rule](#updating-content-to-adhere-to-a-new-rule). ### `partial-markdown-files` diff --git a/src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md b/src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md index 53e4f4008a63..692e00e0d298 100644 --- a/src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md +++ b/src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md @@ -14,4 +14,4 @@ which should not work. ## The experiment -See "[AUTOTITLE](#introduction)." +See [AUTOTITLE](#introduction). diff --git a/src/fixtures/fixtures/content/get-started/foo/autotitling.md b/src/fixtures/fixtures/content/get-started/foo/autotitling.md index 96d843604f9f..a004110dd4e5 100644 --- a/src/fixtures/fixtures/content/get-started/foo/autotitling.md +++ b/src/fixtures/fixtures/content/get-started/foo/autotitling.md @@ -13,7 +13,7 @@ type: how_to Links that use the word `AUTOTITLE` in the Markdown become the title of the document it links to. -For example "[AUTOTITLE](/get-started/start-your-journey/hello-world)." +For example [AUTOTITLE](/get-started/start-your-journey/hello-world). It should also work if the URL as a query string, like this: [AUTOTITLE](/get-started/start-your-journey/hello-world?tool=linux) diff --git a/src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md b/src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md index 277201126d47..6ad96bf19517 100644 --- a/src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md +++ b/src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md @@ -11,10 +11,10 @@ type: how_to {% ifversion ghes %} -"[Autotitle](/get-started/start-your-journey/hello-world)." +[Autotitle](/get-started/start-your-journey/hello-world). {% else %} -"[AUTOTITLES](/get-started/start-your-journey/hello-world)." +[AUTOTITLES](/get-started/start-your-journey/hello-world). {% endif %} diff --git a/src/fixtures/fixtures/content/get-started/start-your-journey/hello-world.md b/src/fixtures/fixtures/content/get-started/start-your-journey/hello-world.md index 1794c344596f..d4dc27b9a874 100644 --- a/src/fixtures/fixtures/content/get-started/start-your-journey/hello-world.md +++ b/src/fixtures/fixtures/content/get-started/start-your-journey/hello-world.md @@ -26,9 +26,9 @@ like "Enterprise Server X.Y". It should change the above sentence. ## Link to a page with variable title -"[AUTOTITLE](/get-started/start-your-journey/dynamic-title)" +[AUTOTITLE](/get-started/start-your-journey/dynamic-title) -"[AUTOTITLE](/get-started/foo/cross-version-linking)" +[AUTOTITLE](/get-started/foo/cross-version-linking) ## Use of a reusable that might have auto-title links diff --git a/src/fixtures/fixtures/content/get-started/start-your-journey/link-rewriting.md b/src/fixtures/fixtures/content/get-started/start-your-journey/link-rewriting.md index 1e9bfb9722a4..e3eadce8c368 100644 --- a/src/fixtures/fixtures/content/get-started/start-your-journey/link-rewriting.md +++ b/src/fixtures/fixtures/content/get-started/start-your-journey/link-rewriting.md @@ -10,7 +10,7 @@ type: quick_start ## Internal links never need language prefix -"[AUTOTITLE](/get-started/foo/cross-version-linking)" already tests things +[AUTOTITLE](/get-started/foo/cross-version-linking) already tests things like `/enterprise-server@latest/` becomes `/enterprise-server@X.Y/` where `X.Y` is the latest Enterprise server version. diff --git a/src/fixtures/fixtures/content/pages/quickstart.md b/src/fixtures/fixtures/content/pages/quickstart.md index 9f281a4c83f2..bf7dcdb23fc5 100644 --- a/src/fixtures/fixtures/content/pages/quickstart.md +++ b/src/fixtures/fixtures/content/pages/quickstart.md @@ -7,7 +7,7 @@ versions: ghes: '*' ghec: '*' type: quick_start -permissions: These are permissions details, for more pages info start at the beginning with this "[article intro link](#introduction)". Also here's [another link](/get-started/start-your-journey/hello-world). +permissions: These are permissions details, for more pages info start at the beginning with this [article intro link](#introduction). Also here's [another link](/get-started/start-your-journey/hello-world). topics: - Pages shortTitle: Quickstart @@ -20,7 +20,7 @@ This page has 6 links that should show preview popovers on hover. ## Regular internal link -But learn more on "[AUTOTITLE](/get-started/start-your-journey)." +But learn more on [AUTOTITLE](/get-started/start-your-journey). ## Internal links with formatted link text diff --git a/src/fixtures/fixtures/data/reusables/gated-features/more-info.md b/src/fixtures/fixtures/data/reusables/gated-features/more-info.md index a07603250bd4..33b22ccb17a6 100644 --- a/src/fixtures/fixtures/data/reusables/gated-features/more-info.md +++ b/src/fixtures/fixtures/data/reusables/gated-features/more-info.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}For more information, see "[AUTOTITLE](/get-started/start-your-journey/hello-world)."{% endif %} +{% ifversion fpt or ghec %}For more information, see [AUTOTITLE](/get-started/start-your-journey/hello-world).{% endif %} diff --git a/src/fixtures/fixtures/translations/ja-jp/content/get-started/start-your-journey/hello-world.md b/src/fixtures/fixtures/translations/ja-jp/content/get-started/start-your-journey/hello-world.md index 0c5b872ef528..5d5235e585d5 100644 --- a/src/fixtures/fixtures/translations/ja-jp/content/get-started/start-your-journey/hello-world.md +++ b/src/fixtures/fixtures/translations/ja-jp/content/get-started/start-your-journey/hello-world.md @@ -18,7 +18,7 @@ recover from it. ["AUTOTITLE](/get-started/start-your-journey/dynamic-title)" -"[AUTOTITLE](/get-started/foo/cross-version-linking)" +[AUTOTITLE](/get-started/foo/cross-version-linking) ## Use of a reusable that might have auto-title links diff --git a/src/ghes-releases/lib/release-templates/release-steps-1.md b/src/ghes-releases/lib/release-templates/release-steps-1.md index 4f01a44dc099..a8eae61373d0 100644 --- a/src/ghes-releases/lib/release-templates/release-steps-1.md +++ b/src/ghes-releases/lib/release-templates/release-steps-1.md @@ -74,13 +74,13 @@ To enable a new version of GHES on GitHub Docs, update the site's supported vers - [ ] Add and commit the changes. -- [ ] Optionally, on your workstation, run the local development environment for GitHub Docs and verify that the new GHES version is enabled. See "[About versions of GitHub Docs](https://docs.github.com/get-started/learning-about-github/about-versions-of-github-docs)". +- [ ] Optionally, on your workstation, run the local development environment for GitHub Docs and verify that the new GHES version is enabled. See [About versions of GitHub Docs](https://docs.github.com/get-started/learning-about-github/about-versions-of-github-docs). - [ ] Push your changes. - [ ] Create a PR. For the body, copy the contents of the body comment for the [previous release](https://github.com/github/docs-internal/pull/44684), modifying it to reflect this release. -- [ ] Link your PR to this issue. See "[Linking a pull request to an issue](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar)". +- [ ] Link your PR to this issue. See [Linking a pull request to an issue](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar).
diff --git a/src/ghes-releases/lib/release-templates/release-steps-2.md b/src/ghes-releases/lib/release-templates/release-steps-2.md index 6b66b1361a8e..45c2c15840b7 100644 --- a/src/ghes-releases/lib/release-templates/release-steps-2.md +++ b/src/ghes-releases/lib/release-templates/release-steps-2.md @@ -36,7 +36,7 @@ To prepare for a GHES RC, you will: Each day, review [GHES release slack channel][ghes-release-slack-channel-link] on Slack for any potential late-breaking content changes. - Most conversation is operational and relates to preparation of the release builds, with no docs impact. -- Typically, at this phase, any content changes would relate to content in the "[Enterprise administrators](https://docs.github.com/en/enterprise-server/admin)" docset. If you see discussion about end-user features, investigate further. +- Typically, at this phase, any content changes would relate to content in the [Enterprise administrators](https://docs.github.com/en/enterprise-server/admin) docset. If you see discussion about end-user features, investigate further. - If you're uncertain whether the conversation relates to changes that could affect the docs, ask the following questions. - [Which audience](https://github.com/github/docs-content/blob/main/focus-areas/enterprise/writing-for-enterprise/audiences.md) is affected? - Is there any change in behavior or functionality that might affect the public docs? For example, is a feature pulled from the release? @@ -120,9 +120,9 @@ For each item in the Release Tracker project's [GHES Docs][ghes-release-tracker- During [validation](#validation), if you set the "GHES docs status" field for any issues in the Release Tracker project's [GHES Docs][ghes-release-tracker-project-board-link] view to "[Needs versioning][ghes-release-tracker-needs-versioning-query]", create a single PR to correct the versioning. - Target `main` to get the changes published as soon as possible, particularly if any items slipped from the previous GHES release. -- If a change was supposed to be in a previous release but you needed to update the versioning to reflect that it's in this upcoming release, you may need to relocate the release note for the feature in the prior version into the "[Errata](https://github.com/github/docs-internal/blob/main/contributing/content-style-guide.md#errata)" section and include the release note in the upcoming release. +- If a change was supposed to be in a previous release but you needed to update the versioning to reflect that it's in this upcoming release, you may need to relocate the release note for the feature in the prior version into the [Errata](https://github.com/github/docs-internal/blob/main/contributing/content-style-guide.md#errata) section and include the release note in the upcoming release. -After you merge the PR, update the status for each item in the Release Tracker project's [GHES Docs][ghes-release-tracker-project-board-link] view with a "GHES docs status" field set to "[Needs versioning][ghes-release-tracker-needs-versioning-query]". +After you merge the PR, update the status for each item in the Release Tracker project's [GHES Docs][ghes-release-tracker-project-board-link] view with a "GHES docs status" field set to [Needs versioning][ghes-release-tracker-needs-versioning-query].
@@ -180,7 +180,7 @@ At least a week before the ship date for the RC, request review of the PR with t 1. After you've received writer and PM approval, merge the PR into the topic branch that you created for the PR to close {{ release-steps-1-url }}. -1. Link the PR to this issue as well. See "[Linking a pull request to an issue](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar)". +1. Link the PR to this issue as well. See [Linking a pull request to an issue](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar). 1. To provide other GTM teams like Support Delivery an advance look at changes in the release, share a link to the release notes on the staging deployment and a link to the YAML file in **Files changed** tab within the PR for {{ release-steps-1-url }}. diff --git a/src/ghes-releases/lib/release-templates/release-steps-5.md b/src/ghes-releases/lib/release-templates/release-steps-5.md index 15b9e3501a74..0bc799d1e533 100644 --- a/src/ghes-releases/lib/release-templates/release-steps-5.md +++ b/src/ghes-releases/lib/release-templates/release-steps-5.md @@ -158,7 +158,7 @@ The benefit of the first method is that you don't need to deal with merging two - [ ] Click the green "Run workflow" button. - [ ] Wait for the workflow to finish. It will automatically open a new ["Update OpenAPI Description" PR](https://github.com/github/docs-internal/labels/github-openapi-bot). The workflow output log will include a PR number. - [ ] In the new PR with OpenAPI changes, change the base branch of the PR from `main` to the branch of the to the publication branch you created for https://github.com/github/docs-content/issues/14225. -- [ ] Link the PR to this issue. For more information, see "[Linking a pull request to an issue](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar)". +- [ ] Link the PR to this issue. For more information, see [Linking a pull request to an issue](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar). - [ ] In the "Update OpenAPI Description" PR, ensure that there are no merge conflicts and that checks pass, paying particular attention to links that were broken due to missing OpenAPI-related content. - [ ] Merge "Update OpenAPI Description" PR into your publication PR.. **Note:** Don't attempt to resolve conflicts for changes to the `src/rest/data` files. Only accept the incoming files. If you do see conflicts in the `src/rest/data`, `src/webhooks/data`, or `src/github-apps/data` directories, you can checkout the files for those directories that exist in the main branch, which reverts the changes in those directories to the files in the `main` branch (e.g. `git checkout origin/main src/rest/data/*`).