From 77086a90b8a9dd6d64a55fa922abc08cd2c10977 Mon Sep 17 00:00:00 2001 From: Andrew Chen Date: Mon, 14 Aug 2017 11:04:38 -0700 Subject: [PATCH] [glossary] Glossary Template (#4785) * [glossary] Glossary Template * simplify --- _includes/glossary/README.md | 3 --- _includes/glossary/_glossary-template.md | 24 ++++++++++++++++++++++++ 2 files changed, 24 insertions(+), 3 deletions(-) delete mode 100644 _includes/glossary/README.md create mode 100644 _includes/glossary/_glossary-template.md diff --git a/_includes/glossary/README.md b/_includes/glossary/README.md deleted file mode 100644 index ef30343832..0000000000 --- a/_includes/glossary/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Instructions for Glossary snippets - -Markdown snippets of glossary terms to be reused throughout the documentation should be placed in this directory. diff --git a/_includes/glossary/_glossary-template.md b/_includes/glossary/_glossary-template.md new file mode 100644 index 0000000000..8dde048f14 --- /dev/null +++ b/_includes/glossary/_glossary-template.md @@ -0,0 +1,24 @@ + +--- +term: Some Fancy K8s Term +formerly: +- Slang K8s Term +- Misnomer +- Formerly Known as Prince +related: +- Less Fancy K8s Term +- Tangential Term +- Commonly Used With +--- + +{% capture short-description %} +Required. One or two lines that provide a minimum definition. Do not repeat the term. Prefer fragments. Model after tooltips. +{% endcapture %} + +{% capture 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. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed hendrerit dictum nisi quis posuere. Integer eleifend neque lobortis ultrices viverra. Praesent viverra placerat ex sit amet aliquet. Aliquam non ipsum ut lectus viverra pulvinar id vitae nisi. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse aliquet congue tristique. Pellentesque at condimentum orci, iaculis pellentesque urna. Aliquam ut rhoncus lorem, a tristique est. Quisque eu est sem. + +Suspendisse id feugiat orci. Etiam in posuere arcu, id euismod velit. Etiam pulvinar lectus at diam porta, non lobortis dolor blandit. Donec id faucibus elit. Suspendisse auctor ligula purus, id aliquam odio vehicula a. Donec pretium ligula at nulla pulvinar, sed ultrices ligula dapibus. Cras lacinia mauris ut metus rutrum volutpat. Sed fermentum lobortis ipsum, in hendrerit lectus consectetur sed. Aliquam pulvinar tortor tellus, ac luctus est euismod congue. Maecenas enim ipsum, maximus a turpis eu, blandit imperdiet lacus. +{% endcapture %} \ No newline at end of file