Skip to content

docs: remove outdated manual sync instance schema section #844

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

Merged
merged 1 commit into from
Aug 21, 2025

Conversation

d-bytebase
Copy link
Contributor

Summary

  • Removed the "Sync instance schema" section from the add-an-instance documentation
  • This section described a manual sync process that is no longer needed
  • Instance schema is now automatically synchronized upon instance creation

Why this change?

The documentation was outdated and could confuse users. When an instance is added to Bytebase, the schema synchronization happens automatically - users no longer need to manually click "Sync Now" as a separate step after adding an instance.

Keeping this section in the documentation would lead users to look for a "Sync Now" button that may not be prominently displayed or necessary for the initial setup, potentially causing confusion during onboarding.

Test plan

  • Verified the MDX file renders correctly without the removed section
  • Confirm that new instances automatically sync their schema upon creation
  • Check that the documentation flow remains clear without this section

🤖 Generated with Claude Code

The "Sync instance schema" section is no longer accurate as Bytebase now automatically synchronizes the instance schema upon instance creation. Manual sync is no longer required for newly added instances.

This removes unnecessary steps from the onboarding documentation and prevents user confusion about when schema synchronization occurs.

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

Co-Authored-By: Claude <noreply@anthropic.com>
@Copilot Copilot AI review requested due to automatic review settings August 21, 2025 07:32
Copy link

vercel bot commented Aug 21, 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 21, 2025 7:35am

Copy link
Contributor

@Copilot 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 removes an outdated section from the instance setup documentation that described a manual schema synchronization process that is no longer required.

  • Removes the "Sync instance schema" section that instructed users to manually click "Sync Now"
  • Eliminates outdated information about manual schema synchronization after instance creation
  • Streamlines the documentation to reflect current automatic schema sync behavior

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

Copy link

📝 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

@d-bytebase d-bytebase merged commit 6983769 into main Aug 21, 2025
5 checks passed
@d-bytebase d-bytebase deleted the remove-sync-instance-schema-section branch August 21, 2025 07:35
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.

2 participants