Skip to content

Commit

Permalink
Use learn.microsoft.com in generated packages (#2977)
Browse files Browse the repository at this point in the history
* Use `learn.microsoft.com` in generated packages

instead of `docs.microsoft.com`

* update test baselines

* update unit tests

---------

Co-authored-by: Jeremy Meng <jeremy.ymeng@gmail.com.com>
  • Loading branch information
jeremymeng and Jeremy Meng authored Jan 6, 2025
1 parent c5d2704 commit bc4b982
Show file tree
Hide file tree
Showing 31 changed files with 47 additions and 47 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to {{ serviceName}}** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

{{#if azureArm}}
```javascript
Expand Down Expand Up @@ -146,7 +146,7 @@ If you'd like to contribute to this library, please read the [contributing guide
{{#if impressionURL}}![Impressions]({{ impressionURL }})
{{/if}}

[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ function regularAutorestPackage(
productName: description,
productSlugs: ["azure"],
disableDocsMs: true,
apiRefLink: `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
apiRefLink: `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
};
}
return packageInfo;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ function createMetadata(
clientDescriptiveName: `${serviceName} client`,
description: codeModel.info?.description,
apiRefURL: azureHuh
? `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
? `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
: undefined,
packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
contributingGuideURL: repoURL && `${repoURL}/blob/main/CONTRIBUTING.md`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,6 @@
"productName": "@msinternal/dpg-customization-rest",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/dpg-customization-rest"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/dpg-customization-rest"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/arm-package-subscriptions-2019-06?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/arm-package-subscriptions-2019-06?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/compute-resource-manager?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/compute-resource-manager?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/keyvault-resource-manager?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/keyvault-resource-manager?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/msi-resource-manager?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/msi-resource-manager?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/network-resource-manager?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/network-resource-manager?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/sql-resource-manager?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/sql-resource-manager?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/storage-resource-manager?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/storage-resource-manager?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,6 @@
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@msinternal/web-resource-manager?view=azure-node-preview"
"apiRefLink": "https://learn.microsoft.com/javascript/api/@msinternal/web-resource-manager?view=azure-node-preview"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Azure Kusto management API provides a RESTful set of web services that inter

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/kusto/arm-kusto) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-kusto) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-kusto?view=azure-node-preview) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-kusto?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
Expand Down Expand Up @@ -45,7 +45,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to Azure KustoManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { KustoManagementClient } = require("@azure/arm-kusto");
Expand Down Expand Up @@ -99,7 +99,7 @@ If you'd like to contribute to this library, please read the [contributing guide

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fkusto%2Farm-kusto%2FREADME.png)

[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Azure Kusto management API provides a RESTful set of web services that inter

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/kusto/arm-kusto) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-kusto) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-kusto?view=azure-node-preview) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-kusto?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
Expand Down Expand Up @@ -45,7 +45,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to Azure KustoManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { KustoManagementClient } = require("@azure/arm-kusto");
Expand Down Expand Up @@ -100,7 +100,7 @@ If you'd like to contribute to this library, please read the [contributing guide

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fkusto%2Farm-kusto%2FREADME.png)

[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/agrifood/agrifood-farming-rest)
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/agrifood-farming)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/agrifood-farming?view=azure-node-preview)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/agrifood-farming?view=azure-node-preview)
- [Product documentation](https://azure.microsoft.com/en-us/services/purview/)

## Getting started
Expand All @@ -19,7 +19,7 @@ Key links:

### Prerequisites

- You must have an [Azure subscription](https://azure.microsoft.com/free/) and follow [these](https://docs.microsoft.com/en-us/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role) instructions to use this package.
- You must have an [Azure subscription](https://azure.microsoft.com/free/) and follow [these](https://learn.microsoft.com/en-us/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role) instructions to use this package.

### Install the `@azure-rest/agrifood-farming` package

Expand All @@ -36,7 +36,7 @@ provide an instance of the desired credential type obtained from the
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.

To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) and
[enable AAD authentication on your Purview resource](https://docs.microsoft.com/en-us/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role)
[enable AAD authentication on your Purview resource](https://learn.microsoft.com/en-us/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role)

After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ describe("generateReadmeFile", () => {
productDocLink: "https://azure.microsoft.com/en-us/services/purview/",
dependencyInfo: {
link:
"https://docs.microsoft.com/en-us/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role",
"https://learn.microsoft.com/en-us/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role",
description: "enable AAD authentication on your Purview resource"
}
} as autorestSession.AutorestOptions;
Expand Down
4 changes: 2 additions & 2 deletions packages/rlc-common/src/metadata/buildReadmeFile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ npm install @azure/identity
You will also need to **register a new AAD application and grant access to {{ serviceName}}** by assigning the suitable role to your service principal (note: roles such as \`"Owner"\` will not grant the necessary permissions).
For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
{{#if azureArm}}
\`\`\`javascript
Expand Down Expand Up @@ -381,7 +381,7 @@ function createMetadata(model: RLCModel): Metadata | undefined {
? `${packageSourceURL}/samples`
: undefined,
apiRefURL: azureHuh
? `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
? `https://learn.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
: undefined,
dependencyDescription: dependencyInfo?.description,
dependencyLink: dependencyInfo?.link,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ function getSampleMetadata({
productName: name,
productSlugs: ["azure"],
disableDocsMs: true,
apiRefLink: `https://docs.microsoft.com/javascript/api/${name}${apiRefUrlQueryParameter}`
apiRefLink: `https://learn.microsoft.com/javascript/api/${name}${apiRefUrlQueryParameter}`
}
};
}
Expand Down
4 changes: 2 additions & 2 deletions packages/rlc-common/test/integration/packageJson.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ describe("Package file generation", () => {
productName: `${libraryName}`,
productSlugs: ["azure"],
disableDocsMs: true,
apiRefLink: `https://docs.microsoft.com/javascript/api/${libraryName}`
apiRefLink: `https://learn.microsoft.com/javascript/api/${libraryName}`
};

expect(packageFile).to.have.property("//sampleConfiguration");
Expand All @@ -200,7 +200,7 @@ describe("Package file generation", () => {
productName: `${libraryName}`,
productSlugs: ["azure"],
disableDocsMs: true,
apiRefLink: `https://docs.microsoft.com/javascript/api/${libraryName}?view=azure-node-preview`
apiRefLink: `https://learn.microsoft.com/javascript/api/${libraryName}?view=azure-node-preview`
};

expect(packageFile).to.have.property("//sampleConfiguration");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/test/arm-test)
- [Package (NPM)](https://www.npmjs.com/package/@azure/arm-networkanalytics)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-networkanalytics?view=azure-node-preview)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-networkanalytics?view=azure-node-preview)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/test/arm-test/samples)

## Getting started
Expand Down Expand Up @@ -47,7 +47,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to Azure NetworkAnalytics** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { NetworkAnalyticsClient } = require("@azure/arm-networkanalytics");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f
Key links:

- [Package (NPM)](https://www.npmjs.com/package/@azure/ai-client)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/ai-client?view=azure-node-preview)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/ai-client?view=azure-node-preview)

## Getting started

Expand Down Expand Up @@ -45,7 +45,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to Azure Client** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { ClientClient } = require("@azure/ai-client");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Azure Batch provides Cloud-scale job scheduling and compute management.
Key links:

- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/batch)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/batch?view=azure-node-preview)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/batch?view=azure-node-preview)

## Getting started

Expand Down Expand Up @@ -45,7 +45,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to Azure Batch** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { BatchClient } = require("@azure-rest/batch");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Azure APIs for the Azure Chat protocol.
Key links:

- [Package (NPM)](https://www.npmjs.com/package/@azure/ai-chat-protocol)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/ai-chat-protocol?view=azure-node-preview)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/ai-chat-protocol?view=azure-node-preview)

## Getting started

Expand Down Expand Up @@ -45,7 +45,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to Azure ChatProtocol** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { ChatProtocolClient } = require("@azure/ai-chat-protocol");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Analyze harmful content
Key links:

- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/ai-content-safety)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/ai-content-safety)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/ai-content-safety)

## Getting started

Expand Down Expand Up @@ -45,7 +45,7 @@ npm install @azure/identity

You will also need to **register a new AAD application and grant access to Azure ContentSafety** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { ContentSafetyClient } = require("@azure-rest/ai-content-safety");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Contoso WidgetManager Service
Key links:

- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/contosowidgetmanager-rest)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/contosowidgetmanager-rest?view=azure-node-preview)
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/contosowidgetmanager-rest?view=azure-node-preview)

## Getting started

Expand Down
Loading

0 comments on commit bc4b982

Please sign in to comment.