Add a glossary #6309
Description
Overview
A software product like Knative typically uses many terms specific to the
product and to its knowledge domain. Users, especially those new to the
software, need help making sense of these terms while reading the documentation.
Add a glossary of terms to the technical documentation.
Audience: All
Type: Reference
Context
This issue tracks recommended changes resulting from an analysis of the Knative
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0015-knative.
Possible Implementation
Related material in the current doc:
Suggested changes:
Add a glossary to the reference section of the documentation. Include terms that
are essential concepts in related software domains (containerization, server and
event architecture, etc.) as well as terms that are specific to Knative. A few
such terms: Custom resource, Eventing, func (CLI), kn (CLI), Operator, Serving,
Sink, Source, Webhook.
A glossary entry should provide readers with a definition of the term, but not
try to explain it in detail. A sentence or two is usually enough. It's OK to
refer to other glossary entries in the definition.
Order the entries alphabetically.