From 535cd73d47fbc3f584dc68758fedd243ee0c3fe8 Mon Sep 17 00:00:00 2001 From: Christine Date: Wed, 4 Sep 2024 17:14:54 +0000 Subject: [PATCH 1/8] fix: revise link and improve information about topics in the contributing docs Signed-off-by: Christine --- .../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..d7b512645186 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. Use these guidelines to help choose which topics to add to an article's frontmatter. Here's an example of a topic in frontmatter: + +```yaml +--- +title: "Managing branches in your repository" +topics: + - "GitHub" + - "Git" + - "Repositories" +--- +``` + +For more information on adding topics to an article see, "[Topics]( https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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 5921b3b99726708530c4654504b3f76a2e37fcdf Mon Sep 17 00:00:00 2001 From: Christine Date: Wed, 4 Sep 2024 17:23:27 +0000 Subject: [PATCH 2/8] fix: revise first paragraph Signed-off-by: Christine --- .../contributing/style-guide-and-content-model/about-topics.md | 2 +- 1 file changed, 1 insertion(+), 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 d7b512645186..eb30403b6aba 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,7 @@ 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. Here's an example of a topic in frontmatter: +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. Here's an example: ```yaml --- From 20c1bc7100110c898199b3776b9470385651e3f4 Mon Sep 17 00:00:00 2001 From: Christine Date: Wed, 4 Sep 2024 17:28:11 +0000 Subject: [PATCH 3/8] fix: revise format Signed-off-by: Christine --- .../contributing/style-guide-and-content-model/about-topics.md | 2 +- 1 file changed, 1 insertion(+), 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 eb30403b6aba..d182b5f5b3f9 100644 --- a/content/contributing/style-guide-and-content-model/about-topics.md +++ b/content/contributing/style-guide-and-content-model/about-topics.md @@ -18,7 +18,7 @@ topics: --- ``` -For more information on adding topics to an article see, "[Topics]( https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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, "[Topics](https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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 134e399c83db72e1fdc8b28c6e2d08ad8d670568 Mon Sep 17 00:00:00 2001 From: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> Date: Wed, 4 Sep 2024 12:55:37 -0700 Subject: [PATCH 4/8] Updates from editor Fixing markdown error --- .../contributing/style-guide-and-content-model/about-topics.md | 2 +- 1 file changed, 1 insertion(+), 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 d182b5f5b3f9..3292e2228215 100644 --- a/content/contributing/style-guide-and-content-model/about-topics.md +++ b/content/contributing/style-guide-and-content-model/about-topics.md @@ -18,7 +18,7 @@ topics: --- ``` -For more information on adding topics to an article see, "[Topics](https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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, "[Topics](AUTOTITLE/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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 abe00b298110f00cd697baeb5452987d0f9671fc Mon Sep 17 00:00:00 2001 From: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> Date: Wed, 4 Sep 2024 12:57:14 -0700 Subject: [PATCH 5/8] Updates from editor --- .../contributing/style-guide-and-content-model/about-topics.md | 2 +- 1 file changed, 1 insertion(+), 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 3292e2228215..e6f8ae5c768b 100644 --- a/content/contributing/style-guide-and-content-model/about-topics.md +++ b/content/contributing/style-guide-and-content-model/about-topics.md @@ -18,7 +18,7 @@ topics: --- ``` -For more information on adding topics to an article see, "[Topics](AUTOTITLE/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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, "[Topics](/AUTOTITLE/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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 2764885b5733243292886a5a1f9e82b81aa70ac4 Mon Sep 17 00:00:00 2001 From: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> Date: Wed, 4 Sep 2024 13:57:07 -0700 Subject: [PATCH 6/8] Updates from editor --- .../contributing/style-guide-and-content-model/about-topics.md | 2 +- 1 file changed, 1 insertion(+), 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 e6f8ae5c768b..cca28b9e5812 100644 --- a/content/contributing/style-guide-and-content-model/about-topics.md +++ b/content/contributing/style-guide-and-content-model/about-topics.md @@ -18,7 +18,7 @@ topics: --- ``` -For more information on adding topics to an article see, "[Topics](/AUTOTITLE/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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](/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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 b02c45e0bef6dd00f177ad6b24bd86a977ba2cbe Mon Sep 17 00:00:00 2001 From: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> Date: Wed, 4 Sep 2024 13:58:53 -0700 Subject: [PATCH 7/8] Updates from editor --- .../contributing/style-guide-and-content-model/about-topics.md | 2 +- 1 file changed, 1 insertion(+), 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 cca28b9e5812..8d0dc0cf5f2c 100644 --- a/content/contributing/style-guide-and-content-model/about-topics.md +++ b/content/contributing/style-guide-and-content-model/about-topics.md @@ -18,7 +18,7 @@ topics: --- ``` -For more information on adding topics to an article see, "[AUTOTITLE](/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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)" and 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 4d27ec6e2c89fa45ffbfc8c3fa49bbc7750601c6 Mon Sep 17 00:00:00 2001 From: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> Date: Thu, 5 Sep 2024 09:51:25 -0700 Subject: [PATCH 8/8] Fixed run on sentence, updated "Here's an example" to "For example" --- .../style-guide-and-content-model/about-topics.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 8d0dc0cf5f2c..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,7 @@ 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. Also, an article can be defined as being relevant to one or more topics by having those topics listed in the article's frontmatter. Here's an example: +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 --- @@ -18,7 +18,7 @@ topics: --- ``` -For more information on adding topics to an article see, "[AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)" and 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.js). ## Topics for all content types