feat(doc): update with migration files

ovh · Jul 29, 2024 · d3cfb7a · d3cfb7a
1 parent 97ff357
commit d3cfb7a
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 5 deletions.
diff --git a/...s/component-generator/templates/component/documentation/migration.from.17.x.mdx b/...s/component-generator/templates/component/documentation/migration.from.17.x.mdx
@@ -0,0 +1,16 @@
+## Attributes changes
+
+`dummy` <img src="https://img.shields.io/badge/removed-FF0000" />
+
+Has been removed.
+
+You can use the new `better-dummy` attribute to obtain the same rendering.
+
+## Migration examples
+
+Dummy {{> component-name}}:
+```html
+<ods-{{> component-name}} dummy></ods-{{> component-name}}>
+<!-- is now -->
+<ods-{{> component-name}} better-dummy></ods-{{> component-name}}>
+```
diff --git a/scripts/component-generator/templates/storybook/1_specifications.stories.mdx.hbs b/scripts/component-generator/templates/storybook/1_specifications.stories.mdx.hbs
@@ -1,7 +1,7 @@
 import { Meta } from '@storybook/addon-docs';
-import Specifications{{> ComponentName }} from '@ovhcloud/ods-{{> component-dir}}/src/components/{{ name }}/documentation/specifications/specifications-{{> component-name }}.mdx';
+import Specifications{{> ComponentName }} from '@ovhcloud/ods-{{> component-dir}}/src/components/{{> component-name }}/documentation/specifications/specifications-{{> component-name }}.mdx';
 
-<Meta title="ODS Components/TODO/{{> ComponentName }} Specifications" />
+<Meta title="ODS Components/TODO/{{> ComponentName }}/Specifications" />
 
 # {{> ComponentName }} - Design Specifications
 ----

diff --git a/scripts/component-generator/templates/storybook/2_usage.stories.mdx.hbs b/scripts/component-generator/templates/storybook/2_usage.stories.mdx.hbs
@@ -1,7 +1,7 @@
 import { Meta } from '@storybook/addon-docs';
-import Usage from '@ovhcloud/ods-{{> component-dir}}/src/components/{{ name }}/documentation/usage-guidelines/usage.mdx';
+import Usage from '@ovhcloud/ods-{{> component-dir}}/src/components/{{> component-name }}/documentation/usage-guidelines/usage.mdx';
 
-<Meta title="ODS Components/TODO/{{> ComponentName }} Usage Guidelines" />
+<Meta title="ODS Components/TODO/{{> ComponentName }}/Usage Guidelines" />
 
 # {{> ComponentName }} - Usage Guidelines
 ----

diff --git a/scripts/component-generator/templates/storybook/3_migration_.from.17.x.stories.mdx b/scripts/component-generator/templates/storybook/3_migration_.from.17.x.stories.mdx
@@ -0,0 +1,9 @@
+import { Meta } from '@storybook/addon-docs';
+import Migration from '@ovhcloud/ods-{{> component-dir}}/src/components/{{> component-name }}/documentation/migration.from.17.x.mdx';
+
+<Meta title="ODS Components/TODO/{{> ComponentName }}/Migration From 17.x" />
+
+# {{> ComponentName }} - migrate from v17 to v18
+----
+
+<Migration />
diff --git a/...templates/storybook/3_demo.stories.ts.hbs → ...templates/storybook/4_demo.stories.ts.hbs b/...templates/storybook/3_demo.stories.ts.hbs → ...templates/storybook/4_demo.stories.ts.hbs
@@ -4,7 +4,7 @@ import { html } from 'lit-html';
 defineCustomElement();
 
 export default {
-  title: 'ODS Components/TODO/{{> ComponentName }} Demo',
+  title: 'ODS Components/TODO/{{> ComponentName }}/Demo',
   render: (args) => html`
     <ods-{{> component-name }} dummy="${args.dummy}">
     </ods-{{> component-name }}>