-
Notifications
You must be signed in to change notification settings - Fork 30
Update and restructure SQL Server integration docs #139
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
base: main
Are you sure you want to change the base?
Update and restructure SQL Server integration docs #139
Conversation
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 restructures the SQL Server integration documentation to improve accessibility for beginners while maintaining comprehensive information. The changes align the SQL Server docs with the existing PostgreSQL documentation structure, splitting a single large file into multiple focused documents.
- Splits monolithic SQL Server integration doc into separate Hosting and Client integration references
- Adds a beginner-friendly getting started guide with examples for C#, Python, and JavaScript
- Adds "Properties of the SQL Server resources" section documenting environment variables and connection properties
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
sql-server-host.mdx |
New hosting integration reference covering SQL Server resource creation, database scripts, data persistence, and container configuration |
sql-server-get-started.mdx |
New getting started tutorial with multi-language examples (C#, Python, JavaScript) for quickly implementing SQL Server integrations |
sql-server-client.mdx |
New client integration reference documenting connection setup, keyed services, configuration options, and observability features |
sql-server-extensions.mdx |
Updated links to reflect new file structure and navigation paths |
sidebar.topics.ts |
Updated navigation structure to match PostgreSQL's four-section layout (Get started, Hosting, Client, Extensions) |
sql-server.mdx |
Deleted original monolithic integration document |
Comments suppressed due to low confidence (1)
src/frontend/src/content/docs/integrations/databases/sql-server/sql-server-extensions.mdx:97
- The relative path to the integrations overview is incorrect. From the sql-server subdirectory, "../overview.md" would resolve to "databases/overview.md" which doesn't exist. The correct path should be "../../overview.md" to go up two levels from sql-server/ to integrations/.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The existing SQL Server integration document is comprehensive but difficult for beginners. This PR is intended to keep the comprehensive information but make it easier for those who want to get going quickly. I've used Copilot to propagate changes from the new PostgreSQL documents to the SQL Server ones.
This PR: