Add a glossary

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:

• Concepts

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:

• etcd
• KEDA

Start by reviewing the CNCF analysis 0014-Vitess, the umbrella issue, and the existing Concepts page. Compare the linked etcd and KEDA glossaries to define the glossary’s scope and terminology. Done means a glossary covering unfamiliar Vitess terms, abbreviations, acronyms, and jargon is added to the documentation site and linked from the main TOC or Reference section.