Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
For technical details go to the official repository:
https://github.com/docs4all/docs4all
Execute these commands:
- npm install
- npm run dev (for developers)
- npm run start (for servers)
Execute these commands:
npm install
npm run build
export DOCS4ALL_SITE_FOLDER=docs
git push origin master
- under markdown folder, add markdown files grouped by folders
Instead visio, draw.io, dia software, etc, we just need text plain. To do that, we use https://plantuml.com which is a online service to diagram as code!!
- Go to http://www.plantuml.com/plantuml/uml
- Code your diagram
- Get the url of image which is at the bottom
- Go to markdown and put the url using image syntax. Don't forget to add https: at the start of the url
- In order to save your code diagram for future modifications, paste it after the url and comment it.
<!--
@startwbs
* whatsap app
** 01 chats
*** 02 settings
**** 03 account
***** 04 change number
@endwbs
-->
- Several Diagrams
- Web flow / Site Map
- Artifacts Dependency or Relationship
- Flow Chart / Activity Diagram / Decision flow
- Sequence Diagram
- Deployment Diagram
- Entity Relationship diagram (IE/ER) Database
- Colors
- Legend
- Advanced
- https://stackoverflow.com/questions/11557426/how-to-align-blocks-in-plantuml-class-diagrams
- https://crashedmind.github.io/PlantUMLHitchhikersGuide/layout/layout.html
- https://crashedmind.github.io/PlantUMLHitchhikersGuide/PlantUMLSpriteLibraries/plantuml_sprites.html
- https://github.com/yfuruyama/real-world-plantuml
- https://github.com/plantuml-stdlib/C4-PlantUML
- https://github.com/robbell/plantuml-c4
- https://github.com/future-architect/puml-themes
- https://github.com/topics/plantuml
To add a login page, check the following links:
docker build -t self-service-docs .
docker run --name help-center-docs -it --rm -p 8081:8080 -v $(pwd):/usr/src/app \
-e LOGIN_TYPE=simple \
-e USER_jane=changeme \
-e USER_kurt=secret \
self-service-docs
More details here: https://github.com/jrichardsz-software-architect-tools/nodeboot-web-security-starter#how-it-works
docker build -t self-service-docs .
docker run --name self-service-docs -it --rm -p 8081:8080 -v $(pwd):/usr/src/app \
-e LOGIN_TYPE=microsoft \
-e BASE_URL=www.acmedocs.com \
-e LOGIN_OAUTH2_CLIENT_ID=***** \
-e LOGIN_OAUTH2_CLIENT_SECRET=***** \
-e ALLOWED_USERS="[email protected],[email protected]" \
mkdocs_secure
More details here: https://github.com/jrichardsz-software-architect-tools/mkdocs-mod-template/wiki/Add-microsoft-login
- Login with google
- Locate or develop a new diagram for ui flow like this https://images.squarespace-cdn.com/content/v1/52b4f631e4b05c778fe3b2e8/1516773832459-REJAQ0P12BND9YVVT422/Sideworq+UX+Flow.jpg?format=1000w
JRichardsz |