Merge pull request #17579 from github/repo-sync

Octomerger · web-flow · commit ca85f1b7dd2a · 2022-05-03T02:54:20.000-05:00
repo sync
diff --git a/content/rest/apps/apps.md b/content/rest/apps/apps.md
@@ -1,6 +1,7 @@
 ---
-title: Apps
-intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.'
+title: GitHub Apps
+allowTitleToDifferFromFilename: true
+intro: 'The {% data variables.product.prodname_github_apps %} API enables you to retrieve information about {% data variables.product.prodname_github_apps %}.'
 topics:
   - API
 miniTocMaxHeadingLevel: 3
@@ -11,12 +12,14 @@ versions:
   ghec: '*'
 ---
 
+## About the {% data variables.product.prodname_github_apps %} API
+
 {% data reusables.apps.general-apps-restrictions %}
 
 This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more.
 
 When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app.
 
-You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user.
+You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have text that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user.
 
 A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints.
diff --git a/content/rest/apps/installations.md b/content/rest/apps/installations.md
@@ -1,6 +1,8 @@
 ---
-title: Installations
-intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.'
+title: GitHub App installations
+allowTitleToDifferFromFilename: true
+shortTitle: Installations
+intro: 'The {% data variables.product.prodname_github_app %} installations API enables you to get information about installations of your {% data variables.product.prodname_github_app %} and perform actions within those installations.'
 topics:
   - API
 miniTocMaxHeadingLevel: 3
@@ -11,6 +13,8 @@ versions:
   ghec: '*'
 ---
 
+## About the {% data variables.product.prodname_github_app %} installations API
+
 An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)."
 
 To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)."
diff --git a/content/rest/apps/marketplace.md b/content/rest/apps/marketplace.md
@@ -1,5 +1,7 @@
 ---
-title: Marketplace
+title: GitHub Marketplace
+allowTitleToDifferFromFilename: true
+shortTitle: Marketplace
 intro: ''
 topics:
   - API
@@ -9,6 +11,8 @@ versions:
   ghec: '*'
 ---
 
+## About the {% data variables.product.prodname_marketplace %} API
+
 For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)."
 
 The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription.
diff --git a/content/rest/apps/oauth-applications.md b/content/rest/apps/oauth-applications.md
@@ -1,5 +1,6 @@
 ---
-title: OAuth Applications
+title: OAuth Apps
+allowTitleToDifferFromFilename: true
 intro: ''
 topics:
   - API
@@ -11,4 +12,6 @@ versions:
   ghec: '*'
 ---
 
-You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.
+## About the {% data variables.product.prodname_oauth_app %} API
+
+You can use this API to manage the OAuth tokens an {% data variables.product.prodname_oauth_app %} uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.
diff --git a/content/rest/apps/webhooks.md b/content/rest/apps/webhooks.md
@@ -1,5 +1,7 @@
 ---
-title: Webhooks
+title: GitHub App webhooks
+allowTitleToDifferFromFilename: true
+shortTitle: Webhooks
 intro: ''
 topics:
   - API
@@ -11,4 +13,6 @@ versions:
   ghec: '*'
 ---
 
+## About the {% data variables.product.prodname_github_app %} webhooks API
+
 A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %}
diff --git a/content/rest/codespaces/codespaces.md b/content/rest/codespaces/codespaces.md
@@ -11,4 +11,6 @@ miniTocMaxHeadingLevel: 3
 
 {% data reusables.codespaces.codespaces-api-beta-note %}
 
+## About the Codespaces API
+
 The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)."
diff --git a/content/rest/codespaces/machines.md b/content/rest/codespaces/machines.md
@@ -1,6 +1,8 @@
 ---
-title: Machines
-intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.'
+title: Codespaces machines
+allowTitleToDifferFromFilename: true
+shortTitle: Machines
+intro: 'The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.'
 versions:
   fpt: '*'
   ghec: '*'
@@ -9,6 +11,8 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
-For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."
+## About the Codespaces machines API
+
+The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."
 
 You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)."
diff --git a/content/rest/codespaces/repository-secrets.md b/content/rest/codespaces/repository-secrets.md
@@ -1,6 +1,8 @@
 ---
-title: Repository Secrets
-intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.'
+title: Codespaces repository secrets
+allowTitleToDifferFromFilename: true
+shortTitle: Repository secrets
+intro: 'The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to in a codespace.'
 versions:
   fpt: '*'
   ghec: '*'
@@ -10,6 +12,6 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
-## Repository Secrets
+## About the Codespaces repository secrets API
 
-The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
+The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
diff --git a/content/rest/codespaces/secrets.md b/content/rest/codespaces/secrets.md
@@ -1,15 +1,16 @@
 ---
-title: User Secrets
-intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.'
+title: Codespaces user secrets
+allowTitleToDifferFromFilename: true
+shortTitle: User secrets
+intro: 'The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to in a codespace.'
 versions:
   fpt: '*'
   ghec: '*'
 topics:
   - API
 miniTocMaxHeadingLevel: 3
-allowTitleToDifferFromFilename: true
 ---
 
-## User Secrets
+## About the Codespaces user secrets API
 
-The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
+The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
diff --git a/content/rest/deployments/deployments.md b/content/rest/deployments/deployments.md
@@ -11,6 +11,8 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
+## About the deployments API
+
 Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native).
 
 Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume.
diff --git a/content/rest/deployments/environments.md b/content/rest/deployments/environments.md
@@ -1,6 +1,8 @@
 ---
-title: Environments
-intro: 'The Environments API allows you to create, configure, and delete environments.'
+title: Deployment environments
+allowTitleToDifferFromFilename: true
+shortTitle: Environments
+intro: 'The Deployment environments API allows you to create, configure, and delete deployment environments.'
 versions:
   fpt: '*'
   ghes: '>=3.2'
@@ -11,6 +13,8 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
+## About the Deployment environments API
+
 For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)."
 
 {% data reusables.gated-features.environments %}
diff --git a/content/rest/orgs/members.md b/content/rest/orgs/members.md
@@ -1,5 +1,7 @@
 ---
-title: Members
+title: Organization members
+allowTitleToDifferFromFilename: true
+shortTitle: Members
 intro: ''
 versions:
   fpt: '*'
diff --git a/content/rest/orgs/webhooks.md b/content/rest/orgs/webhooks.md
@@ -1,5 +1,7 @@
 ---
-title: Webhooks
+title: Organization webhooks
+allowTitleToDifferFromFilename: true
+shortTitle: Webhooks
 intro: ''
 versions:
   fpt: '*'
@@ -11,11 +13,13 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
+## About the Organization webhooks API
+
 Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %}
 
 For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)."
 
-### Scopes & Restrictions
+### Scopes and restrictions
 
 All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the `admin:org_hook` scope. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)."
 
diff --git a/content/rest/projects/cards.md b/content/rest/projects/cards.md
@@ -1,6 +1,8 @@
 ---
-title: Cards
-intro: ''
+title: Project board cards
+shortTitle: Cards
+allowTitleToDifferFromFilename: true
+intro: 'The Project board cards API lets you create and manage cards on a project board.'
 versions:
   fpt: '*'
   ghes: '*'
@@ -10,3 +12,5 @@ topics:
   - API
 miniTocMaxHeadingLevel: 3
 ---
+
+{% data reusables.projects.projects-api %}
diff --git a/content/rest/projects/collaborators.md b/content/rest/projects/collaborators.md
@@ -1,6 +1,8 @@
 ---
-title: Collaborators
-intro: "This API allows you to interact with an organization's projects."
+title: Project board collaborators
+shortTitle: Collaborators
+allowTitleToDifferFromFilename: true
+intro: 'The Project board collaborators API lets you manage collaborators on a project board.'
 versions:
   fpt: '*'
   ghes: '*'
@@ -11,3 +13,4 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
+{% data reusables.projects.projects-api %}
diff --git a/content/rest/projects/columns.md b/content/rest/projects/columns.md
@@ -1,6 +1,8 @@
 ---
-title: Columns
-intro: ''
+title: Project board columns
+shortTitle: Columns
+allowTitleToDifferFromFilename: true
+intro: 'The Project board columns API lets you create and manage columns on a project board.'
 versions:
   fpt: '*'
   ghes: '*'
@@ -10,3 +12,5 @@ topics:
   - API
 miniTocMaxHeadingLevel: 3
 ---
+
+{% data reusables.projects.projects-api %}
diff --git a/content/rest/projects/projects.md b/content/rest/projects/projects.md
@@ -1,6 +1,8 @@
 ---
-title: Projects
-intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.'
+title: Project boards
+shortTitle: Boards
+allowTitleToDifferFromFilename: true
+intro: 'The Project boards API lets you create and manage projects in a repository.'
 versions:
   fpt: '*'
   ghes: '*'
@@ -9,4 +11,6 @@ versions:
 topics:
   - API
 miniTocMaxHeadingLevel: 3
----
+---
+
+{% data reusables.projects.projects-api %}
diff --git a/content/rest/teams/discussion-comments.md b/content/rest/teams/discussion-comments.md
@@ -1,5 +1,7 @@
 ---
-title: Discussion Comments
+title: Team discussion comments
+allowTitleToDifferFromFilename: true
+shortTitle: Discussion comments
 intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.'
 versions:
   fpt: '*'
@@ -11,4 +13,8 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
-Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization.
+## About the Team discussion comments API
+
+Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." 
+
+{% data reusables.organizations.team-api %}
diff --git a/content/rest/teams/discussions.md b/content/rest/teams/discussions.md
@@ -1,6 +1,8 @@
 ---
-title: Discussions
-intro: "The Team Discussions API allows you to get, create, edit, and delete discussion posts on a team's page."
+title: Team discussions
+allowTitleToDifferFromFilename: true
+shortTitle: Discussions
+intro: "The Team discussions API allows you to get, create, edit, and delete discussion posts on a team's page."
 versions:
   fpt: '*'
   ghes: '*'
@@ -11,4 +13,8 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
-You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization.
+## About the Team discussions API
+
+You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments).
+
+{% data reusables.organizations.team-api %}
diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md
@@ -1,6 +1,6 @@
 ---
-title: External Groups
-intro: 'The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.'
+title: External groups
+intro: 'The External groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.'
 versions:
   fpt: '*'
   ghae: '*'
@@ -10,6 +10,8 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
+## About the External groups API
+
 To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team.
 
 {% ifversion ghec %}
diff --git a/content/rest/teams/members.md b/content/rest/teams/members.md
@@ -1,5 +1,7 @@
 ---
-title: Members
+title: Team members
+allowTitleToDifferFromFilename: true
+shortTitle: Members
 intro: ''
 versions:
   fpt: '*'
@@ -11,7 +13,9 @@ topics:
 miniTocMaxHeadingLevel: 3
 ---
 
-This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
+## About the Team members API
+
+{% data reusables.organizations.team-api %}
 
 {% ifversion fpt or ghes or ghec %}
 {% note %}
diff --git a/content/rest/teams/team-sync.md b/content/rest/teams/team-sync.md
diff --git a/content/rest/teams/teams.md b/content/rest/teams/teams.md
diff --git a/data/reusables/organizations/team-api.md b/data/reusables/organizations/team-api.md
diff --git a/data/reusables/projects/projects-api.md b/data/reusables/projects/projects-api.md
