jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-30 12:02:01 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #52236 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2024-09-05 11:35:33 -07:00
committed by GitHub
parent 2c1953a475 526a2d051e
commit e114494f37
2 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
content/contributing/style-guide-and-content-model/about-topics.md
View File

@@ -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

8
content/rest/using-the-rest-api/github-event-types.md
View File

@@ -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.<br />_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. |