Skip to content

Conversation

mccoyp
Copy link
Contributor

@mccoyp mccoyp commented Mar 14, 2023

Resolves Azure/azure-sdk-for-python#25778. Until now, azure-keyvault-administration has been missing from the overview page for Key Vault. Also, links to the GitHub pages of each package have been using the old name (master) instead of main.

GitHub automatically switched line endings to be consistent throughout the file, which is why the proposed changes seem more significant than they are.

@mccoyp mccoyp requested a review from danieljurek March 14, 2023 20:57
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 8a102bd:

⚠️ Validation status: warnings

File Status Preview URL Details
docs-ref-services/latest/key-vault.md ⚠️Warning View (azure-python) Details

docs-ref-services/latest/key-vault.md

  • Line 2, Column 1: [Warning: ms-date-missing - See documentation] Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
  • Line 9, Column 13: [Warning: ms-service-subservice-invalid - See documentation] Invalid value for 'ms.service': 'keyvault'.
  • Line 29, Column 43: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-administration-readme'.
  • Line 30, Column 41: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-certificates-readme'.
  • Line 31, Column 34: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-keys-readme'.
  • Line 32, Column 37: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-secrets-readme'.
  • Line 13, Column 163: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/key-vault/general/overview' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: link-broken - See documentation] Link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 42, Column 28: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous

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 Learn Build.

Note: Links can become broken if there are changes on the target sites.

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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 5bd0db6:

⚠️ Validation status: warnings

File Status Preview URL Details
docs-ref-services/latest/key-vault.md ⚠️Warning View (azure-python) Details

docs-ref-services/latest/key-vault.md

  • Line 2, Column 1: [Warning: ms-date-missing - See documentation] Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
  • Line 9, Column 13: [Warning: ms-service-subservice-invalid - See documentation] Invalid value for 'ms.service': 'keyvault'.
  • Line 29, Column 43: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-administration-readme'.
  • Line 30, Column 41: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-certificates-readme'.
  • Line 31, Column 34: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-keys-readme'.
  • Line 32, Column 37: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-secrets-readme'.
  • Line 13, Column 163: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/key-vault/general/overview' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: link-broken - See documentation] Link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 42, Column 28: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous

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 Learn Build.

Note: Links can become broken if there are changes on the target sites.

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:

Copy link
Collaborator

@danieljurek danieljurek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also update docs-ref-services/preview/key-vault.md @mccoyp

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit de029f9:

⚠️ Validation status: warnings

File Status Preview URL Details
docs-ref-services/latest/key-vault.md ⚠️Warning View (azure-python) Details
docs-ref-services/preview/key-vault.md ⚠️Warning View (azure-python-preview) Details

docs-ref-services/latest/key-vault.md

  • Line 2, Column 1: [Warning: ms-date-missing - See documentation] Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
  • Line 9, Column 13: [Warning: ms-service-subservice-invalid - See documentation] Invalid value for 'ms.service': 'keyvault'.
  • Line 29, Column 43: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-administration-readme'.
  • Line 30, Column 41: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-certificates-readme'.
  • Line 31, Column 34: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-keys-readme'.
  • Line 32, Column 37: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-secrets-readme'.
  • Line 13, Column 163: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/key-vault/general/overview' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: link-broken - See documentation] Link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 42, Column 28: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous

docs-ref-services/preview/key-vault.md

  • Line 2, Column 1: [Warning: ms-date-missing - See documentation] Missing required attribute: 'ms.date'. A freshness date is required for this content set. Add a date in format MM/DD/YYYY.
  • Line 9, Column 13: [Warning: ms-service-subservice-invalid - See documentation] Invalid value for 'ms.service': 'keyvault'.
  • Line 29, Column 43: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-administration-readme'.
  • Line 30, Column 41: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-certificates-readme'.
  • Line 31, Column 34: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-keys-readme'.
  • Line 32, Column 37: [Warning: file-not-found - See documentation] Invalid file link: 'keyvault-secrets-readme'.
  • Line 13, Column 163: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/azure/key-vault/general/overview' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: link-broken - See documentation] Link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 42, Column 28: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous' will be broken in isolated environments. Replace with a relative link.
  • Line 42, Column 28: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: https://docs.microsoft.com/python/api/overview/azure/keyvault?view=azure-python-previous

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 Learn Build.

Note: Links can become broken if there are changes on the target sites.

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:

@mccoyp mccoyp requested a review from danieljurek March 14, 2023 23:50
@danieljurek danieljurek merged commit dca58f6 into main Mar 15, 2023
@danieljurek danieljurek deleted the kv-overview-fix branch March 15, 2023 15:31
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.

Add azure-keyvault-administration to overview article for KV

2 participants