Explain installation options
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 70
- Forks
- 236
- Avg merge
- 5h 41m
- Merged PRs (30d)
- 9
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Get Started page and the CNCF analysis materials under 0014-Vitess. Review the existing installation options, then document the user role and rationale for each, production alternatives to Kubernetes, and an explicit supported-OS list; the work is done when these points are covered on the installation guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100