Glossary Style Guide
Glossary articles provide definitions of technical terms used within DigitalOcean and cloud computing in general.
These articles offer readers a way to build their knowledge by understanding cloud computing’s tools and building blocks. For example, a glossary article about failover helps readers understand what failover is and how it relates to cloud computing or to DigitalOcean products.
Content
Write thorough, technically accurate, self-contained glossary definitions. Glossary definitions should focus on providing a concise explanation of the concept at a high level.
Definitions should be no more than one or two paragraphs long. The first few sentences should be a succinct definition of the glossary term. After the definition, expand into any relevant detail. Do not include unnecessary tie-ins to DigitalOcean products. This is an educational tool, not a marketing tool.
Use links liberally to provide more opportunities to learn about the glossary term. The links act as a “Where to next?” and may consist of existing Product Docs or Community articles, when available. Only send readers offsite to gather information if there’s no existing DigitalOcean articles and you cannot add the information to the article directly in a short summary.
Authorship Process
Use the glossary archetype to create new glossary content:
hugo new products/glossary-terms/<name-of-glossary-term>
Add <--more--> after the introductory definition to use it as the description for the page (and therefore omit description: from the page front matter).