-
Notifications
You must be signed in to change notification settings - Fork 167
Front Matter Tags for Guides
Brian McClain edited this page May 11, 2021
·
1 revision
Every guide includes "front matter", which is a small YAML document at the top of the file that defines a collection of metadata. Example.
Tag | Description |
---|---|
Title | The title of the guide. Displays automatically at the top of the page. For optimal SEO, the title should be 50 characters, or less. |
Featured (boolean) | Use only if the guide is selected as a featured piece on the Dev Center homepage. Otherwise, set this value to “false”. |
Weight (int) [optional] | If featured, where in the list of featured pieces it should be included. |
metaTitle [optional] | The title that shows in search results. It is not displayed on the page. |
linkTitle [optional] | The title that appears on the left-side navigation. |
Subsection [optional] | Include if this will be a parent page to other content. This is the value to be referenced in children content. |
Parent [optional] | The “subsection” value of the parent. This should be included under. |
Description | A description of the guide.. For optimal search engine optimization, it is recommended that the description be 150 characters, or less. |
Aliases (array), [optional] | Paths that should redirect to this piece. Useful if a guide is relocated. (Example: “/guides/kubernetes/myguide”). |
Topics (array) | A list of topics this blog falls under. Requires at least one topic, but there can be more. |
Tags (array) | One or more tags to attach to the guide. Useful for both search results and grouping similar content. Can be an existing tag or a new one. |
Patterns (array) | The pattern this guide falls under. Must be an existing pattern. |
Team (array) | A list of authors by name. For example, “Jane Doe”. Author names are displayed under the title, and links to a Bio page if one exists with a matching name. |
- Start Here
- Prewriting / Ideation
- Setting Up You Environment to Create Content
- Drafting Content
- Editing Content
- Testing Content Locally
- Committing Content to be Published
- Content Next Steps
- Start Here
- Prewriting / Ideation
- Tools you need (hint: it's Google Docs)
- Drafting Content
- Editing Content
- Contributing Content