Issue-1973 - docs(whatisvitess): update What Is Vitess overview for clarity and detail ([#1973]) #2007
Conversation
…tail ([vitessio#1973]) Signed-off-by: Marc Schäfer <[email protected]>
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mattlord
requested review from
arthurschreiber and
timvaillancourt
and removed request for
harshit-gangal
| --- | ||
|
|
||
| Vitess is a database solution for deploying, scaling and managing large clusters of open-source database instances. It currently supports MySQL and Percona Server for MySQL. It's architected to run as effectively in a public or private cloud architecture as it does on dedicated hardware. It combines and extends many important SQL features with the scalability of a NoSQL database. Vitess can help you with the following problems: | ||
| Vitess is an **open-source, cloud-native, horizontally scalable, distributed database system built around MySQL**. It presents a single logical MySQL interface to applications through a stateless proxy (**VTGate**), while managing shards across multiple database instances called **VTTablets**. Vitess handles **data sharding**, **query routing**, **connection pooling**, and **automated failover**, so applications can keep using the familiar MySQL protocol without embedding sharding logic. |
There was a problem hiding this comment.
Where did this text come from? The only key part that I don't like is this:
while managing shards across multiple database instances called **VTTablets**
VTTablets manage a MySQL database instance but they are not "database instances".
There was a problem hiding this comment.
I'm going to close this in the coming weeks if I don't hear back from you @marcschaeferger .
We've had to deal with a lot of "drive-by" PRs from AI and if I don't hear back then I will assume this was another one. I apologize if that assessment is a mistake, but I have questions about this PR and would like to make some changes and if I don't hear back from you after another week or two then I'll close it.
There was a problem hiding this comment.
@mattlord thanks and sorry for the late reply.
You're right about the VTTablets sentence, that sentence was my own wording (partially) (probably in german) and not copied from elsewhere. I wrote the documentation in "my englisch + german mix" and then gave it to an AI for translation and mostly wording/grammar improvments as i'm not a native english speaker and i wanted to balance that with AI. So totally my fault, for not checking the AI output thoroughly enough, will not happen again, as this + a few other PR's on this and other projects were like quick-shots and my first ones beside heavy company Git (DevOps) work (and first on Github for me).
This is in my option and wasn’t meant as a “drive-by” AI PR. I do this in my free time, as i want to start contributing to CNCF projects and in the last days I was busy with other projects but mostly private stuff and my fulltime job itself. I saw your first comment shortly after you posted it, but then didn’t get back to it and simply forgot.
I do state the use of AI in my work if it's used, like i did with the Summary by Copilot. I'll update the PR description with that information and that i used additonaly AI for translation and grammarc/wording improvments.
I’m happy to take your suggestion, if you have something else.
2 participants
Summary Copilot:
This pull request updates the "What is Vitess?" overview documentation for versions 20.0 through 23.0, significantly improving the clarity, technical accuracy, and structure of the introductory content. The changes modernize the description of Vitess, highlight its cloud-native and sharding capabilities, and provide a clearer breakdown of its architecture and feature set. Additionally, the explanations of how Vitess improves on vanilla MySQL implementations are made more concise and focused.
Documentation improvements:
whatisvitess.mdfor versions 20.0–23.0 to emphasize Vitess as an open-source, cloud-native, horizontally scalable distributed database system built around MySQL, and clarified its architecture and operational components such as VTGate, VTTablet, VSchema, and Topology Service.Technical accuracy and focus:
These changes ensure the documentation is more informative and approachable for new users and more accurate for technical audiences.
References:
✅ Closes #1973