From 1c69432d53eb171dc91c5081725c07f629bd0a0f Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Thu, 5 Sep 2024 12:58:25 -0400 Subject: [PATCH 1/2] fix: revise link and improve information about topics in the contributing docs (#34491) Signed-off-by: Christine Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../style-guide-and-content-model/about-topics.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/content/contributing/style-guide-and-content-model/about-topics.md b/content/contributing/style-guide-and-content-model/about-topics.md index 96bb1efe0f9f..8304e53d71ae 100644 --- a/content/contributing/style-guide-and-content-model/about-topics.md +++ b/content/contributing/style-guide-and-content-model/about-topics.md @@ -6,7 +6,19 @@ versions: feature: 'contributing' --- -Topics are used to filter articles and are searchable across the {% data variables.product.prodname_docs %} site. For some layouts, such as landing pages or guides, people can select which articles are displayed by filtering topics. Use these guidelines to help choose which topics to add to an article's frontmatter. For more information on adding topics to an article see, "[Topics](https://github.com/github/docs/tree/main/content#topics)" and for a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.js). +Topics are used to filter articles and are searchable across the {% data variables.product.prodname_docs %} site. For some layouts, such as landing pages or guides, people can select which articles are displayed by filtering topics. Also, an article can be defined as being relevant to one or more topics by having those topics listed in the article's frontmatter. For example: + +```yaml +--- +title: "Managing branches in your repository" +topics: + - "GitHub" + - "Git" + - "Repositories" +--- +``` + +For more information on adding topics to an article see, "[AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)". For a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.js). ## Topics for all content types From 526a2d051e123dcfd50a320607948f775bd35679 Mon Sep 17 00:00:00 2001 From: Berenice Monsivais <153947742+beremonsivais@users.noreply.github.com> Date: Thu, 5 Sep 2024 11:24:34 -0600 Subject: [PATCH 2/2] Fixes github/docs#34351 (#34496) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- content/rest/using-the-rest-api/github-event-types.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/rest/using-the-rest-api/github-event-types.md b/content/rest/using-the-rest-api/github-event-types.md index 616166f9e0ca..c8c9fa71bc06 100644 --- a/content/rest/using-the-rest-api/github-event-types.md +++ b/content/rest/using-the-rest-api/github-event-types.md @@ -27,24 +27,24 @@ The event objects returned from the Events API endpoints have the same structure | Event API attribute name | Type | Description | |--------------------------|-------------|-------------| -| `id` | `string` | Unique identifier for the event. | +| `id` | `integer` | Unique identifier for the event. | | `type` | `string` | The type of event. Events uses PascalCase for the name. | | `actor` | `object` | The user that triggered the event. | -| `actor.id` | `string` | The unique identifier for the actor. | +| `actor.id` | `integer` | The unique identifier for the actor. | | `actor.login` | `string` | The username of the actor. | | `actor.display_login` | `string` | The specific display format of the username. | | `actor.gravatar_id` | `string` | The unique identifier of the Gravatar profile for the actor. | | `actor.url` | `string` | The REST API URL used to retrieve the user object, which includes additional user information. | | `actor.avatar_url` | `string` | The URL of the actor's profile image. | | `repo` | `object` | The repository object where the event occurred. | -| `repo.id` | `string` | The unique identifier of the repository. | +| `repo.id` | `integer` | The unique identifier of the repository. | | `repo.name` | `string` | The name of the repository, which includes the owner and repository name. For example, `octocat/hello-world` is the name of the `hello-world` repository owned by the `octocat` personal account. | | `repo.url` | `string` | The REST API URL used to retrieve the repository object, which includes additional repository information. | | `payload` | `object` | The event payload object is unique to the event type. See the event type below for the event API `payload` object. | | `public` | `boolean` | Whether the event is visible to all users. | | `created_at` | `string` | The date and time when the event was triggered. It is formatted according to ISO 8601. | | `org` | `object` | The organization that was chosen by the actor to perform action that triggers the event.
_The property appears in the event object only if it is applicable._ | -| `org.id` | `string` | The unique identifier for the organization. | +| `org.id` | `integer` | The unique identifier for the organization. | | `org.login` | `string` | The name of the organization. | | `org.gravatar_id` | `string` | The unique identifier of the Gravatar profile for the organization. | | `org.url` | `string` | The REST API URL used to retrieve the organization object, which includes additional organization information. |