Skip to content

Commit

Permalink
update titles for REST API pulls, projects, codespaces docs (#49553)
Browse files Browse the repository at this point in the history
  • Loading branch information
skedwards88 authored Mar 7, 2024
1 parent 389716d commit 96b9791
Show file tree
Hide file tree
Showing 25 changed files with 41 additions and 30 deletions.
12 changes: 6 additions & 6 deletions content/actions/using-workflows/events-that-trigger-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ on:
{% endnote %}
{% endif %}

Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the {% data variables.projects.projects_v1_board %} APIs, see "[AUTOTITLE](/graphql/reference/objects#project)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects)" in the REST API documentation.
Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the {% data variables.projects.projects_v1_board %} APIs, see "[AUTOTITLE](/graphql/reference/objects#project)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects)."

For example, you can run a workflow when a project has been `created` or `deleted`.

Expand Down Expand Up @@ -516,7 +516,7 @@ on:
{% endnote %}
{% endif %}

Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project card APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcard)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#cards)" in the REST API documentation.
Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project card APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcard)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#cards)."

For example, you can run a workflow when a project card has been `created` or `deleted`.

Expand Down Expand Up @@ -554,7 +554,7 @@ on:
{% endnote %}
{% endif %}

Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project column APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcolumn)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#columns)" in the REST API documentation.
Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project column APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcolumn)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#columns)."

For example, you can run a workflow when a project column has been `created` or `deleted`.

Expand Down Expand Up @@ -602,7 +602,7 @@ on:

{% endnote %}

Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. For activity related to pull request reviews, pull request review comments, or pull request comments, use the [`pull_request_review`](#pull_request_review), [`pull_request_review_comment`](#pull_request_review_comment), or [`issue_comment`](#issue_comment) events instead. For information about the pull request APIs, see "[AUTOTITLE](/graphql/reference/objects#pullrequest)" in the GraphQL API documentation or "[AUTOTITLE](/rest/pulls)" in the REST API documentation.
Runs your workflow when activity on a pull request in the workflow's repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. For activity related to pull request reviews, pull request review comments, or pull request comments, use the [`pull_request_review`](#pull_request_review), [`pull_request_review_comment`](#pull_request_review_comment), or [`issue_comment`](#issue_comment) events instead. For information about the pull request APIs, see "[AUTOTITLE](/graphql/reference/objects#pullrequest)" in the GraphQL API documentation or "[AUTOTITLE](/rest/pulls)."

Note that `GITHUB_SHA` for this event is the last merge commit of the pull request merge branch. If you want to get the commit ID for the last commit to the head branch of the pull request, use `github.event.pull_request.head.sha` instead.

Expand Down Expand Up @@ -742,7 +742,7 @@ To run your workflow when a comment on a pull request (not on a pull request's d

{% endnote %}

Runs your workflow when a pull request review is submitted, edited, or dismissed. A pull request review is a group of pull request review comments in addition to a body comment and a state. For activity related to pull request review comments or pull request comments, use the [`pull_request_review_comment`](#pull_request_review_comment) or [`issue_comment`](#issue_comment) events instead. For information about the pull request review APIs, see "[AUTOTITLE](/graphql/reference/objects#pullrequest)" in the GraphQL API documentation or "[AUTOTITLE](/rest/pulls#reviews)" in the REST API documentation.
Runs your workflow when a pull request review is submitted, edited, or dismissed. A pull request review is a group of pull request review comments in addition to a body comment and a state. For activity related to pull request review comments or pull request comments, use the [`pull_request_review_comment`](#pull_request_review_comment) or [`issue_comment`](#issue_comment) events instead. For information about the pull request review APIs, see "[AUTOTITLE](/graphql/reference/objects#pullrequest)" in the GraphQL API documentation or "[AUTOTITLE](/rest/pulls#reviews)."

For example, you can run a workflow when a pull request review has been `edited` or `dismissed`.

Expand Down Expand Up @@ -783,7 +783,7 @@ jobs:

{% endnote %}

Runs your workflow when a pull request review comment is modified. A pull request review comment is a comment on a pull request's diff. For activity related to pull request reviews or pull request comments, use the [`pull_request_review`](#pull_request_review) or [`issue_comment`](#issue_comment) events instead. For information about the pull request review comment APIs, see "[AUTOTITLE](/graphql/reference/objects#pullrequestreviewcomment)" in the GraphQL API documentation or "[AUTOTITLE](/rest/pulls#comments)" in the REST API documentation.
Runs your workflow when a pull request review comment is modified. A pull request review comment is a comment on a pull request's diff. For activity related to pull request reviews or pull request comments, use the [`pull_request_review`](#pull_request_review) or [`issue_comment`](#issue_comment) events instead. For information about the pull request review comment APIs, see "[AUTOTITLE](/graphql/reference/objects#pullrequestreviewcomment)" in the GraphQL API documentation or "[AUTOTITLE](/rest/pulls#comments)."

For example, you can run a workflow when a pull request review comment has been `created` or `deleted`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when
| <pre>merge base into head</pre> | Update of the topic branch from the base branch when the base branch requires strict status checks (via **Update branch** in a pull request, for example) | "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging)" |
| <pre>pull request branch delete button</pre> | Deletion of a topic branch from a pull request in the web interface | "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request#deleting-a-branch-used-for-a-pull-request)" |
| <pre>pull request branch undo button</pre> | Restoration of a topic branch from a pull request in the web interface | "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request#restoring-a-deleted-branch)" |
| <pre>pull request merge api</pre> | Merge of a pull request via the API | "[AUTOTITLE](/rest/pulls#merge-a-pull-request)" in the REST API documentation |
| <pre>pull request merge api</pre> | Merge of a pull request via the API | "[AUTOTITLE](/rest/pulls#merge-a-pull-request)" |
| <pre>pull request merge button</pre> | Merge of a pull request in the web interface | "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request#merging-a-pull-request-on-github)" |
| <pre>pull request revert button</pre> | Revert of a pull request | "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/reverting-a-pull-request)" |
| <pre>releases delete button</pre> | Deletion of a release | "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#deleting-a-release)" |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ You can use the `gh codespace edit --machine MACHINE-TYPE-NAME` {% data variable

## Further reading

- "[AUTOTITLE](/rest/codespaces/machines)" in the REST API documentation
- "[AUTOTITLE](/rest/codespaces/machines)"
- [`gh codespace edit`](https://cli.github.com/manual/gh_codespace_edit) in the {% data variables.product.prodname_cli %} manual
- "[AUTOTITLE](/codespaces/setting-your-user-preferences)"
- "[AUTOTITLE](/codespaces/managing-your-codespaces)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,4 @@ For full details of the options for this command, see [the {% data variables.pro

- "[AUTOTITLE](/codespaces/developing-in-a-codespace/opening-an-existing-codespace)"
- "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces)"
- "[AUTOTITLE](/rest/codespaces)" (REST API reference)
- "[AUTOTITLE](/rest/codespaces)"
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,4 @@ For more information, see [`gh codespace code`](https://cli.github.com/manual/gh

## Further reading

- "[AUTOTITLE](/rest/codespaces)" (REST API reference)
- "[AUTOTITLE](/rest/codespaces)"
4 changes: 3 additions & 1 deletion content/rest/codespaces/codespaces.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Codespaces
title: REST API endpoints for Codespaces
shortTitle: Codespaces
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to manage {% data
variables.product.prodname_github_codespaces %}.
Expand Down
4 changes: 3 additions & 1 deletion content/rest/codespaces/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Codespaces
title: REST API endpoints for Codespaces
shortTitle: Codespaces
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to manage {% data variables.product.prodname_github_codespaces %}.'
versions:
fpt: '*'
Expand Down
2 changes: 1 addition & 1 deletion content/rest/codespaces/machines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Codespaces machines
title: REST API endpoints for Codespaces machines
allowTitleToDifferFromFilename: true
shortTitle: Machines
intro: Use the REST API to manage availability of machine types for a codespace.
Expand Down
2 changes: 1 addition & 1 deletion content/rest/codespaces/organization-secrets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Codespaces organization secrets
title: REST API endpoints for Codespaces organization secrets
allowTitleToDifferFromFilename: true
shortTitle: Organization secrets
intro: >-
Expand Down
2 changes: 1 addition & 1 deletion content/rest/codespaces/organizations.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Codespaces organizations
title: REST API endpoints for Codespaces organizations
allowTitleToDifferFromFilename: true
shortTitle: Organizations
intro: Use the REST API to manage your organization members codespaces.
Expand Down
2 changes: 1 addition & 1 deletion content/rest/codespaces/repository-secrets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Codespaces repository secrets
title: REST API endpoints for Codespaces repository secrets
allowTitleToDifferFromFilename: true
shortTitle: Repository secrets
intro: >-
Expand Down
2 changes: 1 addition & 1 deletion content/rest/codespaces/secrets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Codespaces user secrets
title: REST API endpoints for Codespaces user secrets
allowTitleToDifferFromFilename: true
shortTitle: User secrets
intro: Use the REST API manage secrets that the user has access to in a codespace.
Expand Down
2 changes: 1 addition & 1 deletion content/rest/projects/cards.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: '{% data variables.product.prodname_project_v1_caps %} cards'
title: 'REST API endpoints for {% data variables.product.prodname_project_v1_caps %} cards'
shortTitle: Cards
allowTitleToDifferFromFilename: true
intro: >-
Expand Down
2 changes: 1 addition & 1 deletion content/rest/projects/collaborators.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: '{% data variables.product.prodname_project_v1_caps %} collaborators'
title: 'REST API endpoints for {% data variables.product.prodname_project_v1_caps %} collaborators'
shortTitle: Collaborators
allowTitleToDifferFromFilename: true
intro: >-
Expand Down
2 changes: 1 addition & 1 deletion content/rest/projects/columns.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: '{% data variables.product.prodname_project_v1_caps %} columns'
title: 'REST API endpoints for {% data variables.product.prodname_project_v1_caps %} columns'
shortTitle: Columns
allowTitleToDifferFromFilename: true
intro: >-
Expand Down
3 changes: 2 additions & 1 deletion content/rest/projects/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: '{% data variables.product.prodname_projects_v1_caps %}'
title: 'REST API endpoints for {% data variables.product.prodname_projects_v1_caps %}'
shortTitle: '{% data variables.product.prodname_projects_v1_caps %}'
intro: 'Use the REST API to create, list, update, delete and customize {% data variables.projects.projects_v1_boards %}.'
redirect_from:
- /v3/projects
Expand Down
2 changes: 1 addition & 1 deletion content/rest/projects/projects.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: '{% data variables.product.prodname_projects_v1_caps %}'
title: 'REST API endpoints for {% data variables.product.prodname_projects_v1_caps %}'
shortTitle: Boards
allowTitleToDifferFromFilename: true
intro: >-
Expand Down
2 changes: 1 addition & 1 deletion content/rest/pulls/comments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Pull request review comments
title: REST API endpoints for pull request review comments
shortTitle: Review comments
intro: Use the REST API to interact with pull request review comments.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
Expand Down
4 changes: 3 additions & 1 deletion content/rest/pulls/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Pulls
title: REST API endpoints for pull requests
shortTitle: Pull requests
allowTitleToDifferFromFilename: true
intro: Use the REST API to manage pull requests and pull request reviews.
redirect_from:
- /v3/pulls
Expand Down
4 changes: 3 additions & 1 deletion content/rest/pulls/pulls.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Pulls
title: REST API endpoints for pull requests
shortTitle: Pull requests
allowTitleToDifferFromFilename: true
intro: Use the REST API to interact with pull requests.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
Expand Down
4 changes: 3 additions & 1 deletion content/rest/pulls/review-requests.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Review requests
title: REST API endpoints for review requests
shortTitle: Review requests
allowTitleToDifferFromFilename: true
intro: Use the REST API to interact with review requests.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
Expand Down
2 changes: 1 addition & 1 deletion content/rest/pulls/reviews.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Pull request reviews
title: REST API endpoints for pull request reviews
shortTitle: Reviews
allowTitleToDifferFromFilename: true
intro: Use the REST API to interact with pull request reviews.
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Activity related to pull request review comments in the pull request's unified diff. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/pulls#comments)" REST API.
Activity related to pull request review comments in the pull request's unified diff. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/pulls#comments)."
2 changes: 1 addition & 1 deletion data/reusables/webhooks/pull_request_review_short_desc.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Activity related to pull request reviews. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/pulls#reviews)" REST API.
Activity related to pull request reviews. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/pulls#reviews)."
2 changes: 1 addition & 1 deletion data/reusables/webhooks/pull_request_short_desc.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Activity related to pull requests. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/pulls)" REST API.
Activity related to pull requests. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/pulls)."

0 comments on commit 96b9791

Please sign in to comment.