diff --git a/.changeset/lovely-apples-watch.md b/.changeset/lovely-apples-watch.md new file mode 100644 index 000000000..d8781d342 --- /dev/null +++ b/.changeset/lovely-apples-watch.md @@ -0,0 +1,5 @@ +--- +"@ebay/skin": patch +--- + +docs: update Design System name mapping for modules diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 426e38c94..105fe3adb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,7 +97,6 @@ Add applicable metadata about the component to the `module_metadata` map in [doc ```yaml your-module-name: # the Skin module name ds-component: # module's relationship with the eBay Design System - group: # eBay Design System component group name: # eBay Design System component name version: # version of the eBay Design System component implemented in Skin status: # status, e.g. "beta", "deprecated", "in-progress" diff --git a/docs/index.html b/docs/index.html index 43a9d6195..3810b85c7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,7 +5,7 @@ module_metadata: alert-dialog: ds-component: - name: alert-dialog + name: dialog version: 2.1 submodules: - button @@ -25,7 +25,6 @@ - icon button: ds-component: - group: button name: button version: 1.6 carousel: @@ -49,11 +48,11 @@ version: 1.0 chip: ds-component: - name: input-chip + name: chip version: 1.0.0 chips-combobox: ds-component: - name: chip-combobox + name: combobox version: 1.0.0 submodules: - chip @@ -74,8 +73,7 @@ - button cta-button: ds-component: - group: button - name: button + name: cta-button version: 1.2 date-textbox: ds-component: @@ -103,7 +101,7 @@ version: 1.0 eek: ds-component: - name: eek + name: eek-ratings version: 1.1 submodules: - icon @@ -136,14 +134,13 @@ version: 1.3 icon-button: ds-component: - group: button name: icon-button version: 1.6 submodules: - icon infotip: ds-component: - name: infotip + name: tourtip version: 2.0 submodules: - icon-button @@ -155,7 +152,7 @@ - icon lightbox-dialog: ds-component: - - name: modal + - name: dialog version: 2.1 - name: bottom-sheet version: 2.1 @@ -228,7 +225,7 @@ version: 3.1 progress-bar-expressive: ds-component: - name: expressive-loader + name: loading-expressive version: 1.1 progress-spinner: ds-component: @@ -271,7 +268,7 @@ version: 1.0 skeleton: ds-component: - name: skeleton + name: loading-skeleton status: beta version: 1.0 snackbar-dialog: @@ -282,7 +279,6 @@ - button split-button: ds-component: - group: button name: split-button version: 1.6 submodules: @@ -302,12 +298,14 @@ version: 2.1 tabs: ds-component: - name: tabs + name: tab version: 2.1 textbox: ds-component: - name: form-field - version: 2.2 + - name: text-area + version: 2.2 + - name: text-field + version: 2.2 submodules: - icon-button toast-dialog: diff --git a/scripts/develop-module_proper/code-generators/doc-generator.js b/scripts/develop-module_proper/code-generators/doc-generator.js index 406a6d269..912608e5e 100644 --- a/scripts/develop-module_proper/code-generators/doc-generator.js +++ b/scripts/develop-module_proper/code-generators/doc-generator.js @@ -36,7 +36,6 @@ const getMainContent = (moduleId) => ` const getMetadataContent = (moduleId) => ` ${moduleId}: ds-component: # module's relationship with the eBay Design System - group: # eBay Design System component group name: # eBay Design System component name version: # version of the eBay Design System component implemented in Skin status: # status, e.g. "beta", "deprecated", "in-progress"