Skip to content

Commit

Permalink
chore(docs): move all "Meta" components to a different section (#96)
Browse files Browse the repository at this point in the history
Signed-off-by: Francois Eoche <[email protected]>
  • Loading branch information
feoche authored Jul 11, 2023
1 parent d7d653e commit dc86eb9
Show file tree
Hide file tree
Showing 35 changed files with 46 additions and 44 deletions.
2 changes: 1 addition & 1 deletion packages/stencil/components/progress-bar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@ovhcloud/ods-stencil-progress-bar",
"version": "14.0.1",
"private": true,
"description": "ProgressBar component",
"description": "Progress Bar component",
"author": "OVH SAS",
"license": "Apache-2.0",
"main": "dist/index.cjs.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe('spec:osds-progress-bar', () => {

page = await newSpecPage({
components: [OsdsProgressBar],
html: `<osds-progress-bar ${OdsStringAttributes2Str(stringAttributes)}>My ProgressBar</osds-progress-bar>`,
html: `<osds-progress-bar ${OdsStringAttributes2Str(stringAttributes)}>My Progress Bar</osds-progress-bar>`,
});

root = page.root;
Expand Down
2 changes: 2 additions & 0 deletions packages/tools/storybook/.storybook/preview.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ export const parameters = {
],
'UI Components',
['Introduction'],
'Meta Components',
['Introduction'],
'Contributing',
['Get Started', 'Deployment and Versioning', 'Repository Strategy', 'Troubleshooting Notes'],
'Libraries',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Meta } from '@storybook/addon-docs';
import SpecificationsAccordionGroup from '@ovhcloud/ods-specifications/components/accordion-group/specifications-accordion-group.mdx';

<Meta title="UI Components/Accordion/Accordion Group [molecule]/Specifications" />
<Meta title="UI Components/Accordion Group [molecule]/Specifications" />

# Accordion Group - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Usage from '@ovhcloud/ods-stencil-accordion/docs/osds-accordion-group/usa
import APITable from '@ovhcloud/ods-stencil-accordion/dist/docs/components/osds-accordion-group/readme.md';
import { getToC } from '../../../core/table-of-contents.mdx';

<Meta title="UI Components/Accordion/Accordion Group [molecule]/Web Component" />
<Meta title="UI Components/Accordion Group [molecule]/Web Component" />

# `<osds-accordion-group>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Accordion/Accordion Group [molecule]/Web Component',
title: 'UI Components/Accordion Group [molecule]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-accordion/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Meta } from '@storybook/addon-docs';
import SpecificationsAccordion from '@ovhcloud/ods-specifications/components/accordion/specifications-accordion.mdx';

<Meta title="UI Components/Accordion/Accordion [atom]/Specifications" />
<Meta title="UI Components/Accordion [atom]/Specifications" />

# Accordion - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Usage from '@ovhcloud/ods-stencil-accordion/docs/osds-accordion/usage.mdx
import APITable from '@ovhcloud/ods-stencil-accordion/dist/docs/components/osds-accordion/readme.md';
import { getToC } from '../../../core/table-of-contents.mdx';

<Meta title="UI Components/Accordion/Accordion [atom]/Web Component" />
<Meta title="UI Components/Accordion [atom]/Web Component" />

# `<osds-accordion>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Accordion/Accordion [atom]/Web Component',
title: 'UI Components/Accordion [atom]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-accordion/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsCheckboxButton from '@ovhcloud/ods-specifications/components/checkbox-button/specifications-checkbox-button.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/Checkbox/Checkbox Button [atom]/Specifications" />
<Meta title="UI Components/Checkbox Button [atom]/Specifications" />

# Checkbox Button - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Canvas, Description, Meta, DocsContainer } from '@storybook/addon-docs'
import Usage from '@ovhcloud/ods-stencil-checkbox-button/docs/osds-checkbox-button/usage.mdx';
import APITable from '@ovhcloud/ods-stencil-checkbox-button/dist/docs/components/osds-checkbox-button/readme.md';

<Meta title="UI Components/Checkbox/Checkbox Button [atom]/Web Component" />
<Meta title="UI Components/Checkbox Button [atom]/Web Component" />

# `<osds-checkbox-button>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Checkbox/Checkbox Button [atom]/Web Component',
title: 'UI Components/Checkbox Button [atom]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-checkbox-button/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsCheckbox from '@ovhcloud/ods-specifications/components/checkbox/specifications-checkbox.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/Checkbox/Checkbox [meta]/Specifications" />
<Meta title="Meta Components/Checkbox [meta]/Specifications" />

# Checkbox - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Canvas, Description, Meta, DocsContainer } from '@storybook/addon-docs'
import Usage from '@ovhcloud/ods-stencil-checkbox/docs/osds-checkbox/usage.mdx';
import APITable from '@ovhcloud/ods-stencil-checkbox/dist/docs/components/osds-checkbox/readme.md';

<Meta title="UI Components/Checkbox/Checkbox [meta]/Web Component" />
<Meta title="Meta Components/Checkbox [meta]/Web Component" />

# `<osds-checkbox>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Checkbox/Checkbox [meta]/Web Component',
title: 'Meta Components/Checkbox [meta]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-components-checkbox/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsCollapsible from '@ovhcloud/ods-specifications/components/collapsible/specifications-collapsible.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/Collapsible [meta]/Specifications" />
<Meta title="Meta Components/Collapsible [meta]/Specifications" />

# Collapsible - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Collapsible [meta]/Web Component',
title: 'Meta Components/Collapsible [meta]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-collapsible/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import Notes from '../notes.mdx';
import './location-tile.replacement.css';

<Meta title="UI Components/Tile/Location Tile [deprecated]/Remplacement" />
<Meta title="UI Components/Location Tile [deprecated]/Remplacement" />

# Location tile - Deprecated
----
Expand All @@ -29,7 +29,7 @@ import './location-tile.replacement.css';
<span style={{ display: "grid", "grid-template-columns": "1fr 1fr" }}>
<span>Html

```html
```html
<osds-tile color="default">
<div class="location__content-vertical">
<div class="location__flag-wrapper">
Expand All @@ -48,7 +48,7 @@ import './location-tile.replacement.css';
<span>
CSS

```css
```css
.location__content-vertical {
display: grid;
gap: 1em 0;
Expand Down Expand Up @@ -87,7 +87,7 @@ import './location-tile.replacement.css';
grid-template-columns: 1fr;
grid-template-rows: auto;
place-content: center;

}

.location__text-country, .location__text-city {
Expand Down Expand Up @@ -120,7 +120,7 @@ import './location-tile.replacement.css';
</span>
</span>

---
---

### Horizontal

Expand All @@ -137,12 +137,12 @@ import './location-tile.replacement.css';
</div>
</osds-tile>

---
---

<span style={{ display: "grid", "grid-template-columns": "1fr 1fr" }}>
<span>Html

```html
```html
<osds-tile color="default">
<div class="location__content-horizontal">
<div class="location__flag-wrapper">
Expand All @@ -161,10 +161,10 @@ import './location-tile.replacement.css';
<span>
CSS

```css
```css
.location__content-horizontal {
display: grid;
gap: 0 1em;
gap: 0 1em;
grid-auto-flow: row;
grid-auto-rows: 1fr;
grid-template-areas:
Expand All @@ -178,4 +178,4 @@ import './location-tile.replacement.css';
```

</span>
</span>
</span>
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsLocationTile from '@ovhcloud/ods-specifications/components/location-tile/specifications-location-tile.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/Tile/Location Tile [deprecated]/Specifications" />
<Meta title="UI Components/Location Tile [deprecated]/Specifications" />

# Location tile Deprecated- Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Canvas, Description, Meta, DocsContainer } from '@storybook/addon-docs'
import Usage from '@ovhcloud/ods-stencil-location-tile/src/docs/osds-location-tile/usage.mdx';
import APITable from '@ovhcloud/ods-stencil-location-tile/dist/docs/components/osds-location-tile/readme.md';

<Meta title="UI Components/Tile/️Location Tile [deprecated]/Web Component" />
<Meta title="UI Components/️Location Tile [deprecated]/Web Component" />

<h2 style={{ color: 'red' }}>
⚠ Warning this component is deprecated and will be remove soon
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Tile/Location Tile [deprecated]/Web Component',
title: 'UI Components/Location Tile [deprecated]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-location-tile/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsProgressBar from '@ovhcloud/ods-specifications/components/progress-bar/specifications-progress-bar.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/ProgressBar [atom]/Specifications" />
<Meta title="UI Components/Progress Bar [atom]/Specifications" />

# ProgressBar - Technical Specification
# Progress Bar - Technical Specification
----

<SpecificationsProgressBar />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const storyParams = {
};

export default {
title: 'UI Components/ProgressBar [atom]/Web Component',
title: 'UI Components/Progress Bar [atom]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-progress-bar/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Notes from '../notes.mdx';

import { getToC } from '../../../core/table-of-contents.mdx';

<Meta title="UI Components/Radio/Radio Button [atom]/Specifications" />
<Meta title="UI Components/Radio Button [atom]/Specifications" />

# Radio Button - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Canvas, Description, Meta, DocsContainer } from '@storybook/addon-docs'
import Usage from '@ovhcloud/ods-stencil-radio-button/docs/osds-radio-button/usage.mdx';
import APITable from '@ovhcloud/ods-stencil-radio-button/dist/docs/components/osds-radio-button/readme.md';

<Meta title="UI Components/Radio/Radio Button [atom]/Web Component" />
<Meta title="UI Components/Radio Button [atom]/Web Component" />

# `<osds-radio-button>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Radio/Radio Button [atom]/Web Component',
title: 'UI Components/Radio Button [atom]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-radio-button/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsRadioGroup from '@ovhcloud/ods-specifications/components/radio-group/specifications-radio-group.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/Radio/Radio Group [molecule]/Specifications" />
<Meta title="Meta Components/Radio Group [meta]/Specifications" />

# Radio group - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Canvas, Description, Meta, DocsContainer } from '@storybook/addon-docs'
import Usage from '@ovhcloud/ods-stencil-radio/docs/osds-radio-group/usage.mdx';
import APITable from '@ovhcloud/ods-stencil-radio/dist/docs/components/osds-radio-group/readme.md';

<Meta title="UI Components/Radio/Radio Group [molecule]/Web Component" />
<Meta title="Meta Components/Radio Group [meta]/Web Component" />

# `<osds-radio-group>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Radio/Radio Group [molecule]/Web Component',
title: 'Meta Components/Radio Group [meta]/Web Component',
parameters: {
notes: {
API: iframe('stencil-components-radio-group/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsRadio from '@ovhcloud/ods-specifications/components/radio/specifications-radio.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/Radio/Radio [meta]/Specifications" />
<Meta title="Meta Components/Radio [meta]/Specifications" />

# Radio - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Canvas, Description, Meta, DocsContainer } from '@storybook/addon-docs'
import Usage from '@ovhcloud/ods-stencil-radio/docs/osds-radio/usage.mdx';
import APITable from '@ovhcloud/ods-stencil-radio/dist/docs/components/osds-radio/readme.md';

<Meta title="UI Components/Radio/Radio [meta]/Web Component" />
<Meta title="Meta Components/Radio [meta]/Web Component" />

# `<osds-radio>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Radio/Radio [meta]/Web Component',
title: 'Meta Components/Radio [meta]/Web Component',
parameters: {
notes: {
API: iframe('stencil-components-radio/modules/index.html'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Meta } from '@storybook/addon-docs';
import SpecificationsTile from '@ovhcloud/ods-specifications/components/tile/specifications-tile.mdx';
import Notes from '../notes.mdx';

<Meta title="UI Components/Tile/Tile [atom]/Specifications" />
<Meta title="UI Components/Tile [atom]/Specifications" />

# Tile - Technical Specification
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Canvas, Description, Meta, DocsContainer } from '@storybook/addon-docs'
import Usage from '@ovhcloud/ods-stencil-tile/src/docs/osds-tile/usage.mdx';
import APITable from '@ovhcloud/ods-stencil-tile/dist/docs/components/osds-tile/readme.md';

<Meta title="UI Components/Tile/️Tile [atom]/Web Component" />
<Meta title="UI Components/️Tile [atom]/Web Component" />

# `<osds-tile>`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ const storyParams = {
};

export default {
title: 'UI Components/Tile/Tile [atom]/Web Component',
title: 'UI Components/Tile [atom]/Web Component',
parameters: {
notes: {
API: iframe('/stencil-tile/modules/index.html'),
Expand Down

0 comments on commit dc86eb9

Please sign in to comment.