-
Notifications
You must be signed in to change notification settings - Fork 245
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
[bulk] Validation: Metadata and Absolute Links #2283
Conversation
Docs Build status updates of commit 2fd6c74: ✅ Validation status: passed
docs-ref-services/preview/cosmos-readme.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Docs Build status updates of commit 3c67190: ✅ Validation status: passed
docs-ref-services/preview/cosmos-readme.md
docs-ref-services/preview/data-appconfiguration-readme.md
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Docs Build status updates of commit 5e859ba: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Docs Build status updates of commit e632ec1: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings 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:
|
Docs Build status updates of commit e632ec1: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Global effort to fix build validation errors The Content & Learning team is fixing build validation errors on docs.microsoft.com for the rest of H2. This will eliminate potential accessibility, security, and usability issues. This PR includes only build validation fixes and does not change other content. Please review within five business days and merge or comment in the PR with any changes you’d like to see. Thank you! |
@v-emilypr - this is the same issue what we discussed last week, we cannot fix these readme.mds, as they will break links in the azure-sdk-for-java repo. Also, I see someone else created this PR - #2276 I am wondering, why these PRs are being created and who is managing these because I see duplicate work being done here, which doesn't make sense to me. Just want to save your effort on these PRs, as we already went over this investigation and found out the issues last week :) |
@kushagraThapar, should we back out all changes to absolute links on readme.mds on the azure-docs-sdk-java repo? The validation team is working to clear the build warnings from this repo. I will loop in our content manager @v-andreaco so that we can coordinate how this should be best handled. |
Thanks so much for your patience! We have a large team working on these issues, so sometimes announcements slip through. I really appreciate you taking the time to explain, and we'll send out a stronger note to the team to back these changes up. I think I asked in another PR if metadata changes will also be overwritten, and I don't remember seeing if that was answered. Should our team revert all changes to these files, or just the content edits, and metadata changes can go through? Thanks again for being so helpful!! I know your time is valuable, and we really appreciate you taking the time to help us! |
@v-andreaco - metadata changes can still go through, but my concern is this: We release our SDKs once every month (on usual cadence), and sometimes twice in a month. With every release, our docs go out as part of the release process, which I am not sure will keep the meta data changes that your team is making or not. One way to find out is to merge one of the PRs for the metadata changes, and see in May 2nd week, (once we release), if they will be kept or erased. Let me know if this works or not ! |
That sounds like a great idea! Can we test with this one? |
@kushagraThapar and @v-andreaco I have backed out the content changes and left metadata in place for testing on this PR. |
Docs Build status updates of commit 8261517:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs-ref-services/preview/data-appconfiguration-readme.md | View (azure-java-preview) | Details | |
docs-ref-services/preview/cosmos-readme.md | 💡Suggestion | View (azure-java-preview) | Details |
docs-ref-services/preview/data-appconfiguration-readme.md
- Line 23, Column 1: [Warning: table-syntax-invalid - See documentation]
Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.
- Line 24, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration' will be broken in isolated environments. Replace with a relative link.
- Line 30, Column 5: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable' will be broken in isolated environments. Replace with a relative link.
- Line 30, Column 5: [Suggestion: preserve-view-not-set - See documentation]
Did you mean to link to a specific version? It's usually better not to specify a version, so the link always goes to the canonical version. If you really need to link to a specific version, add &preserve-view=true to the URL: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable. Otherwise, remove the view parameter.
- Line 32, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/quickstart-dotnet-core-app#create-an-app-configuration-store' will be broken in isolated environments. Replace with a relative link.
- Line 48, Column 65: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 72, Column 9: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 109, Column 6: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 138, Column 30: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/rest-api-authorization-azure-ad#roles' will be broken in isolated environments. Replace with a relative link.
- Line 409, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/quickstart-java-spring-app' will be broken in isolated environments. Replace with a relative link.
docs-ref-services/preview/cosmos-readme.md
- Line 16, Column 64: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query' will be broken in isolated environments. Replace with a relative link.
- Line 16, Column 92: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/' will be broken in isolated environments. Replace with a relative link.
- Line 18, Column 115: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/introduction' will be broken in isolated environments. Replace with a relative link.
- Line 71, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/java/azure/jdk/' will be broken in isolated environments. Replace with a relative link.
- Line 72, Column 391: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/local-emulator-export-ssl-certificates' will be broken in isolated environments. Replace with a relative link.
- Line 109, Column 57: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/databases-containers-items' will be broken in isolated environments. Replace with a relative link.
- Line 115, Column 45: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/distribute-data-globally' will be broken in isolated environments. Replace with a relative link.
- Line 120, Column 49: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/set-throughput' will be broken in isolated environments. Replace with a relative link.
- Line 127, Column 39: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/request-units' will be broken in isolated environments. Replace with a relative link.
- Line 134, Column 39: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/partitioning-overview' will be broken in isolated environments. Replace with a relative link.
- Line 240, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/performance-tips-java-sdk-v4-sql?tabs=api-async' will be broken in isolated environments. Replace with a relative link.
- Line 242, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/troubleshoot-java-sdk-v4-sql' will be broken in isolated environments. Replace with a relative link.
- Line 284, Column 14: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/create-sql-api-java?tabs=sync' will be broken in isolated environments. Replace with a relative link.
- Line 285, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/introduction' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.
Note: Your PR may contain errors or warnings 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 docs.microsoft.com contributor guides
- Post your question in the Docs support channel
Docs Build status updates of commit d23b4b6:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs-ref-services/preview/data-appconfiguration-readme.md | View (azure-java-preview) | Details | |
docs-ref-services/preview/cosmos-readme.md | 💡Suggestion | View (azure-java-preview) | Details |
docs-ref-services/preview/data-appconfiguration-readme.md
- Line 23, Column 1: [Warning: table-syntax-invalid - See documentation]
Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.
- Line 24, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration' will be broken in isolated environments. Replace with a relative link.
- Line 30, Column 5: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable' will be broken in isolated environments. Replace with a relative link.
- Line 30, Column 5: [Suggestion: preserve-view-not-set - See documentation]
Did you mean to link to a specific version? It's usually better not to specify a version, so the link always goes to the canonical version. If you really need to link to a specific version, add &preserve-view=true to the URL: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable. Otherwise, remove the view parameter.
- Line 32, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/quickstart-dotnet-core-app#create-an-app-configuration-store' will be broken in isolated environments. Replace with a relative link.
- Line 48, Column 65: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 72, Column 9: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 109, Column 6: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 138, Column 30: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/rest-api-authorization-azure-ad#roles' will be broken in isolated environments. Replace with a relative link.
- Line 409, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/quickstart-java-spring-app' will be broken in isolated environments. Replace with a relative link.
docs-ref-services/preview/cosmos-readme.md
- Line 16, Column 64: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query' will be broken in isolated environments. Replace with a relative link.
- Line 16, Column 92: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/' will be broken in isolated environments. Replace with a relative link.
- Line 18, Column 115: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/introduction' will be broken in isolated environments. Replace with a relative link.
- Line 71, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/java/azure/jdk/' will be broken in isolated environments. Replace with a relative link.
- Line 72, Column 391: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/local-emulator-export-ssl-certificates' will be broken in isolated environments. Replace with a relative link.
- Line 109, Column 57: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/databases-containers-items' will be broken in isolated environments. Replace with a relative link.
- Line 115, Column 45: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/distribute-data-globally' will be broken in isolated environments. Replace with a relative link.
- Line 120, Column 49: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/set-throughput' will be broken in isolated environments. Replace with a relative link.
- Line 127, Column 39: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/request-units' will be broken in isolated environments. Replace with a relative link.
- Line 134, Column 39: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/partitioning-overview' will be broken in isolated environments. Replace with a relative link.
- Line 240, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/performance-tips-java-sdk-v4-sql?tabs=api-async' will be broken in isolated environments. Replace with a relative link.
- Line 242, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/troubleshoot-java-sdk-v4-sql' will be broken in isolated environments. Replace with a relative link.
- Line 284, Column 14: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/create-sql-api-java?tabs=sync' will be broken in isolated environments. Replace with a relative link.
- Line 285, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/introduction' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.
Note: Your PR may contain errors or warnings 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 docs.microsoft.com contributor guides
- Post your question in the Docs support channel
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.
LGTM, thanks!
Docs Build status updates of commit 6838b8a:
|
File | Status | Preview URL | Details |
---|---|---|---|
docs-ref-services/preview/data-appconfiguration-readme.md | View (azure-java-preview) | Details | |
docs-ref-services/preview/cosmos-readme.md | 💡Suggestion | View (azure-java-preview) | Details |
docs-ref-services/preview/data-appconfiguration-readme.md
- Line 23, Column 3: [Warning: table-syntax-invalid - See documentation]
Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines.
- Line 24, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration' will be broken in isolated environments. Replace with a relative link.
- Line 30, Column 5: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable' will be broken in isolated environments. Replace with a relative link.
- Line 30, Column 5: [Suggestion: preserve-view-not-set - See documentation]
Did you mean to link to a specific version? It's usually better not to specify a version, so the link always goes to the canonical version. If you really need to link to a specific version, add &preserve-view=true to the URL: https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable. Otherwise, remove the view parameter.
- Line 32, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/quickstart-dotnet-core-app#create-an-app-configuration-store' will be broken in isolated environments. Replace with a relative link.
- Line 48, Column 65: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 72, Column 9: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 109, Column 6: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
- Line 138, Column 30: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/rest-api-authorization-azure-ad#roles' will be broken in isolated environments. Replace with a relative link.
- Line 409, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/azure-app-configuration/quickstart-java-spring-app' will be broken in isolated environments. Replace with a relative link.
docs-ref-services/preview/cosmos-readme.md
- Line 16, Column 64: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query' will be broken in isolated environments. Replace with a relative link.
- Line 16, Column 92: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/' will be broken in isolated environments. Replace with a relative link.
- Line 18, Column 115: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/introduction' will be broken in isolated environments. Replace with a relative link.
- Line 71, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/java/azure/jdk/' will be broken in isolated environments. Replace with a relative link.
- Line 72, Column 391: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/local-emulator-export-ssl-certificates' will be broken in isolated environments. Replace with a relative link.
- Line 109, Column 57: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/databases-containers-items' will be broken in isolated environments. Replace with a relative link.
- Line 115, Column 45: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/distribute-data-globally' will be broken in isolated environments. Replace with a relative link.
- Line 120, Column 49: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/set-throughput' will be broken in isolated environments. Replace with a relative link.
- Line 127, Column 39: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/request-units' will be broken in isolated environments. Replace with a relative link.
- Line 134, Column 39: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/partitioning-overview' will be broken in isolated environments. Replace with a relative link.
- Line 240, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/performance-tips-java-sdk-v4-sql?tabs=api-async' will be broken in isolated environments. Replace with a relative link.
- Line 242, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/troubleshoot-java-sdk-v4-sql' will be broken in isolated environments. Replace with a relative link.
- Line 284, Column 14: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/create-sql-api-java?tabs=sync' will be broken in isolated environments. Replace with a relative link.
- Line 285, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://docs.microsoft.com/azure/cosmos-db/introduction' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.
Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.
Note: Your PR may contain errors or warnings 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 docs.microsoft.com contributor guides
- Post your question in the Docs support channel
Are you able to merge this test PR? What's the process for this repo? #sign-off |
@v-andreaco - yes, I can merge this, thanks! |
No description provided.