Skip to content

Conversation

@d-bytebase
Copy link
Contributor

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

Summary

  • Consolidated connection guidelines into a single, cleaner "Database Connectivity" section
  • Removed redundant screenshot images that weren't adding value
  • Improved clarity and readability of connection instructions

Changes

  • Structure improvement: Combined separate connection sections into one unified list under "Database Connectivity"
  • Content simplification: Shortened verbose connection instructions while maintaining clarity
    • Docker standard mode: Use host.docker.internal
    • Docker with --network host: Use 127.0.0.1
    • Bytebase Cloud: Whitelist required IPs
  • Image cleanup: Removed connect-local-docker.webp and connect-local-no-docker.webp screenshots

Test plan

  • Verified all internal links still work
  • Confirmed Docker connection instructions are accurate
  • Checked Cloud prerequisites link is valid

🤖 Generated with Claude Code

- Change title from "Connect Your Database" to "Add Database Instance" for consistency
- Consolidate connection guidelines into single "Database Connectivity" section
- Simplify Docker and Cloud connection instructions
- Remove redundant screenshot images
- Improve readability with clearer, more concise wording

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

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

vercel bot commented Aug 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
bytebase-com Ready Preview Comment Aug 13, 2025 4:28pm

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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@github-actions
Copy link

github-actions bot commented Aug 13, 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

@d-bytebase d-bytebase merged commit 34cce38 into main Aug 13, 2025
4 of 5 checks passed
@d-bytebase d-bytebase deleted the update-instance-docs-terminology branch August 13, 2025 16:27
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