whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #7015 from heckj/glossary_style_update

Browse Source 
adding full-link to the glossary YAML style guide
This commit is contained in:
Jennifer Rondeau
2018-01-22 15:21:08 -05:00
committed by GitHub
parent 0268fa9ab8 5af1701926
commit 01516c2866
2 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_data/glossary/_example.yml
+1 -1
View File
@@ -1,6 +1,6 @@
id: _example id: _example
name: Example K8s Term name: Example K8s Term
full-link: kubernetes.io/docs/link-to-long-dedicated-docs-page full-link: /docs/link-to-long-dedicated-docs-page
aka: aka:
- Slang K8s Term - Slang K8s Term
- Misnomer - Misnomer
_includes/templates/glossary/README.md
+2
View File
@@ -6,6 +6,8 @@ To write a glossary snippet, start with a copy of the template, [`/_data/glossar
* This field must match the name of the glossary file itself (without the `*.yml` extension). It is *not* intended to be displayed to users, and is only used programmatically. * This field must match the name of the glossary file itself (without the `*.yml` extension). It is *not* intended to be displayed to users, and is only used programmatically.
* (Required) `name` * (Required) `name`
* The name of the term. * The name of the term.
* (Optional) `full-link`
* The link to any specific long-form documentation, starting with `https://` if not within the website repo, and `/docs/...` if within the repo.
* (Required) `tags` * (Required) `tags`
* Must be one of the tags listed in the [tags directory in the website repository](https://github.com/kubernetes/website/tree/master/_data/canonical-tags). * Must be one of the tags listed in the [tags directory in the website repository](https://github.com/kubernetes/website/tree/master/_data/canonical-tags).
* (Required) `short description` * (Required) `short description`