From 5f57f1b1342f16e6eccc3381c74ab037b057ec93 Mon Sep 17 00:00:00 2001 From: John Coburn Date: Mon, 18 Jul 2022 09:18:02 -0500 Subject: [PATCH] Rename docs folder (#1869) * rename docs folder to guides * update links to docs * update storybook config for guides * log changes * include addon-actions * correct the filename links * fix contributing doc --- .storybook/main.js | 2 +- CONTRIBUTING.md | 2 +- FAQ.md | 6 +++--- README.md | 14 +++++++------- .../AccessibilityDevPrimer.stories.mdx | 0 {docs => guides}/AccessibilityOverview.stories.mdx | 0 {docs => guides}/CSSinStripes.stories.mdx | 0 {docs => guides}/Testing.stories.mdx | 0 {docs => guides}/UIModuleLayout.stories.mdx | 0 .../patterns/AccessibleRouting.stories.mdx | 0 .../patterns/ColumnSelector.stories.mdx | 0 11 files changed, 12 insertions(+), 12 deletions(-) rename {docs => guides}/AccessibilityDevPrimer.stories.mdx (100%) rename {docs => guides}/AccessibilityOverview.stories.mdx (100%) rename {docs => guides}/CSSinStripes.stories.mdx (100%) rename {docs => guides}/Testing.stories.mdx (100%) rename {docs => guides}/UIModuleLayout.stories.mdx (100%) rename {docs => guides}/patterns/AccessibleRouting.stories.mdx (100%) rename {docs => guides}/patterns/ColumnSelector.stories.mdx (100%) diff --git a/.storybook/main.js b/.storybook/main.js index 3b36aa399..aa045f8c0 100644 --- a/.storybook/main.js +++ b/.storybook/main.js @@ -8,7 +8,7 @@ module.exports = { postcss: false, // we use our own postcss setup }, stories: [{ - directory: '../docs', + directory: '../guides', titlePrefix: 'Guides', files: '**/*.mdx' }, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b63612f98..28a484070 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,4 +10,4 @@ Before adding a new component, be sure that your use-case isn't already covered Please limit PR's in scope. A PR with a high number of changed files can be quite difficult to effectively review. The last thing that we want is to merge in the fix to a single problem while introducing 4 or 5 new ones at the same time. ## Testing -Component tests are automated browser tests powered by karma and written using mocha syntax. See [Testing in Stripes Components](docs/Testing.md) for more information. +Component tests are automated browser tests powered by karma and written using mocha syntax. See [Testing in Stripes Components](guides/Testing.stories.mdx) for more information. diff --git a/FAQ.md b/FAQ.md index 61d760307..50c31d3b8 100644 --- a/FAQ.md +++ b/FAQ.md @@ -17,12 +17,12 @@ To see components in action, our storybook can be run locally via the command 1. Reach out to the core FOLIO team on Slack, or via a JIRA in the STCOM project at [issues.folio.org](https://issues.folio.org) We can make suggestions for alternative stripes-components or props that may need to be applied to achieve the necessary results. 2. If your use-case cannot be solved with the current state of a component, the path forward is to create a PR for the change on the stripes-components repo. The change should meet the following criteria: - 1. Be mindful of accessibility in the rendered markup. Check out our [Accessibility guide](docs/Accessibility.md) - 2. Have additional tests written and passing. See our [Testing guide](TESTING.md) + 1. Be mindful of accessibility in the rendered markup. Check out our [Accessibility guide](guides/AccessibilityDevPrimer.stories.mdx) + 2. Have additional tests written and passing. See our [Testing guide](guides/testing.stories.mdx) 3. Be documented for other developers: * in the CHANGELOG.md * in the component's README.md if it affects the component's API or is noteworthy to future users of the components. - 4. Be in-line with [stripes-components style guidelines](docs/CSSinStripes.md) + 4. Be in-line with [stripes-components style guidelines](guides/CSSinStripes.stories.mdx) 4. **There’s not a component that meets the use case I have. What should I do?** diff --git a/README.md b/README.md index eb284a5bc..08920556f 100644 --- a/README.md +++ b/README.md @@ -147,14 +147,14 @@ Component | doc | categories There are also various [utility _functions_](util) (as opposed to React components), which are [documented separately](util/README.md). ## Accessibility -* [Accessibility overview](docs/AccessibilityOverview.md) - general overview of some utilities that stripes-components provides. -* [Accessibility for developers](docs/AccessibilityDevPrimer.md) - dev-specific primer for accessibility. More direct code/component reference - a great intro for those who are unfamiliar to accessibility. +* [Accessibility overview](guides/AccessibilityOverview.stories.mdx) - general overview of some utilities that stripes-components provides. +* [Accessibility for developers](guides/AccessibilityDevPrimer.stories.mdx) - dev-specific primer for accessibility. More direct code/component reference - a great intro for those who are unfamiliar to accessibility. ## Patterns Useful recipes for UI patterns appearing in FOLIO modules. -* [Show/Hide Columns in MCL](docs/patterns/ColumnSelector.md) -- Give users the ability to select only the data they need to see. -* [Accessible Routing](docs/patterns/AccessibleRouting.md) -- Detail the approaches to implementing accessible focus management. +* [Show/Hide Columns in MCL](guides/patterns/ColumnSelector.stories.mdx) -- Give users the ability to select only the data they need to see. +* [Accessible Routing](guides/patterns/AccessibleRouting.stories.mdx) -- Detail the approaches to implementing accessible focus management. ## Testing Stripes Components' tests are automated browser tests powered by @@ -173,7 +173,7 @@ This will spin up Karma via [`stripes-cli`](https://github.com/folio-org/stripes-cli) and run all tests locally in the Chrome browser. -See our [testing documentation](docs/Testing.md) for more information +See our [testing documentation](guides/Testing.stroies.mdx) for more information on writing tests. ## FAQ @@ -192,8 +192,8 @@ and Some related documents: -* [Guide to UI Module Layout Components](docs/UIModuleLayout.md) -* [CSS for stripes-components development](docs/CSSinStripes.md) +* [Guide to UI Module Layout Components](guides/UIModuleLayout.stories.mdx) +* [CSS for stripes-components development](guides/CSSinStripes.stories.mdx) * [Change-log](CHANGELOG.md) See project [STCOM](https://issues.folio.org/browse/STCOM) (STripes COMponents) diff --git a/docs/AccessibilityDevPrimer.stories.mdx b/guides/AccessibilityDevPrimer.stories.mdx similarity index 100% rename from docs/AccessibilityDevPrimer.stories.mdx rename to guides/AccessibilityDevPrimer.stories.mdx diff --git a/docs/AccessibilityOverview.stories.mdx b/guides/AccessibilityOverview.stories.mdx similarity index 100% rename from docs/AccessibilityOverview.stories.mdx rename to guides/AccessibilityOverview.stories.mdx diff --git a/docs/CSSinStripes.stories.mdx b/guides/CSSinStripes.stories.mdx similarity index 100% rename from docs/CSSinStripes.stories.mdx rename to guides/CSSinStripes.stories.mdx diff --git a/docs/Testing.stories.mdx b/guides/Testing.stories.mdx similarity index 100% rename from docs/Testing.stories.mdx rename to guides/Testing.stories.mdx diff --git a/docs/UIModuleLayout.stories.mdx b/guides/UIModuleLayout.stories.mdx similarity index 100% rename from docs/UIModuleLayout.stories.mdx rename to guides/UIModuleLayout.stories.mdx diff --git a/docs/patterns/AccessibleRouting.stories.mdx b/guides/patterns/AccessibleRouting.stories.mdx similarity index 100% rename from docs/patterns/AccessibleRouting.stories.mdx rename to guides/patterns/AccessibleRouting.stories.mdx diff --git a/docs/patterns/ColumnSelector.stories.mdx b/guides/patterns/ColumnSelector.stories.mdx similarity index 100% rename from docs/patterns/ColumnSelector.stories.mdx rename to guides/patterns/ColumnSelector.stories.mdx