Explain all the installation options on the Getting Started page.
Audience: All
Type: Task
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:
Expand the listed installation options on the
Get Started page by explaining
what user roles would use each option and why. Also:
- Is there an alternative to Kubernetes for running in production? Explain.
- Give an explicit list of supported OSes.
This issue is closely related to
Write a "Get Started" introduction
in that it involved modifying the Get Started page, but is more specifically
concerned with the installation procedures.
An alternative would be to create a separate introduction page for installations.
Explain all the installation options on the Getting Started page.
Audience: All
Type: Task
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:
Expand the listed installation options on the
Get Started page by explaining
what user roles would use each option and why. Also:
This issue is closely related to
Write a "Get Started" introduction
in that it involved modifying the Get Started page, but is more specifically
concerned with the installation procedures.
An alternative would be to create a separate introduction page for installations.