vitessio
Write a "Get Started" introduction
Overview
The documentation should provide an easy-to-follow onboarding path for new users. Start by writing an introduction on the Get Started landing page.
Audience: New users
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.
See the umbrella issue listing all issues identified in the analysis.
Possible Implementation
Related material in the current doc:
Suggested changes:
The "Get Started" page should outline an installation > configuration > orientation path for new users something like the following:
- Install test environment
- Configure test environment
- Test Vitess
This test environment should serve the initial needs of most user roles, including:
- Evaluators who want to try Vitess out in a low-effort environment
- Administrators who want to familiarize themselves with Vitess basics before moving on to a production install
- Developers who want a test environment
Use the "Next steps" section to point readers to more advanced setup and learning materials.
Are contributions from outsiders allowed? I couldn't find any contribution guide for documentations.
@Neema-Joju, As far as I know, doc contributions are welcome. Open a PR and reference the issue you want to work on. Maintainers might have more specific information about what they want.