Skip to content

Update doc because the dpg modular has already been set as the default #36698

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update doc because the dpg modular has already been set as the default #36698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion documentation/DPG-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ The `package name` is used when publishing to [npmjs](https://www.npmjs.com/). I
options:
"@azure-tools/typespec-ts":
emitter-output-dir: "{output-dir}/{service-dir}/YOUR_SERVICE_FOLDER"
is-modular-library: true
package-details:
name: YOUR_PACKAGE_NAME
description: "SHORT_DESCRIPTION"
Expand Down
8 changes: 1 addition & 7 deletions documentation/Generate-code-from-TypeSpec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,7 @@ You can reference these two config files to configure the Modular or RLC package
- [Modular tspconfig.yaml](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml)
- [RLC tspconfig.yaml](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml)

Please make sure `service-dir`, `emitter-output-dir`, `package-details`, `flavor`(for typespec-ts) is correctly configured. `experimental-extensible-enums` is the optional config.
For control-plane SDKs, the `is-modular-library` option is true by default, while for data-plane SDKs it is false. To generate Modular libraries for data-plane SDKs, you must add
```
is-modular-library:true
```
in your tspconfig.yaml. `is-modular-library` should be set to true unless you have been explicitly instructed by the Azure SDK Architecture Board to proceed with RLC code generation.

Please make sure `service-dir`, `emitter-output-dir`, `package-details`, `flavor`(for typespec-ts) is correctly configured. `experimental-extensible-enums` is the optional config.The `is-modular-library` option is true by default, if you want to generate RLC libraries for data-plane SDKs, you must add `is-modular-library: false` in your tspconfig.yaml.

- "parameters.service-dir.default" would be `sdk/<service>`
- "options.@azure-tools/typespec-ts.emitter-output-dir" would be `{output-dir}/{service-dir}/<module>`
Expand Down
1 change: 1 addition & 0 deletions documentation/RLC-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ The `package name` is used when publishing to [npmjs](https://www.npmjs.com/). I
options:
"@azure-tools/typespec-ts":
emitter-output-dir: "{output-dir}/{service-dir}/YOUR_SERVICE_FOLDER-rest"
is-modular-library: false
package-details:
name: YOUR_PACKAGE_NAME
description: "SHORT_DESCRIPTION"
Expand Down