Skip to content

Conversation

@marcschaeferger
Copy link
Contributor

@marcschaeferger marcschaeferger commented Oct 3, 2025

Summary Copilot:

This pull request updates the "Get Started" documentation for Vitess across versions 20.0, 21.0, 22.0, and 23.0 to provide a more beginner-friendly quick start guide. The new content focuses on helping evaluators, administrators, and developers easily install, configure, and try Vitess in a test environment before moving to production. The changes also introduce a clear roadmap for progressing from evaluation to production deployment.

The most important changes are:

Content Overhaul & Structure:

  • Rewrote the introduction to explain what Vitess is and who the guide is for, targeting evaluators, administrators, and developers.
  • Replaced the previous platform-centric deployment instructions with a section outlining multiple lightweight test install options, including local binaries, source builds, and a recommended Docker image.
  • Added guidance for using the VSchema demo and iterating on schema/VSchema definitions, including tips for learning sharding and query routing via VTGate.

Testing Instructions:

  • Provided clear steps for connecting to VTGate, verifying connectivity, and using the demo web UI to explore schema and query routing.

Roadmap to Production:

  • Introduced a step-by-step roadmap for moving from a test setup to a production Vitess cluster, including planning, installation, configuration, data migration, schema evolution, and operational scaling. Role-specific hints for developers, DBAs, and SREs are included.

References:


Closes #1971
Closes #1972

…io#1971])

Signed-off-by: Marc Schäfer <git@marcschaeferger.de>
@marcschaeferger
Copy link
Contributor Author

Fixed DCO failing/missing Sign-Off

@netlify
Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit c58a84e
🔍 Latest deploy log https://app.netlify.com/projects/vitess/deploys/68e024f643030400085ff7f3
😎 Deploy Preview https://deploy-preview-2006--vitess.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 5ec2174
🔍 Latest deploy log https://app.netlify.com/projects/vitess/deploys/68e003e7556a78000862c324
😎 Deploy Preview https://deploy-preview-2006--vitess.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

… start to production ([vitessio#1972])

Signed-off-by: Marc Schäfer <git@marcschaeferger.de>
@marcschaeferger marcschaeferger changed the title Issue-1971 - docs(get-started): add onboarding introduction for new users ([#1971]) Issue-1971 & 1972 - docs(get-started) Oct 3, 2025
@marcschaeferger
Copy link
Contributor Author

Update to add commit for #1972

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write a "What's Next" roadmap Write a "Get Started" introduction

1 participant