[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
This commit is contained in:
tomgny 2021-11-10 09:14:37 +01:00 committed by GitHub
parent 9c64f7fb9d
commit 56ad824fb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 91 additions and 0 deletions

View File

@ -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

View File

@ -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)
<!-- tocstop -->
@ -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)

View File

@ -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)
<!-- tocstop -->
@ -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)

View File

@ -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)
<!-- tocstop -->
@ -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)

32
lib/stories/README.md Normal file
View File

@ -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.
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Storybook](#storybook)
- [License](#license)
<!-- tocstop -->
<!-- markdown-toc end -->
## 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)