Files
website/_data/glossary/_example.yml
T
Andrew Chen f6e51e6611 [glossary] Glossary MVP (#4865)
* [glossary] Glossary MVP

* resolve conflict

* initial pass at includable glossary data

* tag to term mapping

* Change StatefulSets to singular, StatefulSet

* revise glossary style guide, move

* make descriptions plural
2017-08-24 10:51:59 -07:00

18 lines
711 B
YAML

id: _example
name: Example K8s Term
formerly:
- Slang K8s Term
- Misnomer
- Formerly Known as Prince
related:
- Less Fancy K8s Term
- Tangential Term
- Commonly Used With
tags:
- Some Tag
short-description: |
Required. One or two lines that provide a minimum definition. Do not repeat the term. Write about the plural of the term. Prefer fragments. Model after tooltips. End with a period.
long-description: |
Optional. Longer additional text to appear after (in conjunction with) short description. Provide where the short description is not sufficient as the intro paragraph to a topic. Write complete but concise sentences.
**See /_includes/templates/glossary/README.md for the official style guide.**