Skip to content

docs: reorganize GitOps and move Schema Diagram to SQL Editor section #853

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.

Sign up for GitHub

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

Jump to bottom
Merged
d-bytebase merged 2 commits into from
Aug 28, 2025
Merged

docs: reorganize GitOps and move Schema Diagram to SQL Editor section #853

d-bytebase merged 2 commits into from
Aug 28, 2025

Conversation

@d-bytebase
Copy link
Contributor

@d-bytebase d-bytebase commented Aug 28, 2025 •
edited
Loading

Summary

  • Moved GitOps documentation from a nested group to a dedicated "GitOps Workflow" tab under Database CI/CD
  • Relocated Schema Diagram from Database CI/CD to SQL Editor section for better alignment with its purpose as a visual tool
  • This improves navigation and visibility for GitOps-related documentation
  • Pages included: vcs-integration/overview and vcs-integration/release

Changes

  • Removed GitOps as a nested group under the main Database CI/CD section
  • Created a new "GitOps Workflow" group at the same level as "Database CI/CD" group within the Database CI/CD tab
  • Moved schema-diagram.mdx from change-database/ to sql-editor/ directory
  • Updated URL path from change-database/schema-diagram to sql-editor/schema-diagram
  • No content changes, only organizational restructuring

Test plan

  • Verify the documentation site builds successfully
  • Check that GitOps pages are accessible under the new structure
  • Confirm Schema Diagram is accessible at its new location under SQL Editor
  • Confirm navigation works as expected in the Database CI/CD and SQL Editor tabs

🤖 Generated with Claude Code

@d-bytebase @claude
docs: reorganize GitOps into dedicated workflow tab under Database CI/CD
98118eb 
- Move GitOps section from nested group to dedicated "GitOps Workflow" tab
- Maintain pages under Database CI/CD tab for better organization
- Pages included: vcs-integration/overview and vcs-integration/release

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

Co-Authored-By: Claude <[email protected]>
@vercel
Copy link

vercel bot commented Aug 28, 2025 •
edited
Loading

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

Project Deployment Preview Comments Updated (UTC)
bytebase-com Error Error Aug 28, 2025 6:40am

@d-bytebase d-bytebase requested review from adela-bytebase and tianzhou and removed request for tianzhou August 28, 2025 04:36
@d-bytebase d-bytebase enabled auto-merge (squash) August 28, 2025 04:38
@d-bytebase @claude
docs: move schema diagram from Database CI/CD to SQL Editor section
6b9d5c3 
- Relocated schema-diagram.mdx from change-database/ to sql-editor/ directory
- Updated docs.json navigation to reflect new location under SQL Editor tab
- Changed URL path from change-database/schema-diagram to sql-editor/schema-diagram

This better aligns with the schema diagram's purpose as a visual tool for understanding database structures.

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

Co-Authored-By: Claude <[email protected]>
@github-actions
Copy link

github-actions bot commented Aug 28, 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 18 broken links in 11 files

changelog/bytebase-1-11-0.mdx
 ⎿  /change-database/schema-diagram

changelog/bytebase-1-12-1.mdx
 ⎿  /change-database/schema-diagram

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

@d-bytebase d-bytebase changed the title docs: reorganize GitOps into dedicated workflow tab under Database CI/CD docs: reorganize GitOps and move Schema Diagram to SQL Editor section Aug 28, 2025
tianzhou
tianzhou approved these changes Aug 28, 2025
View reviewed changes
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 f216e33 into main Aug 28, 2025
4 of 5 checks passed
@d-bytebase d-bytebase deleted the reorganize-gitops-docs branch August 28, 2025 06:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tianzhou tianzhou tianzhou approved these changes

@adela-bytebase adela-bytebase Awaiting requested review from adela-bytebase adela-bytebase is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@d-bytebase @tianzhou