Skip to content

Update and restructure Azure PostgreSQL integration docs#309

Merged
IEvangelist merged 7 commits intomicrosoft:mainfrom
alistairmatthews:restructure-azure-postgres-docs
Jan 30, 2026
Merged

Update and restructure Azure PostgreSQL integration docs#309
IEvangelist merged 7 commits intomicrosoft:mainfrom
alistairmatthews:restructure-azure-postgres-docs

Conversation

@alistairmatthews
Copy link
Contributor

The existing Azure PostgreSQL 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 non-Azure PostgreSQL documents to the Azure PostgreSQL ones.

This PR:

  • Splits the large integration doc into two: Hosting and Client.
  • Adds a getting started short tutorial.
  • Adds a Properties of the Azure PostgreSQL resources section to the client reference docs. This describes what configuration values are injected by the WithReference() method.

@alistairmatthews alistairmatthews marked this pull request as ready for review January 29, 2026 14:00
Copilot AI review requested due to automatic review settings January 29, 2026 14:00
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 pull request restructures the Azure PostgreSQL integration documentation from a single comprehensive document into three focused documents (Get Started, Hosting, and Client), following the same pattern as the non-Azure PostgreSQL documentation and other split integrations in the codebase.

Changes:

  • Split the monolithic azure-postgresql.mdx file into three separate documents: a getting started guide, a hosting integration reference, and a client integration reference
  • Updated all navigation structures (sidebar, integration-docs.json) and added a redirect for the old URL
  • Added comprehensive documentation of the properties injected by WithReference() in the client reference

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
integration-docs.json Updated package mappings to point to the new get-started page
aspire-9.mdx Updated reference link to the new get-started page
overview.mdx Updated table reference to the new get-started page
azure-postgresql-host.mdx New hosting integration reference document with resource management and provisioning details
azure-postgresql-get-started.mdx New getting started tutorial with multi-language support (C#, Python, JavaScript)
azure-postgresql-client.mdx New client integration reference with properties documentation and configuration options
azure-postgresql.mdx Deleted the original monolithic document (content migrated to new files)
integrations.topics.ts Updated sidebar to display Azure PostgreSQL as collapsible section with three sub-pages
redirects.mjs Added redirect from old URL to new get-started page

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@IEvangelist IEvangelist merged commit e5f924a into microsoft:main Jan 30, 2026
6 checks passed
@alistairmatthews alistairmatthews deleted the restructure-azure-postgres-docs branch January 30, 2026 15:30
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

Comments