jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Convert allowed-topics.js to TypeScript (#58011)

Browse Source 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Kevin Heis
2025-10-20 07:25:19 -07:00
committed by GitHub
parent 3e3a82e12b
commit 7cd719db8d
6 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -20,7 +20,7 @@ topics:
---
```
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).
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.ts).
## Topics for all content types

10
content/contributing/writing-for-github-docs/templates.md
View File

@@ -73,7 +73,7 @@ intro: 'Article intro. See tips for a great intro below.'
product: "{{ optional product callout }}"
type: reference
topics:
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
versions:
- <version>
---
@@ -125,7 +125,7 @@ intro: 'Article intro. See tips for a great intro below.'
product: "{{ optional product callout }}"
type: how_to
topics:
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
versions:
- <version>
---
@@ -176,7 +176,7 @@ shortTitle: <subject> # Max 31 characters
intro: 'Article intro. Highlight that the guide is quick and to the point.'
type: quick_start
topics:
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
versions:
- <version>
---
@@ -245,7 +245,7 @@ intro: 'Article intro. See tips for a great intro below'
product: "{{ optional product callout }}"
type: tutorial
topics:
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
versions:
- <version>
---
@@ -320,7 +320,7 @@ intro: 'Article intro. See tips for a great intro below'
product: "{{ optional product callout }}"
type: tutorial
topics:
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.js
- <topic> # One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.ts
versions:
- <version>
---

2
content/contributing/writing-for-github-docs/using-yaml-frontmatter.md
View File

@@ -288,7 +288,7 @@ journeyTracks:
### `topics`
* Purpose: Indicate the topics covered by the article. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](https://github.com/github/docs/blob/main/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](https://github.com/github/docs/blob/main/src/search/tests/topics.ts) will fail.
* Purpose: Indicate the topics covered by the article. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](https://github.com/github/docs/blob/main/data/allowed-topics.ts). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](https://github.com/github/docs/blob/main/src/search/tests/topics.ts) will fail.
* Type: Array of `String`s
* Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics, or adding a topic to a new article may not add value.