Improve documentation #1725
Open
Improve documentation #1725
+28
−28
Conversation
This file contains 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
|
Learn Build status updates of commit 5a15b3f:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs-ref-services/mgmt-loganalytics-readme-pre.md | View (azure-python-preview || azure-python || azure-python-previous) | Details | |
| docs-ref-services/communication-administration-readme-pre.md | ✅Succeeded | ||
| README.md | ✅Succeeded | ||
| SECURITY.md | ✅Succeeded |
docs-ref-services/mgmt-loganalytics-readme-pre.md
- Line 2, Column 1: [Warning: title-missing - See documentation]
Missing required attribute: 'title'. Add a title string to show in search engine results. - Line 2, Column 1: [Warning: ms-prod-missing - See documentation]
Missing attribute: 'ms.prod'. If you specify 'ms.technology', you must also specify 'ms.prod'. - Line 13, Column 1: [Warning: duplicate-h1s - See documentation]
H1 'Microsoft Azure SDK for Python' is duplicated with other articles: 'docs-ref-services/latest/ai-language-nspkg-readme.md(13,1), docs-ref-services/latest/messaging-nspkg-readme.md(13,1), docs-ref-services/latest/mgmt-changeanalysis-readme.md(14,1), docs-ref-services/latest/mgmt-loadtestservice-readme.md(11,1), docs-ref-services/latest/monitor-nspkg-readme.md(13,1),...'. First level headings must be unique within a docset. - Line 13, Column 1: [Warning: duplicate-titles - See documentation]
Title 'Microsoft Azure SDK for Python' is duplicated in: 'docs-ref-services/latest/ai-language-nspkg-readme.md(13,1), docs-ref-services/latest/messaging-nspkg-readme.md(13,1), docs-ref-services/latest/mgmt-changeanalysis-readme.md(14,1), docs-ref-services/latest/mgmt-loadtestservice-readme.md(11,1), docs-ref-services/latest/monitor-nspkg-readme.md(13,1),...'. Titles must be unique within a docset. - Line 20, Column 1: [Warning: multiple-h1s - See documentation]
Multiple H1s(H1 'Usage') are not allowed. You can only have one top-level heading. - Line 20, Column 1: [Warning: duplicate-h1s - See documentation]
H1 'Usage' is duplicated with other articles: 'docs-ref-services/latest/mgmt-changeanalysis-readme.md(21,1), docs-ref-services/latest/mgmt-loadtestservice-readme.md(21,1), docs-ref-services/latest/servicefabric-readme.md(19,1), docs-ref-services/mgmt-loganalytics-readme-pre.md(20,1)'. First level headings must be unique within a docset. - Line 32, Column 1: [Warning: multiple-h1s - See documentation]
Multiple H1s(H1 'Provide Feedback') are not allowed. You can only have one top-level heading. - Line 32, Column 1: [Warning: duplicate-h1s - See documentation]
H1 'Provide Feedback' is duplicated with other articles: 'docs-ref-services/latest/mgmt-changeanalysis-readme.md(33,1), docs-ref-services/latest/mgmt-loadtestservice-readme.md(31,1), docs-ref-services/latest/servicefabric-readme.md(27,1), docs-ref-services/mgmt-loganalytics-readme-pre.md(32,1)'. First level headings must be unique within a docset. - Line 2, Column 1: [Suggestion: description-missing - See documentation]
Missing required attribute: 'description'. - Line 5, Column 12: [Suggestion: ms-author-invalid - See documentation]
Invalid value for 'ms.author', 'ramyar' is not a valid Microsoft alias. - Line 27, Column 30: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/python/api/overview/azure/' will be broken in isolated environments. Replace with a relative link. - Line 28, Column 47: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing' will be broken in isolated environments. Replace with a relative link.
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.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
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.
Fix some typos and rewrite documentation