Merge pull request #492 from dnum-mi/docs/update-docs

laruiss · web-flow · commit 7b9fe7312e0c · 2023-02-24T14:19:53.000+01:00
docs/update docs
diff --git a/.storybook/main.js b/.storybook/main.js
@@ -1,7 +1,7 @@
 import { mergeConfig } from 'vite'
 
 module.exports = {
-  "stories": ["../src/**/*.stories.@(mdx|js|jsx|ts|tsx)"],
+  "stories": ["../src/**/*.@(mdx|stories.@(js|jsx|ts|tsx))"],
   "addons": ["@storybook/addon-links", "@storybook/addon-essentials", {
     name: '@storybook/addon-postcss',
     options: {
@@ -18,9 +18,13 @@ module.exports = {
   docs: {
     autodocs: true
   },
-  async viteFinal(config, { configType }) {
+  async viteFinal(config, {
+    configType
+  }) {
     return mergeConfig(config, {
-      define: { 'process.env': {} },
+      define: {
+        'process.env': {}
+      }
     });
-  },
-};
+  }
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -85,16 +85,16 @@
     "@rollup/plugin-replace": "^5.0.2",
     "@rollup/plugin-url": "^8.0.1",
     "@rushstack/eslint-patch": "^1.2.0",
-    "@storybook/addon-actions": "^7.0.0-beta.45",
-    "@storybook/addon-docs": "^7.0.0-beta.45",
-    "@storybook/addon-essentials": "^7.0.0-beta.45",
-    "@storybook/addon-links": "^7.0.0-beta.45",
+    "@storybook/addon-actions": "^7.0.0-beta.53",
+    "@storybook/addon-docs": "^7.0.0-beta.53",
+    "@storybook/addon-essentials": "^7.0.0-beta.53",
+    "@storybook/addon-links": "^7.0.0-beta.53",
     "@storybook/addon-postcss": "^2.0.0",
-    "@storybook/client-api": "^7.0.0-beta.45",
-    "@storybook/client-logger": "^7.0.0-beta.45",
-    "@storybook/core-common": "^7.0.0-beta.45",
-    "@storybook/vue3": "^7.0.0-beta.45",
-    "@storybook/vue3-vite": "^7.0.0-beta.45",
+    "@storybook/client-api": "^7.0.0-beta.53",
+    "@storybook/client-logger": "^7.0.0-beta.53",
+    "@storybook/core-common": "^7.0.0-beta.53",
+    "@storybook/vue3": "^7.0.0-beta.53",
+    "@storybook/vue3-vite": "^7.0.0-beta.53",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/user-event": "^14.4.3",
     "@testing-library/vue": "^6.6.1",
@@ -125,7 +125,7 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-storybook": "^0.6.10",
+    "eslint-plugin-storybook": "^0.6.11",
     "eslint-plugin-vue": "^9.9.0",
     "globby": "^13.1.3",
     "inquirer": "^9.1.4",
@@ -153,7 +153,7 @@
     "rollup-plugin-vue": "^6.0.0",
     "semantic-release": "^20.1.0",
     "start-server-and-test": "^1.15.3",
-    "storybook": "^7.0.0-beta.45",
+    "storybook": "^7.0.0-beta.53",
     "tsd-jsdoc": "^2.5.0",
     "typescript": "^4.9.5",
     "vite": "^4.1.1",
diff --git a/src/components/DsfrAccordion/DsfrAccordion.stories.js b/src/components/DsfrAccordion/DsfrAccordion.stories.js
@@ -1,6 +1,9 @@
 import DsfrAccordion from './DsfrAccordion.vue'
 import DsfrAccordionsGroup from './DsfrAccordionsGroup.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/accordeon/)
+ */
 export default {
   component: DsfrAccordion,
   title: 'Composants/Accordéon - DsfrAccordion',
diff --git a/src/components/DsfrAccordion/DsfrAccordionsGroup.stories.js b/src/components/DsfrAccordion/DsfrAccordionsGroup.stories.js
@@ -1,6 +1,9 @@
 import DsfrAccordionsGroup from './DsfrAccordionsGroup.vue'
 import DsfrAccordion from './DsfrAccordion.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/accordeon/)
+ */
 export default {
   component: DsfrAccordionsGroup,
   title: 'Composants/Accordéon - DsfrAccordionsGroup',
diff --git a/src/components/DsfrAlert/DsfrAlert.stories.js b/src/components/DsfrAlert/DsfrAlert.stories.js
@@ -6,6 +6,9 @@ import { RiCloseLine } from 'oh-vue-icons/icons/ri/index.js'
 
 addIcons(RiCloseLine)
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/alerte)
+ */
 export default {
   component: DsfrAlert,
   title: 'Composants/Alertes - DsfrAlert',
diff --git a/src/components/DsfrAlert/DsfrAlert.vue b/src/components/DsfrAlert/DsfrAlert.vue
@@ -100,7 +100,3 @@ export default defineComponent({
 </template>
 
 <style src="@gouvfr/dsfr/dist/component/alert/alert.main.min.css" />
-
-<style scoped>
-
-</style>
diff --git a/src/components/DsfrBadge/DsfrBadge.stories.js b/src/components/DsfrBadge/DsfrBadge.stories.js
@@ -1,5 +1,8 @@
 import DsfrBadge from './DsfrBadge.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/badge)
+ */
 export default {
   component: DsfrBadge,
   title: 'Composants/Badge - DsfrBadge',
diff --git a/src/components/DsfrBreadcrumb/DsfrBreadcrumb.stories.js b/src/components/DsfrBreadcrumb/DsfrBreadcrumb.stories.js
@@ -1,5 +1,8 @@
 import DsfrBreadcrumb from './DsfrBreadcrumb.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/fil-d-ariane)
+ */
 export default {
   component: DsfrBreadcrumb,
   title: 'Composants/Fil d’Ariane - DsfrBreadcrumb',
diff --git a/src/components/DsfrButton/DsfrButton.stories.js b/src/components/DsfrButton/DsfrButton.stories.js
@@ -6,6 +6,9 @@ import DsfrButton from './DsfrButton.vue'
 
 addIcons(RiCheckboxCircleLine, RiSearchLine)
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/bouton)
+ */
 export default {
   component: DsfrButton,
   title: 'Composants/Boutons/Boutons - DsfrButton',
diff --git a/src/components/DsfrButton/DsfrButtonGroup.stories.js b/src/components/DsfrButton/DsfrButtonGroup.stories.js
@@ -6,6 +6,9 @@ import DsfrButtonGroup from './DsfrButtonGroup.vue'
 
 addIcons(RiCheckboxCircleLine)
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/groupe-de-boutons)
+ */
 export default {
   component: DsfrButtonGroup,
   title: 'Composants/Boutons/Groupe de Boutons - DsfrButtonGroup',
diff --git a/src/components/DsfrCallout/DsfrCallout.stories.js b/src/components/DsfrCallout/DsfrCallout.stories.js
@@ -6,6 +6,9 @@ import DsfrCallout from './DsfrCallout.vue'
 
 addIcons(RiInformationLine)
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/mise-en-avant)
+ */
 export default {
   component: DsfrCallout,
   title: 'Composants/Mise en Avant - Callout',
diff --git a/src/components/DsfrCard/DsfrCard.stories.js b/src/components/DsfrCard/DsfrCard.stories.js
@@ -1,5 +1,8 @@
 import DsfrCard from './DsfrCard.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/carte)
+ */
 export default {
   component: DsfrCard,
   title: 'Composants/Carte - DsfrCard',
diff --git a/src/components/DsfrCheckbox/DsfrCheckbox.stories.js b/src/components/DsfrCheckbox/DsfrCheckbox.stories.js
@@ -1,5 +1,8 @@
 import DsfrCheckbox from './DsfrCheckbox.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/case-a-cocher)
+ */
 export default {
   component: DsfrCheckbox,
   title: 'Composants/Case à cocher/Case à cocher - DsfrCheckbox',
diff --git a/src/components/DsfrCheckbox/DsfrCheckboxSet.stories.js b/src/components/DsfrCheckbox/DsfrCheckboxSet.stories.js
@@ -1,5 +1,8 @@
 import DsfrCheckboxSet from './DsfrCheckboxSet.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/case-a-cocher)
+ */
 export default {
   component: DsfrCheckboxSet,
   title: 'Composants/Case à cocher/Groupe de cases à cocher - DsfrCheckboxSet',
diff --git a/src/components/DsfrConsent/DsfrConsent.stories.js b/src/components/DsfrConsent/DsfrConsent.stories.js
@@ -1,5 +1,8 @@
 import DsfrConsent from './DsfrConsent.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/gestionnaire-de-consentement)
+ */
 export default {
   component: DsfrConsent,
   title: 'Composants/Gestionnaire de consentement - DsfrConsent',
diff --git a/src/components/DsfrFileDownload/DsfrFileDownload.stories.js b/src/components/DsfrFileDownload/DsfrFileDownload.stories.js
@@ -1,5 +1,8 @@
 import DsfrFileDownload from './DsfrFileDownload.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/telechargement-de-fichier)
+ */
 export default {
   component: DsfrFileDownload,
   title: 'Composants/Téléchargement de Fichier - DsfrFileDownload',
diff --git a/src/components/DsfrFileDownload/DsfrFileDownloadList.stories.js b/src/components/DsfrFileDownload/DsfrFileDownloadList.stories.js
@@ -1,5 +1,8 @@
 import DsfrFileDownloadList from './DsfrFileDownloadList.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/telechargement-de-fichier)
+ */
 export default {
   component: DsfrFileDownloadList,
   title: 'Composants/Téléchargement de Fichier - DsfrFileDownloadList',
diff --git a/src/components/DsfrFileUpload/DsfrFileUpload.stories.js b/src/components/DsfrFileUpload/DsfrFileUpload.stories.js
@@ -1,5 +1,8 @@
 import DsfrFileUpload from './DsfrFileUpload.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/ajout-de-fichier)
+ */
 export default {
   component: DsfrFileUpload,
   title: 'Composants/Ajout de Fichier - DsfrFileUpload',
diff --git a/src/components/DsfrFollow/DsfrFollow.stories.js b/src/components/DsfrFollow/DsfrFollow.stories.js
@@ -1,5 +1,8 @@
 import DsfrFollow from './DsfrFollow.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/lettre-d-information-et-reseaux-sociaux)
+ */
 export default {
   title: 'Composants/Lettres d’information et réseaux/Lettre d’info + Réseaux - DsfrFollow',
   name: '',
diff --git a/src/components/DsfrFollow/DsfrNewsLetter.stories.js b/src/components/DsfrFollow/DsfrNewsLetter.stories.js
@@ -1,6 +1,9 @@
 import DsfrNewsLetter from './DsfrNewsLetter.vue'
 import DsfrFollow from './DsfrFollow.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/lettre-d-information-et-reseaux-sociaux)
+ */
 export default {
   component: DsfrNewsLetter,
   title: 'Composants/Lettres d’information et réseaux/Lettre d’information - DsfrNewsletter',
diff --git a/src/components/DsfrFollow/DsfrSocialNetworks.stories.js b/src/components/DsfrFollow/DsfrSocialNetworks.stories.js
@@ -1,6 +1,9 @@
 import DsfrSocialNetworks from './DsfrSocialNetworks.vue'
 import DsfrFollow from './DsfrFollow.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/lettre-d-information-et-reseaux-sociaux)
+ */
 export default {
   title: 'Composants/Lettres d’information et réseaux/Réseaux sociaux - DsfrSocialNetworks',
   name: '',
diff --git a/src/components/DsfrFooter/DsfrFooter.stories.js b/src/components/DsfrFooter/DsfrFooter.stories.js
@@ -7,6 +7,9 @@ import DsfrFooterLinkList from './DsfrFooterLinkList.vue'
 
 addIcons(RiExternalLinkLine)
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/pied-de-page)
+ */
 export default {
   component: DsfrFooter,
   title: 'Composants/Pied de page - DsfrFooter',
diff --git a/src/components/DsfrFranceConnect/DsfrFranceConnect.stories.js b/src/components/DsfrFranceConnect/DsfrFranceConnect.stories.js
@@ -1,5 +1,8 @@
 import DsfrFranceConnect from './DsfrFranceConnect.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/bouton-franceconnect)
+ */
 export default {
   component: DsfrFranceConnect,
   title: 'Composants/Connexion - FranceConnect',
diff --git a/src/components/DsfrHeader/DsfrHeader.stories.js b/src/components/DsfrHeader/DsfrHeader.stories.js
@@ -14,6 +14,9 @@ addIcons(
   RiAccountCircleLine,
 )
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/en-tete)
+ */
 export default {
   component: DsfrHeader,
   title: 'Composants/En-tête - DsfrHeader',
diff --git a/src/components/DsfrHighlight/DsfrHighlight.stories.js b/src/components/DsfrHighlight/DsfrHighlight.stories.js
@@ -1,5 +1,8 @@
 import DsfrHighlight from './DsfrHighlight.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/mise-en-exergue)
+ */
 export default {
   component: DsfrHighlight,
   title: 'Composants/Mise en Exergue - DsfrHighlight',
diff --git a/src/components/DsfrInput/DsfrInput.stories.js b/src/components/DsfrInput/DsfrInput.stories.js
@@ -9,6 +9,9 @@ import { RiQuestionFill } from 'oh-vue-icons/icons/ri/index.js'
 
 addIcons(RiQuestionFill)
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/champ-de-saisie)
+ */
 export default {
   component: DsfrInput,
   title: 'Composants/Champ de saisie/Champ simple - DsfrInput',
diff --git a/src/components/DsfrInput/DsfrInputGroup.stories.js b/src/components/DsfrInput/DsfrInputGroup.stories.js
@@ -1,6 +1,9 @@
 import DsfrInput from './DsfrInput.vue'
 import DsfrInputGroup from './DsfrInputGroup.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/champ-de-saisie)
+ */
 export default {
   component: DsfrInput,
   title: 'Composants/Champ de saisie/Champ avec message associé - DsfrInputGroup',
diff --git a/src/components/DsfrLanguageSelector/DsfrLanguageSelector.stories.js b/src/components/DsfrLanguageSelector/DsfrLanguageSelector.stories.js
@@ -1,5 +1,8 @@
 import DsfrLanguageSelector from './DsfrLanguageSelector.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/selecteur-de-langue)
+ */
 export default {
   component: DsfrLanguageSelector,
   title: 'Composants/Sélecteur de langues - DsfrLanguageSelector',
diff --git a/src/components/DsfrModal/DsfrModal.stories.js b/src/components/DsfrModal/DsfrModal.stories.js
@@ -12,6 +12,9 @@ setup(app => {
   app.component('VIcon', VIcon)
 })
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/modale)
+ */
 export default {
   component: DsfrModal,
   title: 'Composants/Modale - DsfrModal',
diff --git a/src/components/DsfrNavigation/DsfrNavigation.stories.js b/src/components/DsfrNavigation/DsfrNavigation.stories.js
@@ -16,6 +16,9 @@ setup(app => {
   app.component('RouterLink', RouterLink)
 })
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/navigation-principale)
+ */
 export default {
   component: DsfrNavigation,
   title: 'Composants/Navigation Principale/1. Navigation Principale - DsfrNavigation',
diff --git a/src/components/DsfrPagination/DsfrPagination.stories.js b/src/components/DsfrPagination/DsfrPagination.stories.js
@@ -1,5 +1,8 @@
 import DsfrPagination from './DsfrPagination.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/pagination)
+ */
 export default {
   component: DsfrPagination,
   title: 'Composants/Pagination - Pagination',
diff --git a/src/components/DsfrQuote/DsfrQuote.stories.js b/src/components/DsfrQuote/DsfrQuote.stories.js
@@ -1,5 +1,8 @@
 import DsfrQuote from './DsfrQuote.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/citation)
+ */
 export default {
   component: DsfrQuote,
   title: 'Composants/Citations - DsfrQuote',
diff --git a/src/components/DsfrRadioButton/DsfrRadioButton.stories.js b/src/components/DsfrRadioButton/DsfrRadioButton.stories.js
@@ -1,6 +1,9 @@
 
 import DsfrRadioButton from './DsfrRadioButton.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/boutons-radio)
+ */
 export default {
   component: DsfrRadioButton,
   title: 'Composants/Boutons radio/Boutons radio - DsfrRadioButtons',
diff --git a/src/components/DsfrRadioButton/DsfrRadioButtonSet.stories.js b/src/components/DsfrRadioButton/DsfrRadioButtonSet.stories.js
@@ -1,5 +1,8 @@
 import DsfrRadioButtonSet from './DsfrRadioButtonSet.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/boutons-radio)
+ */
 export default {
   component: DsfrRadioButtonSet,
   title: 'Composants/Boutons radio/Groupe de boutons radio - DsfrRadioButtonSet',
diff --git a/src/components/DsfrSearchBar/DsfrSearchBar.stories.js b/src/components/DsfrSearchBar/DsfrSearchBar.stories.js
@@ -1,5 +1,8 @@
 import DsfrSearchBar from './DsfrSearchBar.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/barre-de-recherche)
+ */
 export default {
   component: DsfrSearchBar,
   title: 'Composants/Barre de recherche - DsfrSearchBar',
diff --git a/src/components/DsfrSelect/DsfrSelect.stories.js b/src/components/DsfrSelect/DsfrSelect.stories.js
@@ -1,5 +1,8 @@
 import DsfrSelect from './DsfrSelect.vue'
 
+/**
+ * [Voir quand l’utiliser sur la documentation du DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/liste-deroulante)
+ */
 export default {
   component: DsfrSelect,
   title: 'Composants/Liste déroulante - DsfrSelect',
diff --git a/src/components/DsfrShare/DsfrShare.stories.js b/src/components/DsfrShare/DsfrShare.stories.js
diff --git a/src/components/DsfrSideMenu/DsfrSideMenu.stories.js b/src/components/DsfrSideMenu/DsfrSideMenu.stories.js
diff --git a/src/components/DsfrSkipLinks/DsfrSkipLinks.stories.js b/src/components/DsfrSkipLinks/DsfrSkipLinks.stories.js
diff --git a/src/components/DsfrStepper/DsfrStepper.stories.js b/src/components/DsfrStepper/DsfrStepper.stories.js
diff --git a/src/components/DsfrSummary/DsfrSummary.stories.js b/src/components/DsfrSummary/DsfrSummary.stories.js
diff --git a/src/components/DsfrTable/DsfrTable.stories.js b/src/components/DsfrTable/DsfrTable.stories.js
diff --git a/src/components/DsfrTabs/DsfrTabs.stories.js b/src/components/DsfrTabs/DsfrTabs.stories.js
diff --git a/src/components/DsfrTag/DsfrTags.stories.js b/src/components/DsfrTag/DsfrTags.stories.js
diff --git a/src/components/DsfrTile/DsfrTile.stories.js b/src/components/DsfrTile/DsfrTile.stories.js
diff --git a/src/components/DsfrTile/DsfrTiles.stories.js b/src/components/DsfrTile/DsfrTiles.stories.js
diff --git a/src/components/DsfrToggleSwitch/DsfrToggleSwitch.stories.js b/src/components/DsfrToggleSwitch/DsfrToggleSwitch.stories.js
diff --git a/src/components/DsfrTranscription/DsfrTranscription.stories.js b/src/components/DsfrTranscription/DsfrTranscription.stories.js
diff --git a/src/stories/docs/01-intro.stories.mdx b/src/stories/docs/01-intro.stories.mdx
diff --git a/src/stories/docs/04-migration.stories.mdx b/src/stories/docs/04-migration.stories.mdx
