Skip to content

Conversation

@d-bytebase
Copy link
Contributor

Summary

  • Reorganized database connection documentation for better clarity and navigation
  • Split the overly long instance.mdx file into focused, manageable pages
  • Created cloud-specific guides for AWS, GCP, and Azure

Changes

  • Moved and renamed: instance.mdx/get-started/connect/overview.mdx
  • Created new pages:
    • /get-started/connect/aws.mdx - AWS RDS/Aurora with IAM authentication
    • /get-started/connect/gcp.mdx - GCP Cloud SQL with service accounts
    • /get-started/connect/azure.mdx - Azure SQL with managed identities
  • Updated navigation: Added "Connect Databases" group under Get Started
  • Added redirect: Old /get-started/instance URL redirects to new location
  • Improved content: Added clear value propositions for secret manager integration

Benefits

  • 📚 Better organization - Cloud configs are logically grouped
  • 🔍 Improved discoverability - Users can quickly find their cloud provider's guide
  • 📖 Enhanced readability - Each page focuses on a single cloud provider
  • 🔗 Backward compatibility - Old URLs continue to work via redirect

Test plan

  • Verify all internal links work correctly
  • Check redirect from old URL works
  • Confirm navigation structure displays properly
  • Test on staging environment

🤖 Generated with Claude Code

- Split long instance.mdx into focused, cloud-specific pages
- Created new structure under /get-started/connect/ for better organization
- Added dedicated pages for AWS, GCP, and Azure with IAM authentication details
- Simplified main connection page to focus on basic setup
- Added redirect from old /get-started/instance URL for backward compatibility
- Improved navigation with "Connect Databases" group name

This restructuring makes cloud-specific configurations easier to find and maintain
while keeping basic connection setup simple and accessible.

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

Co-Authored-By: Claude <[email protected]>
Copilot AI review requested due to automatic review settings August 21, 2025 03:59
@vercel
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 4:04am

This comment was marked as outdated.

@github-actions
Copy link

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

Remove broken anchor link and use plain text reference instead

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

Co-Authored-By: Claude <[email protected]>
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 reorganizes database connection documentation by splitting the overly long instance.mdx file into focused, cloud-specific guides for better navigation and discoverability.

  • Moved and renamed the main database connection page from instance.mdx to connect/overview.mdx
  • Created dedicated guides for AWS, GCP, and Azure database connections with cloud-specific authentication methods
  • Updated navigation structure to include a new "Connect Databases" section and added redirect for backward compatibility

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
mintlify/get-started/instance.mdx Removed original file containing all database connection documentation
mintlify/get-started/connect/overview.mdx New overview page with basic connection setup and general configuration options
mintlify/get-started/connect/aws.mdx AWS-specific guide covering RDS/Aurora IAM authentication and Secrets Manager
mintlify/get-started/connect/gcp.mdx GCP-specific guide covering Cloud SQL IAM authentication and Secret Manager
mintlify/get-started/connect/azure.mdx Azure-specific guide covering Azure SQL with managed identity authentication
mintlify/docs.json Updated navigation structure and added redirect for old URL

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

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

@tianzhou tianzhou merged commit fd3c945 into main Aug 21, 2025
5 checks passed
@tianzhou tianzhou deleted the reorganize-database-connection-docs branch August 21, 2025 04:15
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