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

Broken link in azure-keyvault v1 readme #15796

Closed
ramya-rao-a opened this issue Dec 15, 2020 · 2 comments
Closed

Broken link in azure-keyvault v1 readme #15796

ramya-rao-a opened this issue Dec 15, 2020 · 2 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Docs KeyVault

Comments

@ramya-rao-a
Copy link
Contributor

ramya-rao-a commented Dec 15, 2020

The readme for azure-keyvault v1 is linked from the Key Vault Overview page for Python packages.

This readme has a broken link https://docs.microsoft.com/python/api/overview/azure/key-vault
The problem is in the hypen between the words "key" and "vault", the right url is https://docs.microsoft.com/python/api/overview/azure/keyvault

Our options are

  • Create a redirect link such that the wrong one leads to the right one
  • Or, create a branch from the tag azure-keyvault_1.1.0, fix the link, delete the tag, add the tag to this branch.

Found in #15110
Nice catch @mccoyp!

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Dec 15, 2020
@ramya-rao-a ramya-rao-a added Client This issue points to a problem in the data-plane of the library. Docs KeyVault labels Dec 15, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Dec 15, 2020
@mccoyp
Copy link
Member

mccoyp commented Dec 18, 2020

As mentioned in the pull request meant to resolve this, it turns out that the azure-keyvault_1.1.0 tag containing the README is immutable. Unless we do a release of a version 1.1.1, our remaining option for fixing the link is to create a redirect link.

@mccoyp
Copy link
Member

mccoyp commented Jan 6, 2021

Resolved via MicrosoftDocs/azure-docs-sdk-python#1124.

@mccoyp mccoyp closed this as completed Jan 6, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs KeyVault
Projects
None yet
Development

No branches or pull requests

2 participants