planetscale / planetscale/vitess-operator

Documentation Request

Open
#650 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
372
Forks
102
Avg merge
3d 5h
Merged PRs (30d)
15

Description

Hello, I'm putting this issue up to request more comprehensive documentation, particularly as it relates to understanding Vitess and running in production on EKS. I've been using OpenTofu to provision everything and its not intuitive how it all comes together. Using ChatGPT is also limited due to the lack of available information on Vitess. Are there other ways anyone would recommend learning this system in the meantime?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or documentation entry point is named. Start by reviewing the existing Vitess Operator documentation and its coverage of production deployments on EKS and OpenTofu; done means providing a clear, comprehensive path for understanding Vitess and running it in production.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, kubernetes
Domain
cloud, devops, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.