From f558cff1ab6f862a74b668abef89c36e53b980f0 Mon Sep 17 00:00:00 2001 From: Ramya Rao Date: Mon, 21 Dec 2020 15:33:50 -0800 Subject: [PATCH] Use npm link instead of github for readme (#12982) This PR updates the migration guides for Key Vault to use npm link instead of github as the latter can point to previews if we were working on previews in the master branch --- sdk/keyvault/keyvault-certificates/migration-guide.md | 9 +++------ sdk/keyvault/keyvault-keys/migration-guide.md | 9 +++------ sdk/keyvault/keyvault-secrets/migration-guide.md | 9 +++------ 3 files changed, 9 insertions(+), 18 deletions(-) diff --git a/sdk/keyvault/keyvault-certificates/migration-guide.md b/sdk/keyvault/keyvault-certificates/migration-guide.md index 9971f4e97235..4e1e4321c3dc 100644 --- a/sdk/keyvault/keyvault-certificates/migration-guide.md +++ b/sdk/keyvault/keyvault-certificates/migration-guide.md @@ -2,7 +2,7 @@ This guide is intended to assist in the migration to `@azure/keyvault-certificates` from `azure-keyvault`. It will focus on side-by-side comparisons for similar operations between the two packages. -Familiarity with the `azure-keyvault` package is assumed. For those new to the Key Vault client libraries for JavaScript, please refer to the [README for @azure/keyvault-certificates][kvc-readme] rather than this guide. +Familiarity with the `azure-keyvault` package is assumed. For those new to the Key Vault client libraries for JavaScript, please refer to the [README for @azure/keyvault-certificates][kvc-npm] rather than this guide. ## Table of contents @@ -73,7 +73,7 @@ async function main() { main().catch((err) => console.error(err)); ``` -Now in `@azure/keyvault-certificates` you can create a `CertificateClient` using any credential from [`@azure/identity`][identity-readme]. +Now in `@azure/keyvault-certificates` you can create a `CertificateClient` using any credential from [`@azure/identity`][identity-npm]. You can install them by simply running the following command at the root of your project: @@ -212,12 +212,9 @@ await client.purgeDeletedCertificate(deletedCertificate.name); * [Key Vault Certificates samples for TypeScript](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-certificates/samples/typescript) * [General Key Vault samples for TypeScript](https://docs.microsoft.com/samples/browse/?products=azure-key-vault&languages=typescript) -[kvk-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/README.md -[kvs-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/README.md -[kvc-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/README.md [kvk-npm]: https://www.npmjs.com/package/@azure/keyvault-keys [kvs-npm]: https://www.npmjs.com/package/@azure/keyvault-secrets [kvc-npm]: https://www.npmjs.com/package/@azure/keyvault-certificates [ts-guidelines]: https://azure.github.io/azure-sdk/typescript_introduction.html -[identity-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md +[identity-npm]: https://www.npmjs.com/package/@azure/identity [identity-readme-DAC]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md#defaultazurecredential diff --git a/sdk/keyvault/keyvault-keys/migration-guide.md b/sdk/keyvault/keyvault-keys/migration-guide.md index 42a6f2a63c81..158ea12fb093 100644 --- a/sdk/keyvault/keyvault-keys/migration-guide.md +++ b/sdk/keyvault/keyvault-keys/migration-guide.md @@ -2,7 +2,7 @@ This guide is intended to assist in the migration to `@azure/keyvault-keys` from `azure-keyvault`. It will focus on side-by-side comparisons for similar operations between the two packages. -Familiarity with the `azure-keyvault` package is assumed. For those new to the Key Vault client libraries for JavaScript, please refer to the [README for @azure/keyvault-keys][kvk-readme] rather than this guide. +Familiarity with the `azure-keyvault` package is assumed. For those new to the Key Vault client libraries for JavaScript, please refer to the [README for @azure/keyvault-keys][kvk-npm] rather than this guide. ## Table of contents @@ -75,7 +75,7 @@ async function main() { main().catch((err) => console.error(err)); ``` -Now in `@azure/keyvault-keys` you can create a `KeyClient` using any credential from [`@azure/identity`][identity-readme]. +Now in `@azure/keyvault-keys` you can create a `KeyClient` using any credential from [`@azure/identity`][identity-npm]. You can install them by simply running the following command at the root of your project: @@ -250,12 +250,9 @@ console.log(operationResult.result); * [Key Vault keys samples for TypeScript](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys/samples/typescript) * [General Key Vault samples for TypeScript](https://docs.microsoft.com/samples/browse/?products=azure-key-vault&languages=typescript) -[kvk-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/README.md -[kvs-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/README.md -[kvc-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/README.md [kvk-npm]: https://www.npmjs.com/package/@azure/keyvault-keys [kvs-npm]: https://www.npmjs.com/package/@azure/keyvault-secrets [kvc-npm]: https://www.npmjs.com/package/@azure/keyvault-certificates [ts-guidelines]: https://azure.github.io/azure-sdk/typescript_introduction.html -[identity-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md +[identity-npm]: https://www.npmjs.com/package/@azure/identity [identity-readme-DAC]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md#defaultazurecredential diff --git a/sdk/keyvault/keyvault-secrets/migration-guide.md b/sdk/keyvault/keyvault-secrets/migration-guide.md index a013df435916..af43701063cf 100644 --- a/sdk/keyvault/keyvault-secrets/migration-guide.md +++ b/sdk/keyvault/keyvault-secrets/migration-guide.md @@ -2,7 +2,7 @@ This guide is intended to assist in the migration to `@azure/keyvault-secrets` from `azure-keyvault`. It will focus on side-by-side comparisons for similar operations between the two packages. -Familiarity with the `azure-keyvault` package is assumed. For those new to the Key Vault client libraries for JavaScript, please refer to the [README for @azure/keyvault-secrets][kvs-readme] rather than this guide. +Familiarity with the `azure-keyvault` package is assumed. For those new to the Key Vault client libraries for JavaScript, please refer to the [README for @azure/keyvault-secrets][kvs-npm] rather than this guide. ## Table of contents @@ -73,7 +73,7 @@ async function main() { main().catch((err) => console.error(err)); ``` -Now in `@azure/keyvault-secrets` you can create a `SecretClient` using any credential from [`@azure/identity`][identity-readme]. +Now in `@azure/keyvault-secrets` you can create a `SecretClient` using any credential from [`@azure/identity`][identity-npm]. You can install them by simply running the following command at the root of your project: @@ -193,12 +193,9 @@ await client.purgeDeletedSecret(deletedSecret.name); * [Key Vault Secrets samples for TypeScript](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets/samples/typescript) * [General Key Vault samples for TypeScript](https://docs.microsoft.com/samples/browse/?products=azure-key-vault&languages=typescript) -[kvk-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/README.md -[kvs-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/README.md -[kvc-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/README.md [kvk-npm]: https://www.npmjs.com/package/@azure/keyvault-keys [kvs-npm]: https://www.npmjs.com/package/@azure/keyvault-secrets [kvc-npm]: https://www.npmjs.com/package/@azure/keyvault-certificates [ts-guidelines]: https://azure.github.io/azure-sdk/typescript_introduction.html -[identity-readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md +[identity-npm]: https://www.npmjs.com/package/@azure/identity [identity-readme-DAC]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md#defaultazurecredential