Skip to content

Conversation

@d-bytebase
Copy link
Contributor

@d-bytebase d-bytebase commented Aug 29, 2025

verb [Computing]

for title

- Changed navigation group from "Roll back" to "Rollback" in docs.json
- Updated "roll back" to "rollback" where used as a noun in documentation
- Maintained "roll back" as two words where correctly used as a verb
- Ensures consistency across mintlify docs and blog posts

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
Copilot AI review requested due to automatic review settings August 29, 2025 04:33
@vercel
Copy link

vercel bot commented Aug 29, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Ready Preview Comment Aug 29, 2025 5:33am

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR standardizes the terminology for "Rollback" vs "roll back" across documentation to improve consistency. The changes ensure that "rollback" is used as a noun (one word) and "roll back" is used as a verb (two words) following proper grammatical conventions.

  • Updated navigation group naming for consistency
  • Corrected noun/verb usage of rollback terminology throughout documentation
  • Changed one instance from "roll back" to "revert" to avoid repetitive phrasing

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions
Copy link

github-actions bot commented Aug 29, 2025

📝 Broken Links Check Report

Note: Entries under /api-reference/ are likely false positives and can be ignored.

The following is the output from the broken links check:

found 16 broken links in 9 files

integrations/api/audit-log.mdx
 ⎿  /api-reference/auditlogservice/post-v1auditlogs:search

integrations/api/authentication.mdx
 ⎿  /api-reference/authservice/post-v1authlogin

integrations/api/data-classification.mdx
 ⎿  /api-reference/settingservice/patch-v1settings
 ⎿  /api-reference/databaseservice/patch-v1instances-databases

integrations/api/issue.mdx
 ⎿  /api-reference/issueservice/post-v1projects-issues

integrations/api/permission.mdx
 ⎿  /api-reference/workspaceservice/get-v1workspaces-:getIamPolicy
 ⎿  /api-reference/projectservice/get-v1projects-:getIamPolicy
 ⎿  /api-reference/roleservice/get-v1roles
 ⎿  /api-reference/userservice/get-v1users
 ⎿  /api-reference/groupservice/get-v1groups

integrations/api/plan.mdx
 ⎿  /api-reference/planservice/post-v1projects-plans
 ⎿  /api-reference/sheetservice/post-v1projects-sheets

integrations/api/release.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases

integrations/api/rollout.mdx
 ⎿  /api-reference/rolloutservice/post-v1projects-rollouts

integrations/api/sql-review.mdx
 ⎿  /api-reference/releaseservice/post-v1projects-releases:check
 ⎿  /api-reference/sqlservice/post-v1sqlcheck

Copy link
Member

@tianzhou tianzhou left a comment

Choose a reason for hiding this comment

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

I don't feel it's necessary to change this.

Rollback is a noun. Roll back is a verb.

And sometimes, the clause would be "is rolled back"

Copy link
Member

@tianzhou tianzhou left a comment

Choose a reason for hiding this comment

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

I think using "Rollback" in sidebar is better.

But there is no need to change "roll back" to "rollback" where the verb form is the correct grammar

@d-bytebase
Copy link
Contributor Author

d-bytebase commented Aug 29, 2025

I don't feel it's necessary to change this.

Rollback is a noun. Roll back is a verb.

And sometimes, the clause would be "is rolled back"

Rollout and Rollback are verb/noun in computing. "Roll back" and "roll out" are incorrect (rare) usage. "Rolling out" and "Rolling back" are common usage.

@d-bytebase
Copy link
Contributor Author

Screenshot 2025-08-28 at 9 48 56 PM

@d-bytebase d-bytebase requested a review from tianzhou August 29, 2025 04:51
@tianzhou
Copy link
Member

I don't see this as a standard practice in the doc. I checked a few database docs. They all stick with "roll back"

https://www.google.com/search?q=%22roll+back%22+site%3Ahttps%3A%2F%2Flearn.microsoft.com%2Fen-us%2Fsql%2F&sca_esv=509bbfbba140ee12&ei=9DKxaO2XMNrIkPIPj4jm4QE&ved=0ahUKEwjt4Z6-na-PAxVaJEQIHQ-EORwQ4dUDCBE&uact=5&oq=%22roll+back%22+site%3Ahttps%3A%2F%2Flearn.microsoft.com%2Fen-us%2Fsql%2F&gs_lp=Egxnd3Mtd2l6LXNlcnAiNyJyb2xsIGJhY2siIHNpdGU6aHR0cHM6Ly9sZWFybi5taWNyb3NvZnQuY29tL2VuLXVzL3NxbC9IqQpQvwRY8QhwAXgAkAEAmAHyAaABvwWqAQMyLTO4AQPIAQD4AQGYAgCgAgCYAwCIBgGSBwCgB4cBsgcAuAcAwgcAyAcA&sclient=gws-wiz-serp

https://www.google.com/search?q=%22roll+back%22+site%3Ahttps%3A%2F%2Fwww.postgresql.org%2Fdocs%2F&sca_esv=509bbfbba140ee12&ei=WDKxaPTcN8nMkPIP3fjvuAE&ved=0ahUKEwj06PTznK-PAxVJJkQIHV38GxcQ4dUDCBE&uact=5&oq=%22roll+back%22+site%3Ahttps%3A%2F%2Fwww.postgresql.org%2Fdocs%2F&gs_lp=Egxnd3Mtd2l6LXNlcnAiMSJyb2xsIGJhY2siIHNpdGU6aHR0cHM6Ly93d3cucG9zdGdyZXNxbC5vcmcvZG9jcy9IwboJUNmZCViDswlwBngAkAEAmAHoAaABkAeqAQMyLTS4AQPIAQD4AQGYAgCgAgCYAwCIBgGSBwCgB7QBsgcAuAcAwgcAyAcA&sclient=gws-wiz-serp

https://www.google.com/search?q=%22roll+back%22+site%3A+https%3A%2F%2Fdocs.oracle.com%2Fen%2Fdatabase%2Foracle%2F&sca_esv=509bbfbba140ee12&ei=FTOxaOO5FpyMur8Pvun3-Ao&ved=0ahUKEwijmOPNna-PAxUchu4BHb70Ha8Q4dUDCBE&uact=5&oq=%22roll+back%22+site%3A+https%3A%2F%2Fdocs.oracle.com%2Fen%2Fdatabase%2Foracle%2F&gs_lp=Egxnd3Mtd2l6LXNlcnAiPSJyb2xsIGJhY2siIHNpdGU6IGh0dHBzOi8vZG9jcy5vcmFjbGUuY29tL2VuL2RhdGFiYXNlL29yYWNsZS9Ii3RQAFjXaXAEeAGQAQCYAaACoAGQZ6oBBDItNTK4AQPIAQD4AQH4AQKYAhmgAvEqwgILEAAYgAQYkQIYigXCAgoQABiABBhDGIoFwgIEEAAYA8ICCBAAGIAEGLEDwgILEAAYgAQYsQMYgwHCAgsQLhiABBixAxiDAcICDhAuGIAEGLEDGIMBGIoFwgIREC4YgAQYsQMY0QMYgwEYxwHCAgsQLhiABBjRAxjHAcICDRAAGIAEGLEDGEMYigXCAgsQLhiABBixAxjlBMICCxAuGIAEGMcBGK8BwgIMEAAYgAQYQxiKBRgKwgIFEAAYgATCAgUQLhiABMICEBAuGIAEGMcBGAoYjgUYrwHCAhAQABiABBixAxhDGIMBGIoFwgIOEC4YgAQYsQMY0QMYxwHCAg4QLhiABBjHARiOBRivAcICEBAuGIAEGLEDGEMYgwEYigXCAggQLhiABBixA8ICBhAAGBYYHsICCBAAGBYYChgewgILEAAYgAQYhgMYigXCAggQABiABBiiBMICBRAhGKABwgIFECEYqwKYAwCSBwY0LjAuMjGgB4i1AbIHBDItMjG4B-YqwgcJMC4xMi4xMi4xyAdM&sclient=gws-wiz-serp

Copy link
Member

@tianzhou tianzhou left a comment

Choose a reason for hiding this comment

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

LGTM

@d-bytebase d-bytebase merged commit 6cc4fdc into main Aug 29, 2025
4 checks passed
@d-bytebase d-bytebase deleted the chore/standardize-rollback-terminology branch August 29, 2025 05:44
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