From 371b09d2dcd06d749ead9cc1f869c97a5b61177b Mon Sep 17 00:00:00 2001 From: caupolicandiaz Date: Sun, 13 Aug 2023 06:51:36 -0700 Subject: [PATCH] metadata edits (#3007) Co-authored-by: SSwiniarski <86081858+SSwiniarski@users.noreply.github.com> --- documentation/concept-entry-template.md | 4 ++-- documentation/term-entry-template.md | 4 ++-- documentation/topic-entry-template.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/documentation/concept-entry-template.md b/documentation/concept-entry-template.md index 8ac52663506..a79465bd55e 100644 --- a/documentation/concept-entry-template.md +++ b/documentation/concept-entry-template.md @@ -1,6 +1,6 @@ --- Title: 'The Title' # Required; the file name should be the same as the title, but lowercase, with dashes instead of spaces, and all punctuation removed -Description: 'A brief description' # Required; ideally under 150 characters and starts with a noun (used in search engine results and content previews) +Description: 'A brief description.' # Required; ideally under 150 characters and starts with a noun (used in search engine results and content previews) Subjects: # Please only use Subjects in the subjects.md file (https://github.com/Codecademy/docs/blob/main/documentation/subjects.md). If that list feels insufficient, feel free to create a new Subject and add it to subjects.md in your PR! - 'A subject name' - 'A second subject name' @@ -11,7 +11,7 @@ Tags: # Please only use Tags in the tags.md file (https://github.com/Codecademy/ - 'An nth tag' CatalogContent: # Please use course/path landing page slugs, rather than linking to individual content items. If listing multiple items, please put the most relevant one first - 'learn-example-course' - - 'path/example-path' + - 'paths/example-path' --- [Introduction - make sure first mention of concept is in **bold**.] (The first 160 characters of this section will appear as the description of the page when it shows up on search engines. It's important!) diff --git a/documentation/term-entry-template.md b/documentation/term-entry-template.md index f0eb43c6ae7..fe0edd5dbbf 100644 --- a/documentation/term-entry-template.md +++ b/documentation/term-entry-template.md @@ -1,6 +1,6 @@ --- Title: 'The Title' # Required; the file name should be the same as the title, but lowercase, with dashes instead of spaces, and all punctuation removed -Description: 'A brief description' # Required; ideally under 150 characters and starts with a present-tense verb (used in search engine results and content previews) +Description: 'A brief description.' # Required; ideally under 150 characters and starts with a present-tense verb (used in search engine results and content previews) Subjects: # Please only use Subjects in the subjects.md file (https://github.com/Codecademy/docs/blob/main/documentation/subjects.md). If that list feels insufficient, feel free to create a new Subject and add it to subjects.md in your PR! - 'A subject name' - 'A second subject name' @@ -11,7 +11,7 @@ Tags: # Please only use Tags in the tags.md file (https://github.com/Codecademy/ - 'An nth tag' CatalogContent: # Please use course/path landing page slugs, rather than linking to individual content items. If listing multiple items, please put the most relevant one first - 'learn-example-course' - - 'path/example-path' + - 'paths/example-path' --- [A brief definition - make sure first mention of term is in **bold**.] diff --git a/documentation/topic-entry-template.md b/documentation/topic-entry-template.md index e9d7326c07f..371d14263f0 100644 --- a/documentation/topic-entry-template.md +++ b/documentation/topic-entry-template.md @@ -2,11 +2,11 @@ # This file is used to populate the hub page for the language whose folder it's in. Be sure to create a new version if you create a folder for a new language! Title: 'Name' # Required; this is the name that appears on the hub page for this language. Pay attention to capitalization and punctuation! -Description: 'A brief description' # Required; ideally under 150 characters and starts with the name of the topic (used in search engine results and content previews) +Description: 'A brief description.' # Required; ideally under 150 characters and starts with the name of the topic (used in search engine results and content previews) Codecademy Hub Page: 'https://www.codecademy.com/catalog/language/_____' # If codecademy.com doesn't have a hub page for this language, that's okay too. You can omit this field. CatalogContent: # Please use course/path landing page slugs, rather than linking to individual content items. If listing multiple items, please put the most relevant one first - 'learn-example-course' - - 'path/example-path' + - 'paths/example-path' --- -[Text description - make sure first mention of topic is in **bold**.] +[Text description - make sure first mention of the topic is in **bold**.]