From 56ad824fb4519bb429d4d02bb18a8a07a919a6a8 Mon Sep 17 00:00:00 2001 From: tomgny <49343696+tomgny@users.noreply.github.com> Date: Wed, 10 Nov 2021 09:14:37 +0100 Subject: [PATCH] [AAE-6358] Storybook sections on GitHub docs (#7358) * [AAE-6358] added storybook section to core readme * [AAE-6358] added storybook seciton to content-services readme * [AAE-6358] fixed content-services readme * [AAE-6358] added storybook section to process-services-cloud readme * [AAE-6358] added readme for stories library * [AAE-6358] added libraries list do root readme --- README.md | 11 ++++++++++ lib/content-services/README.md | 16 ++++++++++++++ lib/core/README.md | 16 ++++++++++++++ lib/process-services-cloud/README.md | 16 ++++++++++++++ lib/stories/README.md | 32 ++++++++++++++++++++++++++++ 5 files changed, 91 insertions(+) create mode 100644 lib/stories/README.md diff --git a/README.md b/README.md index dcec4e60af..1f5ea291ad 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,17 @@ You can find the sources for all ADF components in the Full documentation for all components is available at the [ADF Component Catalog](https://alfresco.github.io/adf-component-catalog/). +## Libraries + +ADF Libraries list: +- [Content services](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/content-services) +- [Core](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/core) +- [Extensions](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/extensions) +- [Insights](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/insights) +- [Process Service Cloud](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/process-services-cloud) +- [Process service](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/process-services) +- [Stories](https://github.com/Alfresco/alfresco-ng2-components/tree/develop/lib/stories) + ## Demo Application A separate application showcasing integration of components can be found diff --git a/lib/content-services/README.md b/lib/content-services/README.md index 348af4a9a6..94f5f1f7ec 100644 --- a/lib/content-services/README.md +++ b/lib/content-services/README.md @@ -9,6 +9,7 @@ Contains a variety of components, directives and services used throughout ADF - [Documentation](#documentation) - [Prerequisites](#prerequisites) - [Install](#install) +- [Storybook](#storybook) - [License](#license) @@ -33,6 +34,21 @@ necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng npm install @alfresco/adf-content-services ``` +## Storybook + +In case you would like to aggregate all the stories from content services library use + +``` +nx run content-services:storybook +``` +And navigate to `http://localhost:4400/`. + +To create a Storybook content services library build use + +``` +nx run content-services:build-storybook +``` + ## License [Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE) diff --git a/lib/core/README.md b/lib/core/README.md index bc36e56b04..b263247345 100644 --- a/lib/core/README.md +++ b/lib/core/README.md @@ -9,6 +9,7 @@ Contains a variety of components, directives and services used throughout ADF - [Documentation](#documentation) - [Prerequisites](#prerequisites) - [Install](#install) +- [Storybook](#storybook) - [License](#license) @@ -33,6 +34,21 @@ necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng npm install @alfresco/adf-core ``` +## Storybook + +In case you would like to aggregate all the stories from core library use + +``` +nx run core:storybook +``` +And navigate to `http://localhost:4400/`. + +To create a Storybook core library build use + +``` +nx run core:build-storybook +``` + ## License [Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE) diff --git a/lib/process-services-cloud/README.md b/lib/process-services-cloud/README.md index d6312a9401..42e57d9cf7 100644 --- a/lib/process-services-cloud/README.md +++ b/lib/process-services-cloud/README.md @@ -9,6 +9,7 @@ Contains a variety of components, directives and services used throughout ADF - [Documentation](#documentation) - [Prerequisites](#prerequisites) - [Install](#install) +- [Storybook](#storybook) - [License](#license) @@ -33,6 +34,21 @@ necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng npm install @alfresco/adf-process-services-cloud ``` +## Storybook + +In case you would like to aggregate all the stories from process services cloud library use + +``` +nx run process-services-cloud:storybook +``` +And navigate to `http://localhost:4400/`. + +To create a Storybook process services cloud library build use + +``` +nx run process-services-cloud:build-storybook +``` + ## License [Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE) diff --git a/lib/stories/README.md b/lib/stories/README.md new file mode 100644 index 0000000000..324764aabc --- /dev/null +++ b/lib/stories/README.md @@ -0,0 +1,32 @@ +# Alfresco Stories Library + +Contains a Storybook stories from **Core**, **Content Services** and **Process Services cloud** libraries to gather them in one place. + + + + + +- [Storybook](#storybook) +- [License](#license) + + + + + +## Storybook + +In case you would like to aggregate all the stories across libraries use +``` +nx run stories:storybook +``` +And navigate to `http://localhost:4400/`. + +To create a Storybook stories library build use + +``` +nx run stories:build-storybook +``` + +## License + +[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)