Add a glossary #1982
Description
Overview
Add a glossary of terms to the documentation site.
Audience: All
Type: Reference
Context
This issue tracks recommended changes resulting from an analysis of the Vitess
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses/0014-vitess under
0014-Vitess.
See the umbrella issue
listing all issues identified in the analysis.
Possible Implementation
Related material in the current doc:
Suggested changes:
Add a glossary. This is different from the "Concepts" page – the explanations
of terms is less in-depth. The glossary contains not just key terms but any word
or phrase that the reader might not know: abbreviations and acronyms,
definitions of Vitess-specific terms, and explanations of jargon used in Vitess
("topo", for example).
You can locate the glossary in the main doc table of contents (TOC), or in the
Reference section of the doc website.
See these other CNCF projects for examples of glossaries: