From c98a274f9ddd8fa5167694b747b22729ac9daf23 Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Mon, 5 Aug 2024 18:02:42 -0700 Subject: [PATCH 1/4] rename to client generation --- .../00howtogen.mdx | 10 +++++----- .../01setup.mdx | 4 ++-- .../02client.mdx | 0 .../03convenient.mdx | 0 .../04renaming.mdx | 0 .../05union.mdx | 0 .../06types.mdx | 0 .../07tcgcTypes.mdx | 0 .../08methodInputs.mdx | 0 .../09versioning.mdx | 0 10 files changed, 7 insertions(+), 7 deletions(-) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/00howtogen.mdx (86%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/01setup.mdx (86%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/02client.mdx (100%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/03convenient.mdx (100%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/04renaming.mdx (100%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/05union.mdx (100%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/06types.mdx (100%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/07tcgcTypes.mdx (100%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/08methodInputs.mdx (100%) rename docs/howtos/{DataPlane Generation - DPG => Client Generation}/09versioning.mdx (100%) diff --git a/docs/howtos/DataPlane Generation - DPG/00howtogen.mdx b/docs/howtos/Client Generation/00howtogen.mdx similarity index 86% rename from docs/howtos/DataPlane Generation - DPG/00howtogen.mdx rename to docs/howtos/Client Generation/00howtogen.mdx index 9871d15309..59faa67f90 100644 --- a/docs/howtos/DataPlane Generation - DPG/00howtogen.mdx +++ b/docs/howtos/Client Generation/00howtogen.mdx @@ -1,9 +1,9 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# How to generate DPG +# How to generate client libraries -This page documents how to build a Data-Plane SDK from your TYPESPEC specification. For an overview of the whole process from initial API design to shipping SDKs, please visit https://aka.ms/azsdk/dpcodegen. +This page documents how to build a client library from your TYPESPEC specification. For an overview of the whole process from initial API design to shipping SDKs, please visit https://aka.ms/azsdk/dpcodegen. The best documentation on how to generate can found using those links: @@ -15,11 +15,11 @@ The best documentation on how to generate can found using those links: At a glance, add your emitter name to your `package.json`, along with the right options in the `tspconfig.yaml`. -> **NOTE:** It may be complicated to generate all languages from the same folder at the moment as DPG and `typespec-azure-core` are still in preview. -> It's recommended that you keep each `package.json` with a unique language emitter, as they are likely to conflict, until all emitters and `typespec-azure-core` +> **NOTE:** It may be complicated to generate all languages from the same folder at the moment as the emitters and TypeSpec libraries, such as `typespec-azure-core` and `typespec-resource-manager` are still in preview. +> It's recommended that you keep each `package.json` with a unique language emitter, as they are likely to conflict, until all emitters and the TypeSpec libraries > reach their first stable release. -Update your `package.json` to contain dependencies on DPG language emitter(s). Don't forget to do `npm install` after an update of the file: +Update your `package.json` to contain dependencies on the language emitter(s). Don't forget to do `npm install` after an update of the file: ```json { diff --git a/docs/howtos/DataPlane Generation - DPG/01setup.mdx b/docs/howtos/Client Generation/01setup.mdx similarity index 86% rename from docs/howtos/DataPlane Generation - DPG/01setup.mdx rename to docs/howtos/Client Generation/01setup.mdx index 7ecb427959..9f12de1353 100644 --- a/docs/howtos/DataPlane Generation - DPG/01setup.mdx +++ b/docs/howtos/Client Generation/01setup.mdx @@ -3,9 +3,9 @@ import TabItem from "@theme/TabItem"; # Setup for SDK customization -This page explains how to setup customization of DPG generator if necessary. +This page explains how to setup customization of a generator if necessary. -Your `package.json` needs to contains a link to the customization library for dpg, called `typespec-client-generator-core`: +Your `package.json` needs to contains a link to the customization library, `typespec-client-generator-core`: ```json { diff --git a/docs/howtos/DataPlane Generation - DPG/02client.mdx b/docs/howtos/Client Generation/02client.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/02client.mdx rename to docs/howtos/Client Generation/02client.mdx diff --git a/docs/howtos/DataPlane Generation - DPG/03convenient.mdx b/docs/howtos/Client Generation/03convenient.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/03convenient.mdx rename to docs/howtos/Client Generation/03convenient.mdx diff --git a/docs/howtos/DataPlane Generation - DPG/04renaming.mdx b/docs/howtos/Client Generation/04renaming.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/04renaming.mdx rename to docs/howtos/Client Generation/04renaming.mdx diff --git a/docs/howtos/DataPlane Generation - DPG/05union.mdx b/docs/howtos/Client Generation/05union.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/05union.mdx rename to docs/howtos/Client Generation/05union.mdx diff --git a/docs/howtos/DataPlane Generation - DPG/06types.mdx b/docs/howtos/Client Generation/06types.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/06types.mdx rename to docs/howtos/Client Generation/06types.mdx diff --git a/docs/howtos/DataPlane Generation - DPG/07tcgcTypes.mdx b/docs/howtos/Client Generation/07tcgcTypes.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/07tcgcTypes.mdx rename to docs/howtos/Client Generation/07tcgcTypes.mdx diff --git a/docs/howtos/DataPlane Generation - DPG/08methodInputs.mdx b/docs/howtos/Client Generation/08methodInputs.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/08methodInputs.mdx rename to docs/howtos/Client Generation/08methodInputs.mdx diff --git a/docs/howtos/DataPlane Generation - DPG/09versioning.mdx b/docs/howtos/Client Generation/09versioning.mdx similarity index 100% rename from docs/howtos/DataPlane Generation - DPG/09versioning.mdx rename to docs/howtos/Client Generation/09versioning.mdx From a0dcfa0955906a43d87f2debe83470be8e621388 Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Mon, 5 Aug 2024 18:21:15 -0700 Subject: [PATCH 2/4] use generic wording --- docs/howtos/Client Generation/02client.mdx | 4 ++-- docs/howtos/Client Generation/03convenient.mdx | 4 ++-- docs/howtos/Client Generation/04renaming.mdx | 4 ++-- docs/howtos/Client Generation/05union.mdx | 2 +- docs/howtos/Client Generation/06types.mdx | 10 +++++----- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/howtos/Client Generation/02client.mdx b/docs/howtos/Client Generation/02client.mdx index 86e16e5db8..ba2449af6e 100644 --- a/docs/howtos/Client Generation/02client.mdx +++ b/docs/howtos/Client Generation/02client.mdx @@ -3,7 +3,7 @@ import TabItem from "@theme/TabItem"; # Client hierarchy -This page documents the default client hierarchy behavior as well as how to customize clients in DPG. For an overview of the setup, please visit the previous page. +This page documents the default client hierarchy behavior as well as how to customize clients. For an overview of the setup, please visit the previous page. JS RLC is not in the business of customization. it will ignore client.tsp and the follow scenarios will not have impact on the JS RLC user experiences. In this context, TypeScript part means JS DPG. @@ -288,7 +288,7 @@ For this section, we will assume that you have service called `PetStore` in the ### Renaming the single client -This can be achieved with the augment operator and the DPG package +This can be achieved with the augment operator and the emitter package diff --git a/docs/howtos/Client Generation/03convenient.mdx b/docs/howtos/Client Generation/03convenient.mdx index 0b377a8de7..b458141bc4 100644 --- a/docs/howtos/Client Generation/03convenient.mdx +++ b/docs/howtos/Client Generation/03convenient.mdx @@ -3,7 +3,7 @@ import TabItem from "@theme/TabItem"; # Convenient method generation -This page documents how to customize method generations in DPG. For an overview of the setup, please visit the setup page. +This page documents how to customize method generation for the emitters. For an overview of the setup, please visit the setup page. ## Default behaviors @@ -114,7 +114,7 @@ For fine tuning, the set of decorators `@protocolAPI` and `@convenientAPI` can b ### Shifting the generation of protocol and convenience on and off -This can be achieved with the augment operator and the DPG package +This can be achieved with the augment operator and the emitter package diff --git a/docs/howtos/Client Generation/04renaming.mdx b/docs/howtos/Client Generation/04renaming.mdx index 4a51d7a941..2f23bb6b89 100644 --- a/docs/howtos/Client Generation/04renaming.mdx +++ b/docs/howtos/Client Generation/04renaming.mdx @@ -3,7 +3,7 @@ import TabItem from "@theme/TabItem"; # Client renaming -This page documents how to customize names for client generations in DPG. For an overview of the setup, please visit the setup page. +This page documents how to customize names for client generation. For an overview of the setup, please visit the setup page. :::note The TypeSpec compiler provides an `@encodedName` decorator that allows changing the name of the property for a given serialization format. @@ -114,7 +114,7 @@ Renames in the context of models can be done on the model name and the attribute Language target takes priority over `client` target. -> **NOTE:** As model name do not get serialized as JSON, sometimes the best choice is to rename the main TYPESPEC for clarity. Talk to your DPG contact is you're unsure +> **NOTE:** As model name do not get serialized as JSON, sometimes the best choice is to rename the main TYPESPEC for clarity. Talk to your emitter contact is you're unsure > if you should rename the model in the main TYPESPEC or customize it. diff --git a/docs/howtos/Client Generation/05union.mdx b/docs/howtos/Client Generation/05union.mdx index 29dff03355..ab99be2a0c 100644 --- a/docs/howtos/Client Generation/05union.mdx +++ b/docs/howtos/Client Generation/05union.mdx @@ -3,7 +3,7 @@ import TabItem from "@theme/TabItem"; # One path for multiple input/output -This page documents DPG behavior and customization when you use union operator `|` or `@sharedRoute` to express multiple input/output for a given path. +This page documents emitter behavior and customization when you use union operator `|` or `@sharedRoute` to express multiple input/output for a given path. ## Default behaviors diff --git a/docs/howtos/Client Generation/06types.mdx b/docs/howtos/Client Generation/06types.mdx index 9fdced5ecd..c87e35050a 100644 --- a/docs/howtos/Client Generation/06types.mdx +++ b/docs/howtos/Client Generation/06types.mdx @@ -162,7 +162,7 @@ public partial class Foo : IUtf8JsonSerializable, IJsonModel -In Java, `@flattenProperty` have no effect on data-plane libraries. +In Java, `@flattenProperty` have no effect on generated libraries. ```java @Fluent @@ -247,7 +247,7 @@ model Animal is Record { -Python DPG model is original designed to support adding any additional properties. +Python models are designed to support adding any additional properties. ```python from .. import _model_base @@ -396,7 +396,7 @@ model Animal { -Python DPG model is original designed to support adding any additional properties. +Python models are designed to support adding any additional properties. ```python from typing import Any @@ -606,7 +606,7 @@ model Animal { -Python DPG model is original designed to support adding any additional properties. +Python models are designed to support adding any additional properties. ```python from .. import _model_base @@ -726,7 +726,7 @@ model Animal { -Python DPG model is original designed to support adding any additional properties. +Python models are designed to support adding any additional properties. ```python from .. import _model_base From 0ed4228fecd6202171ab4c3ee4e2c76901eb9ccb Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Mon, 12 Aug 2024 15:05:10 -0700 Subject: [PATCH 3/4] update js emitter wording --- docs/howtos/Client Generation/02client.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howtos/Client Generation/02client.mdx b/docs/howtos/Client Generation/02client.mdx index 9ee6beac24..1d523bceba 100644 --- a/docs/howtos/Client Generation/02client.mdx +++ b/docs/howtos/Client Generation/02client.mdx @@ -5,7 +5,7 @@ import TabItem from "@theme/TabItem"; This page documents the default client hierarchy behavior as well as how to customize clients. For an overview of the setup, please visit the previous page. -JS RLC is not in the business of customization. it will ignore client.tsp and the follow scenarios will not have impact on the JS RLC user experiences. In this context, TypeScript part means JS DPG. +JS RLC is not in the business of customization. it will ignore client.tsp and the follow scenarios will not have impact on the JS RLC user experiences. In this context, TypeScript part means JS convenience emitter. ## Default behavior From 7360550410645a2a33e3112ef39132af58e2c676 Mon Sep 17 00:00:00 2001 From: Catalina Peralta Date: Mon, 12 Aug 2024 15:15:35 -0700 Subject: [PATCH 4/4] update js emitter --- docs/howtos/Client Generation/02client.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howtos/Client Generation/02client.mdx b/docs/howtos/Client Generation/02client.mdx index 1d523bceba..d6b66cdda4 100644 --- a/docs/howtos/Client Generation/02client.mdx +++ b/docs/howtos/Client Generation/02client.mdx @@ -5,7 +5,7 @@ import TabItem from "@theme/TabItem"; This page documents the default client hierarchy behavior as well as how to customize clients. For an overview of the setup, please visit the previous page. -JS RLC is not in the business of customization. it will ignore client.tsp and the follow scenarios will not have impact on the JS RLC user experiences. In this context, TypeScript part means JS convenience emitter. +JS RLC is not in the business of customization. it will ignore client.tsp and the follow scenarios will not have impact on the JS RLC user experiences. In this context, TypeScript part means JS Modular Emitter. ## Default behavior