docs: Add glossary to Vitess documentation#2109
Open
InlinePizza wants to merge 6 commits into
Open
Conversation
Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
promptless-for-oss
force-pushed
the
promptless/add-glossary
branch
from
8881512 to
b2122cf
Compare
| @@ -0,0 +1,207 @@ | |||
| --- | |||
Contributor
deleted glossary in v 23. Reasoning: I am updating v24 glossary.
As requested, the glossary no longer lives under version-specific paths. It is now a standalone article at /docs/glossary/, positioned after FAQ in the navigation (weight: 3000 vs FAQ's weight: 2900).
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mattlord
reviewed
May 4, 2026
Member
mattlord
left a comment
mattlord
left a comment
There was a problem hiding this comment.
I definitely like the concept and the content overall is good. I have a few comments/suggestions, and we'll need to address the DCO failure before we can merge.
Thanks, @InlinePizza !
✅ Deploy Preview for vitess ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Update Backup definition: describe as data snapshot concept rather than tablet state, reference backup tablet type anchor - Fix Keyspace definition: use "MySQL replica sets" terminology as suggested by reviewer - Remove deprecated gh-ost and pt-osc from Online DDL entry - Add Consul to Topology Service backends - Remove vtctl entry (deprecated tool being removed) Signed-off-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
Adds separate entry for the backup tablet type to avoid broken internal link from the Backup definition. Clarifies the distinction between backup (data snapshot) and backup (tablet state). Signed-off-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
mattlord
reviewed
May 4, 2026
|
|
||
| A consistent snapshot of data stored for disaster recovery and provisioning new tablets. Vitess supports full backups (entire dataset) and incremental backups (binary log changes). See also the [backup tablet type](#backup-tablet-type). | ||
|
|
||
| ## Backup (tablet type) {#backup-tablet-type} |
Member
There was a problem hiding this comment.
We should make similar changes for the other tablet types (replica,rdonly,primary,drained, etc) as the terms are used for other things besides tablet types.
Member
|
@InlinePizza You must address the DCO failures: https://github.com/vitessio/website/pull/2109/checks?check_run_id=74265371175 Before we can merge. All of the commits you add must be signed off. |
Addresses reviewer feedback to disambiguate terms used for both MySQL concepts and Vitess tablet types. Following the pattern established for Backup, creates separate entries for: - Primary / Primary (tablet type) - Replica / Replica (tablet type) - Rdonly (tablet type) - Drained (tablet type) - Restore (tablet type) Each tablet type entry now has an explicit anchor for linking. Signed-off-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Open this suggestion in Promptless to view citations and reasoning process
Adds a glossary page to the Reference section of the documentation with definitions of Vitess-specific terms, components, and concepts. Addresses issue #1982. Covers core components, sharding concepts, VReplication workflows, tablet types, and topology terms. Added to versions 23.0, 24.0, and 25.0.
Trigger Events
Tip: Enable auto-create PR in your Docs Collection to publish suggestions automatically 🤖