Skip to content

Commit 1dd3202

Browse files
authored
Fix broken links (Azure#20314)
1 parent c5e6841 commit 1dd3202

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

documentation/RLC-quickstart.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ You may refer to this [link](https://github.com/Azure/azure-sdk-for-js/blob/main
1010
Before we start, we probably should get to know the project folder and name convention for RLC libraries.
1111

1212
1. Project Folder structure.
13-
normally, the folder structure would be something like `sdk/{servicename}/{servicename}-{modulename}-rest`. For example, we have `sdk/purview/purview-account-rest` folder for purview account modules. That folder will be your **${PROJECT_ROOT} folder**.
13+
normally, the folder structure would be something like `sdk/{servicename}/{servicename}-{modulename}-rest`. For example, we have `sdk/agrifood/agrifood-farming-rest` folder for Farmbeats account modules. That folder will be your **${PROJECT_ROOT} folder**.
1414
1. Package Name Convention.
15-
The package name for RLC is something like `@azure-rest/{servicename}-{modulename}`. For example, the package name for Purview Account module is `@azure-rest/purview-account`.
15+
The package name for RLC is something like `@azure-rest/{servicename}-{modulename}`. For example, the package name for Farmbeats module is `@azure-rest/agrifood-farming`.
1616

1717
# How to generate RLC
1818

@@ -24,24 +24,24 @@ We are working on to automatically generate everything right now, but currently
2424

2525
~~~
2626
27-
# Azure Purview Catalog TypeScript Protocol Layer
27+
# Azure Farmbeats TypeScript Protocol Layer
2828
2929
> see https://aka.ms/autorest
3030
## Configuration
3131
3232
```yaml
33-
package-name: "@azure-rest/purview-account"
34-
title: PurviewAccount
35-
description: Purview Account Client
33+
package-name: "@azure-rest/agrifood-farming"
34+
title: Farmbeats
35+
description: Farmbeats Client
3636
generate-metadata: true
3737
license-header: MICROSOFT_MIT_NO_VERSION
3838
output-folder: ../
3939
source-code-folder-path: ./src
40-
input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json
41-
package-version: 1.0.0-beta.1
40+
input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/683e3f4849ee1d84629d0d0fa17789e80a9cee08/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json
41+
package-version: 1.0.0-beta.2
4242
rest-level-client: true
4343
add-credentials: true
44-
credential-scopes: "https://purview.azure.net/.default"
44+
credential-scopes: https://farmbeats.azure.net/.default
4545
use-extension:
4646
"@autorest/typescript": "6.0.0-beta.14"
4747
```
@@ -63,8 +63,8 @@ We are working on to automatically generate everything right now, but currently
6363
6464
```
6565
{
66-
"packageName": "@azure-rest/purview-account",
67-
"projectFolder": "sdk/purview/purview-account-rest",
66+
"packageName": "@azure-rest/agrifood-farming",
67+
"projectFolder": "sdk/agrifood/agrifood-farming-rest",
6868
"versionPolicyName": "client"
6969
},
7070
```
@@ -386,11 +386,11 @@ In order to release it, we need to add some tests for it to make sure we are del
386386
```
387387
1. **add test utils.**
388388
389-
create a `${PROJECT_ROOT}/test/public` folder and then copy the content [here](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-account-rest/test/public/utils) into public folder
389+
create a `${PROJECT_ROOT}/test/public` folder and then copy the content [here](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/agrifood/agrifood-farming-rest/test/public/utils) into public folder
390390
391391
there are some manual changes in the copied recordedClient.ts that need to be done.
392392
```typescript
393-
import PurviewAccount, { PurviewAccountRestClient } from "../../../src";
393+
import Farmbeats, { FarmbeatsRestClient } from "../../../src";
394394
```
395395
Needs to change to the value that was used in the swagger/readme.md in title. For example if title is "Foo"
396396
```typescript
@@ -404,7 +404,7 @@ In order to release it, we need to add some tests for it to make sure we are del
404404
env.AZURE_CLIENT_ID,
405405
env.AZURE_CLIENT_SECRET
406406
);
407-
return PurviewAccount(env.ENDPOINT, credential, options);
407+
return Farmbeats(env.ENDPOINT, credential, options);
408408
}
409409
```
410410
Needs to change to
@@ -543,8 +543,8 @@ extends:
543543
parameters:
544544
ServiceDirectory: purview
545545
Artifacts:
546-
- name: azure-rest-purview-account
547-
safeName: azurerestpurviewaccount
546+
- name: azure-rest-agrifood-farming
547+
safeName: azurerestagrifoodfarming
548548
```
549549
550550
Please change the paths.include value as your own project path, and change the Artifacts name and safeName into yours.

sdk/purview/purview-administration-rest/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Key links:
2727

2828
Follow [these][purview_resource] instructions to create your Purview resource
2929

30-
### Install the `@azure-rest/purview-account` package
30+
### Install the `@azure-rest/purview-administration` package
3131

32-
Install the Azure Purview Account client library for JavaScript with `npm`:
32+
Install the Azure Purview Administration client library for JavaScript with `npm`:
3333

3434
```bash
35-
npm install @azure-rest/purview-account
35+
npm install @azure-rest/purview-administration
3636
```
3737

3838
### Create and authenticate a `PurviewAccount`

0 commit comments

Comments
 (0)