Merge pull request #165 from linonetwo/docs/images

Docs/images
bpmnServer · Dec 21, 2023 · ae19f02 · ae19f02
2 parents 2a5d20f + c7d9425
commit ae19f02
Show file tree

Hide file tree

Showing 43 changed files with 140 additions and 13,397 deletions.
diff --git a/.github/workflows/deploy-to-github-pages.yml b/.github/workflows/deploy-to-github-pages.yml
@@ -41,9 +41,6 @@ jobs:
           cache: npm
       - name: Install dependencies
         run: npm ci
-      # TODO: add scripts/test-markdown.js back
-      # - name: Check API Docs
-      #   run: npm run docs:check
       - name: Gen API Docs
         run: npm run docs:generate
       - name: Build Docs Site
@@ -53,8 +50,8 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          # Upload entire repository
-          path: .docusaurus
+          # Upload the folder /build generated by docusaurus
+          path: build
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v2
diff --git a/.gitignore b/.gitignore
@@ -14,5 +14,6 @@
 # generated docs
 /.docusaurus
 /docs/api
+/build
 # Copied by scripts\copy-readme.ts
 docs/README.md
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ This package is designed specifically for Node.js and TypeScript
 ### Web based Process modeller
 
 A web based modeler is included based on http://bpmn.io , models definitions are saved at your server
-![Modeller](./docs/model-demo.gif)
+![Modeller](./docs/images/model-demo.gif)
 
 ### Full BPMN Process Engine
 
@@ -39,7 +39,7 @@ Since instances are saved in MongoDB you can easily query your instances (runnin
 
 Included is a sample web application (running Node.js and Express.js) to allow you to visualize your workflow
 
-# Installation
+## Installation
 
 This package requires Node.js and an access to MongoDB ()
 if you don't have MongoDB already installed you can [create a free cloud account here](http://bit.ly/cyd-atlas)
@@ -244,6 +244,10 @@ console.log(`that is it!, process is now complete status=<${response.execution.s
 
 for more complete examples see [Examples](./docs/examples.md)
 
+## Contribution
+
+See [Development Guide](./docs/Development.md)
+
 ## License
 
 This project is licensed under the terms of the MIT license.

diff --git a/docs/Assignee1.PNG b/docs/Assignee1.PNG
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -76,10 +76,10 @@ and here
 ## Release 1.3.8    - 2022-07-09
 
 - Fix errors in throwSignal/throwMessage in bpmn-client
-- Fix errors in throwSignal/throwMessage in api [#52](/../../issues/52)
+- Fix errors in throwSignal/throwMessage in api [#52](https://github.com/bpmnServer/bpmn-server/issues/52)
 - Fix bug showing instance 'end' while still running when in gateway
-- Fix issue with editing element name in property panel [#54](/../../issues/54)
-- Include tmp folder in install [#56](/../../issues/56)
+- Fix issue with editing element name in property panel [#54](https://github.com/bpmnServer/bpmn-server/issues/54)
+- Include tmp folder in install [#56](https://github.com/bpmnServer/bpmn-server/issues/56)
 - Minor changes to UI - preserve the last process
 
 

diff --git a/docs/Data_BuyUsedCar.PNG b/docs/Data_BuyUsedCar.PNG
diff --git a/docs/Data_scripts_services.PNG b/docs/Data_scripts_services.PNG
diff --git a/docs/Data_scripts_services_model.PNG b/docs/Data_scripts_services_model.PNG
diff --git a/docs/Development.md b/docs/Development.md
@@ -0,0 +1,14 @@
+# Development
+
+## Code
+
+## Document
+
+```sh
+npm run docs:generate
+npm run docs:dev
+```
+
+The `docs:generate` will generate API doc from TS code and JSDocs in the comments of TS files. And also copy README.md to the docs folder, so it can be recognized by docusaurus.
+
+`docs:dev` start the doc site locally using docusaurus, you can modify its config at docusaurus.config.ts. It basically turn all markdown files in docs folder into our doc site.
diff --git a/docs/Engine Execution.png b/docs/Engine Execution.png
diff --git a/docs/IO.png b/docs/IO.png
diff --git a/docs/Instances.png b/docs/Instances.png
diff --git a/docs/Modeler.png b/docs/Modeler.png
diff --git a/docs/Starting a Process.png b/docs/Starting a Process.png
diff --git a/docs/bb-1.PNG b/docs/bb-1.PNG
diff --git a/docs/bb-call.PNG b/docs/bb-call.PNG
diff --git a/docs/bb-conditional-flow.PNG b/docs/bb-conditional-flow.PNG
diff --git a/docs/bb-event-scripts.PNG b/docs/bb-event-scripts.PNG
diff --git a/docs/bb-form.PNG b/docs/bb-form.PNG
diff --git a/docs/bb-io.PNG b/docs/bb-io.PNG
diff --git a/docs/bb-message.PNG b/docs/bb-message.PNG
diff --git a/docs/bb-multi-instance.PNG b/docs/bb-multi-instance.PNG
diff --git a/docs/bb-script.PNG b/docs/bb-script.PNG
diff --git a/docs/bb-service.PNG b/docs/bb-service.PNG
diff --git a/docs/bb-timer.PNG b/docs/bb-timer.PNG