Overview
Make CLI references more findable by renaming the section in
which they reside.
Vitess has a lot of command-line tools. The references for these
tools should be more easily findable; Programs is
not an intuitive name for a collection of command references. At
the least, the library should have CLI in the title.
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:
Rename "Reference > Programs"
to "Command line references". Consider organizing the CLIs by function (client,
daemon, agent, etc.) or some other taxonomy that reflects the needs of the
roles of whoever uses the tools.
Overview
Make CLI references more findable by renaming the section in
which they reside.
Vitess has a lot of command-line tools. The references for these
tools should be more easily findable;
Programsisnot an intuitive name for a collection of command references. At
the least, the library should have
CLIin the title.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:
Rename "Reference > Programs"
to "Command line references". Consider organizing the CLIs by function (client,
daemon, agent, etc.) or some other taxonomy that reflects the needs of the
roles of whoever uses the tools.