Skip to content
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

Typo "Typescript"→"TypeScript" #1286

Closed
wants to merge 1 commit into from

Conversation

@opbld30
Copy link

opbld30 commented Aug 27, 2021

Docs Build status updates of commit 54a73d9:

⚠️ Validation status: warnings

File Status Preview URL Details
docs-ref-services/latest/cosmos-readme.md ⚠️Warning View (azure-node-latest) Details

docs-ref-services/latest/cosmos-readme.md

  • Line 2, Column 1: [Warning-ms-prod-and-service] Only one of the following attributes can exist: 'ms.prod', 'ms.service'. Use ms.prod for on-premise products, or ms.service for cloud services.
  • Line 9, Column 16: [Warning-ms-prod-technology-invalid] Invalid value for 'ms.technology': 'azure' is not valid with 'ms.prod' value 'azure'.
  • Line 11, Column 13: [Warning-ms-service-subservice-invalid] Invalid value for 'ms.service': 'cosmosdb'.
  • Line 117, Column 3: [Warning-bookmark-not-found] Cannot find bookmark '#delete-an-data' in 'docs-ref-services/latest/cosmos-readme.md', did you mean '#delete-an-item'?
  • Line 2, Column 1: [Suggestion-description-missing] Missing required attribute: 'description'.
  • Line 5, Column 12: [Suggestion-ms-author-invalid] Invalid value for 'ms.author', 'magpint' is not a valid Microsoft alias.
  • Line 30, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/?view=azure-node-lates' will be broken in isolated environments. Replace with a relative link.
  • Line 30, Column 3: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/?view=azure-node-lates. Otherwise, remove the view parameter.
  • Line 31, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/' will be broken in isolated environments. Replace with a relative link.
  • Line 39, Column 57: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/account-overview' will be broken in isolated environments. Replace with a relative link.
  • Line 55, Column 20: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/how-to-configure-cross-origin-resource-sharing' will be broken in isolated environments. Replace with a relative link.
  • Line 65, Column 231: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/cli/azure' will be broken in isolated environments. Replace with a relative link.
  • Line 74, Column 59: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 74, Column 59: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-latest. Otherwise, remove the view parameter.
  • Line 98, Column 27: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-lates' will be broken in isolated environments. Replace with a relative link.
  • Line 98, Column 27: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-lates. Otherwise, remove the view parameter.
  • Line 100, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/database?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 100, Column 3: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/database?view=azure-node-latest. Otherwise, remove the view parameter.
  • Line 100, Column 317: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/database?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 100, Column 317: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/database?view=azure-node-latest. Otherwise, remove the view parameter.
  • Line 102, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/container?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 102, Column 3: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/container?view=azure-node-latest. Otherwise, remove the view parameter.
  • Line 102, Column 244: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/container?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 102, Column 244: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/container?view=azure-node-latest. Otherwise, remove the view parameter.
  • Line 104, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/item?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 104, Column 3: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/item?view=azure-node-latest. Otherwise, remove the view parameter.
  • Line 106, Column 49: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/databases-containers-items' will be broken in isolated environments. Replace with a relative link.
  • Line 121, Column 27: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 121, Column 27: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-latest. Otherwise, remove the view parameter.
  • Line 139, Column 74: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/items?view=azure-node-latest#upsert-t--requestoptions-' will be broken in isolated environments. Replace with a relative link.
  • Line 139, Column 74: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/items?view=azure-node-latest#upsert-t--requestoptions-. Otherwise, remove the view parameter.
  • Line 156, Column 45: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/item?view=azure-node-latest#read-requestoptions-' will be broken in isolated environments. Replace with a relative link.
  • Line 156, Column 45: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/item?view=azure-node-latest#read-requestoptions-. Otherwise, remove the view parameter.
  • Line 164, Column 39: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/item?view=azure-node-latest#delete-requestoptions-' will be broken in isolated environments. Replace with a relative link.
  • Line 164, Column 39: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/item?view=azure-node-latest#delete-requestoptions-. Otherwise, remove the view parameter.
  • Line 173, Column 78: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-' will be broken in isolated environments. Replace with a relative link.
  • Line 173, Column 78: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-. Otherwise, remove the view parameter.
  • Line 184, Column 98: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-' will be broken in isolated environments. Replace with a relative link.
  • Line 184, Column 98: [Suggestion-preserve-view-not-set] 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/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-. Otherwise, remove the view parameter.
  • Line 198, Column 77: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/how-to-sql-query' will be broken in isolated environments. Replace with a relative link.
  • Line 206, Column 1: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/rest/api/cosmos-db/http-status-codes-for-cosmosdb' will be broken in isolated environments. Replace with a relative link.
  • Line 228, Column 80: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/request-units' will be broken in isolated environments. Replace with a relative link.
  • Line 228, Column 251: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/architecture/patterns/retry' will be broken in isolated environments. Replace with a relative link.
  • Line 228, Column 340: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/architecture/patterns/circuit-breaker' will be broken in isolated environments. Replace with a relative link.
  • Line 247, Column 68: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/' will be broken in isolated environments. Replace with a relative link.
  • Line 251, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/community' will be broken in isolated environments. Replace with a relative link.
  • Line 252, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/sql-api-nodejs-get-started' will be broken in isolated environments. Replace with a relative link.
  • Line 253, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/sql-api-nodejs-application' will be broken in isolated environments. Replace with a relative link.
  • Line 255, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/sql-api-resources' will be broken in isolated environments. Replace with a relative link.
  • Line 256, Column 3: [Suggestion-docs-link-absolute] 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 257, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/azure/cosmos-db/sql-api-partition-data' will be broken in isolated environments. Replace with a relative link.
  • Line 258, Column 3: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/javascript/api/%40azure/cosmos/?view=azure-node-latest' will be broken in isolated environments. Replace with a relative link.
  • Line 258, Column 3: [Suggestion-preserve-view-not-set] 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/javascript/api/%40azure/cosmos/?view=azure-node-latest. Otherwise, remove the view parameter.

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:

@danieljurek
Copy link
Collaborator

@hyoshioka0128, thank you for your contribution and sorry for the delay in response to this PR.

These -readme.md files are automatically synchronized from the Azure SDK source repository when we publish packages and any changes here will be overwritten on a new publish. This means that on the next publish of the cosmos package your changes will be overwritten unless your changes are also proposed to the file in the Azure SDK source repository.

To fix the issue here and ensure it doesn't come back on a subsequent release:

  1. Open a PR to correct this issue in https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/cosmosdb/cosmos/README.md
  2. Comment here with a link to the new PR in azure-sdk-for-js and tag @danieljurek so I can get it approved and merged

Once the PR against azure-sdk-for-js is merged I will approve and merge this one.

Thanks again for your contribution!

hyoshioka0128 added a commit to hyoshioka0128/azure-sdk-for-js that referenced this pull request Oct 1, 2021
@hyoshioka0128
Copy link
Author

@danieljurek - Thank you for your suggestion.
Closed #1286 .

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.

3 participants