Update and restructure remaining Azure integration docs #390
Open
alistairmatthews wants to merge 36 commits intomicrosoft:mainfrom
Open
Update and restructure remaining Azure integration docs #390alistairmatthews wants to merge 36 commits intomicrosoft:mainfrom
alistairmatthews wants to merge 36 commits intomicrosoft:mainfrom
Conversation
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
…d preview badges - Replace AddAzureRedis with AddAzureManagedRedis in cache-redis files - Replace AddAzureQueueClient with AddAzureQueueServiceClient in storage-queues - Replace AddAzureTableClient with AddAzureTableServiceClient in storage-tables - Fix duplicate 'csharp csharp' identifiers in cosmos-db-host.mdx - Add preview badge to Azure OpenAI get-started and client docs Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
…-for-azure-integrations Restructure 18 Azure integrations into subfolder pattern
…ng-azure-integrations
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures Azure integration documentation to be more beginner-friendly by introducing “get started” entry points and splitting monolithic integration pages into hosting vs. client reference pages, while updating internal links and redirects accordingly.
Changes:
- Added “get started” MDX pages for multiple Azure integrations and updated integration landing links to point to them.
- Split several Azure integration docs into separate hosting/client pages (or hosting-only pages where applicable), including new “Properties of … resources” sections for
WithReference()-injected configuration. - Updated cross-doc links, added redirects for legacy integration URLs, and bumped frontend Astro/Starlight dependencies.
Reviewed changes
Copilot reviewed 76 out of 77 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/data/integration-docs.json | Updates package-to-doc links to new “get started” entry pages. |
| src/frontend/src/content/docs/whats-new/aspire-9.mdx | Updates Azure integration links to new page structure. |
| src/frontend/src/content/docs/whats-new/aspire-9-5.mdx | Updates Azure AI Foundry / Redis links to new “get started” pages. |
| src/frontend/src/content/docs/whats-new/aspire-9-4.mdx | Updates multiple Azure integration links to “get started” pages. |
| src/frontend/src/content/docs/whats-new/aspire-9-1.mdx | Updates emulator-related Azure integration links to new hosting/get-started pages. |
| src/frontend/src/content/docs/whats-new/aspire-13-1.mdx | Updates Azure Functions integration link to new “get started” page. |
| src/frontend/src/content/docs/ja/whats-new/aspire-13-1.mdx | Updates Azure Functions integration link to new “get started” page (JA locale). |
| src/frontend/src/content/docs/integrations/databases/efcore/azure-cosmos-db/azure-cosmos-db-host.mdx | Fixes code-fence language metadata in updated hosting doc. |
| src/frontend/src/content/docs/integrations/cloud/azure/role-assignments.mdx | Updates integration links to new “get started” pages and corrects storage integration references. |
| src/frontend/src/content/docs/integrations/cloud/azure/overview.mdx | Updates integration links in overview tables to new “get started” pages. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-web-pubsub/azure-web-pubsub-host.mdx | Converts original combined doc into hosting-only reference page. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-web-pubsub/azure-web-pubsub-get-started.mdx | Adds a beginner “get started” walkthrough for Web PubSub hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-web-pubsub/azure-web-pubsub-client.mdx | Adds client reference + WithReference()-injected properties section. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-tables/azure-storage-tables-host.mdx | Converts combined doc into hosting-only reference page. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-tables/azure-storage-tables-get-started.mdx | Adds “get started” walkthrough for Table Storage hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-tables/azure-storage-tables-client.mdx | Adds client reference + injected properties section. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-queues/azure-storage-queues-host.mdx | Converts combined doc into hosting-only reference page. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-queues/azure-storage-queues-get-started.mdx | Adds “get started” walkthrough for Queue Storage hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-queues/azure-storage-queues-client.mdx | Adds client reference + injected properties section. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-blobs/azure-storage-blobs-host.mdx | Converts combined doc into hosting-only reference page. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-blobs/azure-storage-blobs-get-started.mdx | Adds “get started” walkthrough for Blob Storage hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-storage-blobs/azure-storage-blobs-client.mdx | Adds client reference + injected properties section. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database/azure-sql-database-host.mdx | Converts combined doc into hosting-only reference and links to get-started. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database/azure-sql-database-get-started.mdx | Adds “get started” walkthrough for Azure SQL Database hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database/azure-sql-database-client.mdx | Adds client reference + injected properties section. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-signalr/azure-signalr-host.mdx | Converts combined doc into hosting-only reference and links to get-started. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-signalr/azure-signalr-get-started.mdx | Adds “get started” walkthrough for SignalR hosting + hub-host usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-signalr/azure-signalr-client.mdx | Adds hub-host reference page split from prior combined doc. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-service-bus/azure-service-bus-get-started.mdx | Adds “get started” walkthrough for Service Bus hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-openai/azure-openai-get-started.mdx | Adds “get started” walkthrough for Azure OpenAI hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-key-vault/azure-key-vault-host.mdx | Adds hosting reference page with provisioning + connection properties. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-key-vault/azure-key-vault-get-started.mdx | Adds “get started” walkthrough for Key Vault hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-functions/azure-functions-host.mdx | Refactors Azure Functions doc to hosting-focused content. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-functions/azure-functions-get-started.mdx | Adds “get started” walkthrough for Azure Functions hosting. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-functions/azure-functions-client.mdx | Adds stub client page indicating hosting-only integration. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-event-hubs/azure-event-hubs-get-started.mdx | Adds “get started” walkthrough for Event Hubs hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-cosmos-db/azure-cosmos-db-host.mdx | Converts combined doc into hosting-only reference and fixes code-fence metadata. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-cosmos-db/azure-cosmos-db-get-started.mdx | Adds “get started” walkthrough for Cosmos DB hosting + EF Core client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-cosmos-db/azure-cosmos-db-client.mdx | Adds client reference + injected properties section. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-container-registry/azure-container-registry-host.mdx | Refactors ACR doc to hosting-focused reference sections. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-container-registry/azure-container-registry-get-started.mdx | Adds “get started” walkthrough for ACR hosting integration. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-container-registry/azure-container-registry-client.mdx | Adds stub client page indicating hosting-only integration. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-cache-redis/azure-cache-redis-get-started.mdx | Adds “get started” walkthrough for Azure Cache for Redis hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-cache-redis/azure-cache-redis-client.mdx | Adds client reference + injected properties section. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-app-service/azure-app-service-host.mdx | Refactors App Service doc to hosting-focused reference content. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-app-service/azure-app-service-get-started.mdx | Adds “get started” walkthrough for App Service hosting integration. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-app-service/azure-app-service-client.mdx | Adds stub client page clarifying hosting-only behavior. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-app-configuration/azure-app-configuration-get-started.mdx | Adds “get started” walkthrough for App Configuration hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-app-configuration/azure-app-configuration-client.mdx | Adds client reference page for App Configuration. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-search/azure-ai-search-host.mdx | Adds hosting reference page for Azure AI Search. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-search/azure-ai-search-get-started.mdx | Adds “get started” walkthrough for Azure AI Search hosting + client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-inference/azure-ai-inference-host.mdx | Adds hosting reference page describing connection-string-based setup. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-inference/azure-ai-inference-get-started.mdx | Adds “get started” walkthrough for Azure AI Inference setup and usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-inference/azure-ai-inference-client.mdx | Refactors to client-only reference page and updates internal links. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-host.mdx | Refactors Foundry doc into hosting-only reference + get-started link. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-get-started.mdx | Adds “get started” walkthrough for Azure AI Foundry hosting + inference client usage. |
| src/frontend/src/content/docs/integrations/cloud/azure/azure-ai-foundry/azure-ai-foundry-client.mdx | Adds client page that points to Azure AI Inference integration. |
| src/frontend/src/content/docs/integrations/cloud/azure/ai-compatibility-matrix.mdx | Updates AI integration links to new “get started” pages. |
| src/frontend/src/content/docs/deployment/overview.mdx | Updates App Service deployment integration link to new entry page. |
| src/frontend/src/content/docs/deployment/azure/azure-security-best-practices.mdx | Updates Key Vault integration links to new entry page. |
| src/frontend/package.json | Bumps Astro/Starlight/RSS package versions. |
| src/frontend/config/redirects.mjs | Adds redirects from legacy Azure integration URLs to new “get started” pages. |
Files not reviewed (1)
- src/frontend/pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
src/frontend/src/content/docs/integrations/cloud/azure/azure-functions/azure-functions-host.mdx:32
- Inline code spans are currently escaped (`) so they will render with literal backticks instead of code formatting. Remove the backslashes so package/type names like
Microsoft.Azure.Functions.Worker.Sdk,WithExternalHttpEndpoints, andAzureFunctionsProjectResourcerender correctly.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.../src/content/docs/integrations/cloud/azure/azure-web-pubsub/azure-web-pubsub-get-started.mdx
Show resolved
Hide resolved
...ontent/docs/integrations/cloud/azure/azure-storage-blobs/azure-storage-blobs-get-started.mdx
Show resolved
Hide resolved
Member
|
@alistairmatthews - I'm adding a new "Azure Networking" integration docs in #401. Will that work with this new format? What changes should I make to that PR in response to this? |
Contributor
Author
@eerhardt - The new three-part approach (Getting Started/Hosting integration/Client integration) is for those with both a hosting integration and a client integration. Am I right in thinking that the Azure Network integration has a hosting part only? If so, you can stick with your current structure. When I decide what to do about the others that don't have a client int, I'll include Azure Networking then if it's necessary. Thanks for checking! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The existing integration documents for most Azure integrations are 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.
For each of the remaining Azure integrations, this PR: