Skip to content

Commit

Permalink
metadata edits (#3007)
Browse files Browse the repository at this point in the history
Co-authored-by: SSwiniarski <[email protected]>
  • Loading branch information
caupolicandiaz and SSwiniarski authored Aug 13, 2023
1 parent 231cef8 commit 371b09d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions documentation/concept-entry-template.md
Original file line number Diff line number Diff line change
@@ -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'
Expand All @@ -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!)
Expand Down
4 changes: 2 additions & 2 deletions documentation/term-entry-template.md
Original file line number Diff line number Diff line change
@@ -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'
Expand All @@ -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**.]
Expand Down
6 changes: 3 additions & 3 deletions documentation/topic-entry-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.] <!-- # Write up an introductory description of the language/framework here! -->
[Text description - make sure first mention of the topic is in **bold**.] <!-- # Write up an introductory description of the language/framework here! -->

0 comments on commit 371b09d

Please sign in to comment.