You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/contributing/style-guide-and-content-model/about-topics.md
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,19 @@ versions:
6
6
feature: 'contributing'
7
7
---
8
8
9
-
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).
9
+
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:
10
+
11
+
```yaml
12
+
---
13
+
title: "Managing branches in your repository"
14
+
topics:
15
+
- "GitHub"
16
+
- "Git"
17
+
- "Repositories"
18
+
---
19
+
```
20
+
21
+
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).
|`id`|`string`| Unique identifier for the event. |
30
+
|`id`|`integer`| Unique identifier for the event. |
31
31
|`type`|`string`| The type of event. Events uses PascalCase for the name. |
32
32
|`actor`|`object`| The user that triggered the event. |
33
-
|`actor.id`|`string`| The unique identifier for the actor. |
33
+
|`actor.id`|`integer`| The unique identifier for the actor. |
34
34
|`actor.login`|`string`| The username of the actor. |
35
35
|`actor.display_login`|`string`| The specific display format of the username. |
36
36
|`actor.gravatar_id`|`string`| The unique identifier of the Gravatar profile for the actor. |
37
37
|`actor.url`|`string`| The REST API URL used to retrieve the user object, which includes additional user information. |
38
38
|`actor.avatar_url`|`string`| The URL of the actor's profile image. |
39
39
|`repo`|`object`| The repository object where the event occurred. |
40
-
|`repo.id`|`string`| The unique identifier of the repository. |
40
+
|`repo.id`|`integer`| The unique identifier of the repository. |
41
41
|`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. |
42
42
|`repo.url`|`string`| The REST API URL used to retrieve the repository object, which includes additional repository information. |
43
43
|`payload`|`object`| The event payload object is unique to the event type. See the event type below for the event API `payload` object. |
44
44
|`public`|`boolean`| Whether the event is visible to all users. |
45
45
|`created_at`|`string`| The date and time when the event was triggered. It is formatted according to ISO 8601. |
46
46
|`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._|
47
-
|`org.id`|`string`| The unique identifier for the organization. |
47
+
|`org.id`|`integer`| The unique identifier for the organization. |
48
48
|`org.login`|`string`| The name of the organization. |
49
49
|`org.gravatar_id`|`string`| The unique identifier of the Gravatar profile for the organization. |
50
50
|`org.url`|`string`| The REST API URL used to retrieve the organization object, which includes additional organization information. |
0 commit comments