-
Notifications
You must be signed in to change notification settings - Fork 3
docs: reorganize database connection documentation #841
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
- 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]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 Broken Links Check Report
The following is the output from the broken links check: |
Remove broken anchor link and use plain text reference instead 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
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 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.mdxtoconnect/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.
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
instance.mdxfile into focused, manageable pagesChanges
instance.mdx→/get-started/connect/overview.mdx/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/get-started/instanceURL redirects to new locationBenefits
Test plan
🤖 Generated with Claude Code