-
Notifications
You must be signed in to change notification settings - Fork 3
docs: restructure documentation navigation and URLs #857
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Rename vcs-integration to gitops throughout documentation - Moved /mintlify/vcs-integration/ to /mintlify/gitops/ - Updated 30+ documentation and blog files with new gitops URLs - Renamed image file from bytebase-vcs-integration.webp to bytebase-gitops.webp - Reorganize administration pages to change-database section - Moved environment-policy/ from administration to change-database - Moved risk-center.mdx from administration to change-database - Moved schema-template.mdx from administration to change-database - Update all internal references and navigation - Updated docs.json navigation structure - Fixed all cross-references in documentation files - Updated TypeScript route constants - Add URL redirects for backward compatibility - /docs/vcs-integration/* → /docs/gitops/* - /docs/administration/environment-policy/* → /docs/change-database/environment-policy/* - /docs/administration/risk-center → /docs/change-database/risk-center - /docs/administration/schema-template → /docs/change-database/schema-template This restructure improves documentation organization by consolidating all database change-related content under the change-database section and establishing GitOps as a primary workflow alongside UI-driven workflows. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this 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 restructures the documentation navigation to improve organization and consistency by renaming the VCS integration section to GitOps and reorganizing database change-related pages under a more logical section hierarchy.
- Renamed the
vcs-integrationdirectory togitopsthroughout documentation and updated all URL references - Moved database change administration pages from
administrationsection tochange-databasesection - Added URL redirects for backward compatibility to prevent broken links
Reviewed Changes
Copilot reviewed 41 out of 48 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/lib/route.ts | Updated VCS integration route constant to point to new gitops path |
| src/lib/glossary-data.ts | Updated reference URL for GitOps workflow glossary entry |
| mintlify/docs.json | Restructured navigation to move environment policy pages to change-database section |
| Multiple tutorial files | Updated cross-references to use new gitops and change-database paths |
| Multiple blog files | Updated GitOps and environment policy URL references |
| changelog files | Updated historical references to use new URL structure |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
📝 Broken Links Check Report
The following is the output from the broken links check: |
tianzhou
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Summary
This PR restructures the documentation navigation to improve organization and consistency:
vcs-integrationtogitopsthroughout the documentationadministrationtochange-databasesectionChanges
1. VCS Integration → GitOps
/mintlify/vcs-integration/to/mintlify/gitops/bytebase-vcs-integration.webptobytebase-gitops.webp2. Reorganized Administration Pages
Moved the following pages to the
change-databasesection where they logically belong:environment-policy/(overview, rollout-policy, tier)risk-center.mdxschema-template.mdx3. Updated References
docs.jsonnavigation structuresrc/lib/4. Added Redirects
Added redirect rules in
next.config.jsfor backward compatibility:/docs/vcs-integration/*→/docs/gitops/*/docs/administration/environment-policy/*→/docs/change-database/environment-policy/*/docs/administration/risk-center→/docs/change-database/risk-center/docs/administration/schema-template→/docs/change-database/schema-templateTest plan
🤖 Generated with Claude Code