Improve Azure API Management documentation readability and structure#128481
Open
tanvishinde017 wants to merge 25 commits into
Open
Improve Azure API Management documentation readability and structure#128481tanvishinde017 wants to merge 25 commits into
tanvishinde017 wants to merge 25 commits into
Conversation
Corrected grammar and formatting in migration documentation.
Contributor
|
Learn Build status updates of commit fa27621:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/app-service/app-service-asp-net-migration.md | Details |
articles/app-service/app-service-asp-net-migration.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading. - Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Revised customer intent statement for clarity and completeness.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR appears intended to improve Azure API Management documentation readability and structure, but the provided diff updates an Azure App Service .NET migration article and introduces Markdown formatting that would break page rendering.
Changes:
- Reformats sections and lists in
app-service-asp-net-migration.mdfor readability. - Restructures resource lists from tables into headings + bullet lists.
- (Accidentally) wraps the entire article in a fenced code block.
Comments suppressed due to low confidence (1)
articles/app-service/app-service-asp-net-migration.md:6
- The opening fenced code block (```md) will cause the entire article (including YAML front matter) to render as a code snippet instead of a Docs page. Remove the fenced code block opener so the page renders correctly.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Related content | ||
|
|
||
| - [Migrate an on-premises web application to Azure App Service](/training/modules/migrate-app-service-migration-assistant/) No newline at end of file | ||
| - [Migrate an on-premises web application to Azure App Service](/training/modules/migrate-app-service-migration-assistant/) |
Contributor
|
@tanvishinde017 please remove the code block markers at lines 1 and 133 to resolve the warnings. Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
Contributor
|
Learn Build status updates of commit bff1215:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/active-directory-b2c/access-tokens.md | Details | ||
| articles/app-service/app-service-asp-net-migration.md | Details |
articles/active-directory-b2c/access-tokens.md
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 1, Column 1: [Suggestion: ms-service-suggested]
Missing required attribute: 'ms.service'. ms.service is suggested for each article that is published on Learn.
articles/app-service/app-service-asp-net-migration.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading. - Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Contributor
|
Learn Build status updates of commit bb7882f:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/active-directory-b2c/access-tokens.md | Details | ||
| articles/app-service/app-service-asp-net-migration.md | Details |
articles/active-directory-b2c/access-tokens.md
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 1, Column 1: [Suggestion: ms-service-suggested]
Missing required attribute: 'ms.service'. ms.service is suggested for each article that is published on Learn.
articles/app-service/app-service-asp-net-migration.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading. - Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Author
|
Thanks for the review. I removed the unintended code block markers from The PR has been updated and is ready for another review. |
Improve App Service plan documentation readability and formatting consistency
Contributor
|
Learn Build status updates of commit 52f8a39:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/active-directory-b2c/access-tokens.md | Details | ||
| articles/app-service/app-service-asp-net-migration.md | Details |
articles/active-directory-b2c/access-tokens.md
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 1, Column 1: [Suggestion: ms-service-suggested]
Missing required attribute: 'ms.service'. ms.service is suggested for each article that is published on Learn.
articles/app-service/app-service-asp-net-migration.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading. - Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Updated summaries and titles for clarity and consistency. Revised descriptions and links for better understanding of Azure App Testing features.
Improve Azure App Testing landing page readability and content organization
Updated the FAQ article for WordPress on Azure App Service to enhance descriptions, correct terminology, and improve clarity on various topics including security, performance, and configuration.
## Summary Enhanced the WordPress on Azure App Service FAQ documentation by improving content structure, refining technical explanations, and expanding operational guidance for deployment, security, monitoring, scaling, and troubleshooting scenarios. ## Key improvements ### Documentation quality and readability * Refined article introduction and FAQ flow for improved discoverability * Standardized formatting, capitalization, and terminology across all sections * Improved readability of technical explanations and operational guidance * Simplified complex configuration workflows into clearer step-based guidance ### Security and identity enhancements * Expanded security recommendations for App Service, MySQL Flexible Server, and Microsoft Entra integrations * Clarified managed identity authentication and phpMyAdmin access workflows * Improved guidance for HTTPS, VNet integration, Key Vault, and Defender for Cloud scenarios * Enhanced explanations for enterprise authentication and access management ### Performance and scalability guidance * Improved recommendations for scaling, caching, and enterprise-grade deployments * Enhanced guidance for Azure Front Door, Blob Storage, Redis Cache, and dynamic caching integrations * Clarified App Service plan sizing considerations and hosting capacity recommendations * Added more actionable performance optimization references ### Troubleshooting and monitoring improvements * Reorganized debugging and monitoring sections for easier navigation * Improved troubleshooting guidance for common WordPress deployment issues * Enhanced log access, Kudu, SSH, and diagnostic workflow explanations * Refined phpMyAdmin and database access documentation for clarity and operational accuracy ### Developer and deployment experience * Improved CI/CD, startup script, and configuration guidance * Enhanced documentation for custom domains, multisite deployments, and headless WordPress architectures * Updated enterprise deployment recommendations and production readiness guidance * Improved consistency across external references and Azure service integrations ## Files updated * `articles/app-service/wordpress-faq.md` ## Impact These updates improve the overall developer and administrator experience by making the FAQ easier to navigate, more technically accurate, and more actionable for enterprise WordPress deployments on Azure App Service. The revised structure and guidance help users better understand operational best practices, troubleshoot issues more efficiently, and deploy scalable, secure, production-ready WordPress environments on Azure.
Contributor
|
Learn Build status updates of commit f782bfa:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/active-directory-b2c/access-tokens.md | Details | ||
| articles/app-service/app-service-asp-net-migration.md | Details | ||
| articles/app-service/app-service-plan-manage.md | ✅Succeeded |
articles/active-directory-b2c/access-tokens.md
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 1, Column 1: [Suggestion: ms-service-suggested]
Missing required attribute: 'ms.service'. ms.service is suggested for each article that is published on Learn.
articles/app-service/app-service-asp-net-migration.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading. - Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Contributor
|
Learn Build status updates of commit f145060:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/active-directory-b2c/access-tokens.md | Details | ||
| articles/app-service/app-service-asp-net-migration.md | Details | ||
| articles/app-service/app-service-plan-manage.md | ✅Succeeded | ||
| articles/app-testing/index.yml | ✅Succeeded |
articles/active-directory-b2c/access-tokens.md
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 1, Column 1: [Suggestion: ms-service-suggested]
Missing required attribute: 'ms.service'. ms.service is suggested for each article that is published on Learn.
articles/app-service/app-service-asp-net-migration.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading. - Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Updated the article to clarify the usage of Azure Key Vault references in app settings and connection strings, including access permissions and troubleshooting.
## Summary Added comprehensive Markdown documentation for using Azure Key Vault references as application settings in: - Azure App Service - Azure Functions - Azure Logic Apps (Standard) ## Changes Included - Added managed identity configuration guidance - Documented Key Vault access setup and RBAC permissions - Added support details for user-assigned identities - Included network-restricted vault configuration - Added secret rotation and refresh behavior documentation - Documented Key Vault reference formats with examples - Added Azure Files mounting considerations - Included Application Insights integration notes - Added ARM template deployment examples - Improved troubleshooting guidance and diagnostics steps - Added security and deployment best practices ## Benefits - Improves readability and maintainability of documentation - Provides end-to-end guidance for secure secret management - Helps developers implement production-ready Key Vault integration - Simplifies onboarding for App Service and Functions users
Contributor
|
@tanvishinde017 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. @reddyabhishek |
Contributor
|
Learn Build status updates of commit 380730a:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| articles/active-directory-b2c/access-tokens.md | Details | ||
| articles/app-service/app-service-asp-net-migration.md | Details | ||
| articles/app-service/app-service-plan-manage.md | ✅Succeeded | ||
| articles/app-service/wordpress-faq.md | ✅Succeeded | ||
| articles/app-testing/index.yml | ✅Succeeded |
articles/active-directory-b2c/access-tokens.md
- Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 17, Column 1: [Warning: yaml-header-syntax-error - See documentation]
While parsing a block mapping, did not find expected key. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 1, Column 1: [Suggestion: ms-service-suggested]
Missing required attribute: 'ms.service'. ms.service is suggested for each article that is published on Learn.
articles/app-service/app-service-asp-net-migration.md
- Line 0, Column 0: [Warning: h1-missing - See documentation]
H1 is required. Use a single hash (#) followed by a space to create your top-level heading. - Line 1, Column 1: [Warning: author-missing - See documentation]
Missing required attribute: 'author'. Add the current author's GitHub ID. - Line 1, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 1, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 1, Column 1: [Warning: ms-topic-missing - See documentation]
Missing required attribute: 'ms.topic'. - Line 1, Column 1: [Suggestion: ms-date-missing - See documentation]
Missing required attribute: 'ms.date'. - Line 1, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Contributor
|
Learn Build status updates of commit 01d067a:
|
Contributor
|
Learn Build status updates of commit dfe7001:
|
Updated the agent registry overview to enhance clarity and detail, including improved descriptions and structured sections for key features, registration, management, and dependency tracking.
Fix formatting of link in agent overview documentation
Updated the access tokens documentation for clarity and accuracy, including changes to the customer intent, access token descriptions, and scope explanations.
Revise access tokens documentation for clarity
Contributor
|
Learn Build status updates of commit bf99ef3:
|
Update overview-what-is-azure-app-testing.md
Contributor
|
Learn Build status updates of commit 881fe2c:
|
Contributor
|
Learn Build status updates of commit 99cf52f:
|
Contributor
|
@tanvishinde017 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
Contributor
|
Learn Build status updates of commit c147525:
|
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.
Summary
Improved Azure API Management documentation by enhancing readability, structure, and developer guidance across multiple articles.
Changes made
Articles updated
Impact
These updates improve the overall developer experience and make the documentation easier to follow for API developers and citizen developers using Azure API Management integrations.