Skip to content

docs: Rename task headings to use gerund form in User Guides#2113

Open
amandawestlake wants to merge 1 commit into
vitessio:prodfrom
Promptless:promptless/rename-task-headings
Open

docs: Rename task headings to use gerund form in User Guides#2113
amandawestlake wants to merge 1 commit into
vitessio:prodfrom
Promptless:promptless/rename-task-headings

Conversation

@amandawestlake
Copy link
Copy Markdown

Updates task/procedural headings across User Guides versions 23.0, 24.0, and 25.0 to use verb-based titles ending in "-ing" (gerunds) for improved findability. Changes include renaming page titles like "Move Tables" to "Moving Tables", "Backups and Restores" to "Backing Up and Restoring Data", and section headings like "Backups" to "Backing Up TopoServer Data".

It is generally not recommended that you migrate from one type of toposerver to another. However, if absolutely necessary, you can use the [topo2topo](../../../reference/features/topology-service/#migration-between-implementations) command line tool to perform this migration.

## Backups
## Backing Up TopoServer Data
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue #1974 explicitly calls out the "Backups" heading in global-topo.md as an example that should be renamed to "Backing up TopoServer data" to clearly describe the task and its object.

Source: #1974

Copy link
Copy Markdown
Member

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @amandawestlake ! ❤️

@mattlord
Copy link
Copy Markdown
Member

mattlord commented May 4, 2026

@amandawestlake we will need to address the DCO failure and resolve the conflict before we can merge.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 4, 2026

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 56f3b55
🔍 Latest deploy log https://app.netlify.com/projects/vitess/deploys/69f8c954ecce0b00098acefa
😎 Deploy Preview https://deploy-preview-2113--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.

Co-authored-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
Signed-off-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
@promptless-for-oss promptless-for-oss force-pushed the promptless/rename-task-headings branch from c4e52f8 to 56f3b55 Compare May 4, 2026 16:29
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.

3 participants