From bf6aa18f0b6df03b929bbd5a378c8bc0900d5156 Mon Sep 17 00:00:00 2001 From: francav Date: Mon, 29 Apr 2024 09:45:54 +0100 Subject: [PATCH] moving docs into project repo and updating CI/CD --- .github/workflows/build.yml | 3 +- .github/workflows/docs_deploy.yml | 36 + apps/react/docs/.gitignore | 30 + apps/react/docs/Makefile | 7 + apps/react/docs/README.md | 41 + apps/react/docs/babel.config.js | 3 + .../docs/01-Introduction/01-intro-video.mdx | 29 + .../02-platform-architecture.mdx | 82 + .../react/docs/docs/01-Introduction/index.mdx | 18 + .../react/docs/docs/02-Installation/index.mdx | 235 + .../.05-Case Instance/.01-case-details | 4 + .../.05-Case Instance/.02-case-tasks | 4 + .../.05-Case Instance/.03-case-comments | 4 + .../.05-Case Instance/.04-case-documents | 4 + .../.05-Case Instance/.04-case-emails | 4 + .../.05-creating-case-instance | 4 + .../.05-Case Instance/.index | 4 + .../.03-creating-process-definitions | 4 + .../.04-camunda-external-tasks | 4 + .../02-bpmn-dmn-modeler | 45 + .../01-BPM & Process Definition/index.mdx | 56 + .../02-Process Instance/index.mdx | 50 + .../03-Forms/.01-form-designer | 4 + .../docs/03-Working on ACM/03-Forms/index.mdx | 24 + .../04-Case Definition/.01-stages.mdx | 4 + .../.02-events-listeners.mdx | 4 + .../04-Case Definition/.03-queues.mdx | 4 + .../.04-creating-case-definitions.mdx | 44 + .../04-Case Definition/index.mdx | 41 + .../06-Tasks/.01-process-tasks | 4 + .../06-Tasks/.02-ad-hoc-tasks | 4 + .../06-Tasks/.03-working-on-case-tasks | 4 + .../docs/03-Working on ACM/06-Tasks/.index | 4 + .../docs/docs/03-Working on ACM/index.mdx | 22 + .../docs/04-System Notifications/index.mdx | 37 + apps/react/docs/docs/05-REST API/index.mdx | 24 + apps/react/docs/docusaurus.config.js | 169 + apps/react/docs/package.json | 47 + apps/react/docs/sidebars.js | 34 + .../docs/src/components/Config/index.tsx | 27 + .../src/components/HomepageFeatures/index.tsx | 61 + .../HomepageFeatures/styles.module.css | 11 + apps/react/docs/src/css/custom.css | 46 + apps/react/docs/src/pages/index.module.css | 23 + apps/react/docs/src/pages/index.tsx | 43 + apps/react/docs/src/pages/markdown-page.md | 7 + apps/react/docs/static/.nojekyll | 0 .../img/WKS-Platform-Architecture.excalidraw | 2174 ++ .../static/img/WKS-Platform-Novu.excalidraw | 18668 ++++++++++++++++ .../docs/static/img/camunda-logo-dark.svg | 1 + apps/react/docs/static/img/chamaleon.svg | 76 + apps/react/docs/static/img/docusaurus.png | Bin 0 -> 5142 bytes apps/react/docs/static/img/favicon.ico | Bin 0 -> 169256 bytes apps/react/docs/static/img/lightbulb.png | Bin 0 -> 16885 bytes apps/react/docs/static/img/logo.svg | 1 + apps/react/docs/static/img/padlock.svg | 56 + .../static/img/undraw_docusaurus_mountain.svg | 171 + .../static/img/undraw_docusaurus_react.svg | 170 + .../static/img/undraw_docusaurus_tree.svg | 40 + .../static/img/wks-platform-architecture.svg | 17 + apps/react/docs/static/js/gtag.js | 5 + apps/react/docs/yarn.lock | 7855 +++++++ 62 files changed, 30595 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/docs_deploy.yml create mode 100644 apps/react/docs/.gitignore create mode 100644 apps/react/docs/Makefile create mode 100644 apps/react/docs/README.md create mode 100644 apps/react/docs/babel.config.js create mode 100644 apps/react/docs/docs/01-Introduction/01-intro-video.mdx create mode 100644 apps/react/docs/docs/01-Introduction/02-platform-architecture.mdx create mode 100644 apps/react/docs/docs/01-Introduction/index.mdx create mode 100644 apps/react/docs/docs/02-Installation/index.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/.05-Case Instance/.01-case-details create mode 100644 apps/react/docs/docs/03-Working on ACM/.05-Case Instance/.02-case-tasks create mode 100644 apps/react/docs/docs/03-Working on ACM/.05-Case Instance/.03-case-comments create mode 100644 apps/react/docs/docs/03-Working on ACM/.05-Case Instance/.04-case-documents create mode 100644 apps/react/docs/docs/03-Working on ACM/.05-Case Instance/.04-case-emails create mode 100644 apps/react/docs/docs/03-Working on ACM/.05-Case Instance/.05-creating-case-instance create mode 100644 apps/react/docs/docs/03-Working on ACM/.05-Case Instance/.index create mode 100644 apps/react/docs/docs/03-Working on ACM/01-BPM & Process Definition/.03-creating-process-definitions create mode 100644 apps/react/docs/docs/03-Working on ACM/01-BPM & Process Definition/.04-camunda-external-tasks create mode 100644 apps/react/docs/docs/03-Working on ACM/01-BPM & Process Definition/02-bpmn-dmn-modeler create mode 100644 apps/react/docs/docs/03-Working on ACM/01-BPM & Process Definition/index.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/02-Process Instance/index.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/03-Forms/.01-form-designer create mode 100644 apps/react/docs/docs/03-Working on ACM/03-Forms/index.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/04-Case Definition/.01-stages.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/04-Case Definition/.02-events-listeners.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/04-Case Definition/.03-queues.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/04-Case Definition/.04-creating-case-definitions.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/04-Case Definition/index.mdx create mode 100644 apps/react/docs/docs/03-Working on ACM/06-Tasks/.01-process-tasks create mode 100644 apps/react/docs/docs/03-Working on ACM/06-Tasks/.02-ad-hoc-tasks create mode 100644 apps/react/docs/docs/03-Working on ACM/06-Tasks/.03-working-on-case-tasks create mode 100644 apps/react/docs/docs/03-Working on ACM/06-Tasks/.index create mode 100644 apps/react/docs/docs/03-Working on ACM/index.mdx create mode 100644 apps/react/docs/docs/04-System Notifications/index.mdx create mode 100644 apps/react/docs/docs/05-REST API/index.mdx create mode 100644 apps/react/docs/docusaurus.config.js create mode 100644 apps/react/docs/package.json create mode 100644 apps/react/docs/sidebars.js create mode 100644 apps/react/docs/src/components/Config/index.tsx create mode 100644 apps/react/docs/src/components/HomepageFeatures/index.tsx create mode 100644 apps/react/docs/src/components/HomepageFeatures/styles.module.css create mode 100644 apps/react/docs/src/css/custom.css create mode 100644 apps/react/docs/src/pages/index.module.css create mode 100644 apps/react/docs/src/pages/index.tsx create mode 100644 apps/react/docs/src/pages/markdown-page.md create mode 100644 apps/react/docs/static/.nojekyll create mode 100644 apps/react/docs/static/img/WKS-Platform-Architecture.excalidraw create mode 100644 apps/react/docs/static/img/WKS-Platform-Novu.excalidraw create mode 100644 apps/react/docs/static/img/camunda-logo-dark.svg create mode 100644 apps/react/docs/static/img/chamaleon.svg create mode 100644 apps/react/docs/static/img/docusaurus.png create mode 100644 apps/react/docs/static/img/favicon.ico create mode 100644 apps/react/docs/static/img/lightbulb.png create mode 100644 apps/react/docs/static/img/logo.svg create mode 100644 apps/react/docs/static/img/padlock.svg create mode 100644 apps/react/docs/static/img/undraw_docusaurus_mountain.svg create mode 100644 apps/react/docs/static/img/undraw_docusaurus_react.svg create mode 100644 apps/react/docs/static/img/undraw_docusaurus_tree.svg create mode 100644 apps/react/docs/static/img/wks-platform-architecture.svg create mode 100644 apps/react/docs/static/js/gtag.js create mode 100644 apps/react/docs/yarn.lock diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 63df40e0..a54c6502 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,8 +3,7 @@ name: Build artifacts on: push: branches: - - main - - develop + - "**" workflow_dispatch: env: diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml new file mode 100644 index 00000000..375411d2 --- /dev/null +++ b/.github/workflows/docs_deploy.yml @@ -0,0 +1,36 @@ +name: deploy + +on: + push: + branches: + - main + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + + steps: + - uses: actions/checkout@v3 + + - name: install dependencies + run: yarn --cwd apps/react/docs install + + - name: build website + run: PROD=true GTAG_ID=${{ secrets.GTAG_ID }} yarn --cwd apps/react/docs docusaurus build + + - name: Set AWS credentials + uses: aws-actions/configure-aws-credentials@v1 + with: + aws-access-key-id: ${{ secrets.AWS_S3_DOCS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_S3_DOCS_SECRET_ACCESS_KEY }} + aws-region: us-east-1 + + - name: S3 Publisher + uses: osiegmar/s3-publisher-action@v1 + with: + bucket: ${{ secrets.AWS_S3_DOCS_BUCKET }} + dir: build + delete-orphaned: true diff --git a/apps/react/docs/.gitignore b/apps/react/docs/.gitignore new file mode 100644 index 00000000..e2acb6b4 --- /dev/null +++ b/apps/react/docs/.gitignore @@ -0,0 +1,30 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +.env + +.docusaurus + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# production +/build + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* +/.idea/ + +.vscode \ No newline at end of file diff --git a/apps/react/docs/Makefile b/apps/react/docs/Makefile new file mode 100644 index 00000000..3c3e8b78 --- /dev/null +++ b/apps/react/docs/Makefile @@ -0,0 +1,7 @@ +default: install start + +install: + @npm install + +start: + @PORT=3003 npm start \ No newline at end of file diff --git a/apps/react/docs/README.md b/apps/react/docs/README.md new file mode 100644 index 00000000..aaba2fa1 --- /dev/null +++ b/apps/react/docs/README.md @@ -0,0 +1,41 @@ +# Website + +This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. + +### Installation + +``` +$ yarn +``` + +### Local Development + +``` +$ yarn start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +### Build + +``` +$ yarn build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +### Deployment + +Using SSH: + +``` +$ USE_SSH=true yarn deploy +``` + +Not using SSH: + +``` +$ GIT_USER= yarn deploy +``` + +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. diff --git a/apps/react/docs/babel.config.js b/apps/react/docs/babel.config.js new file mode 100644 index 00000000..e00595da --- /dev/null +++ b/apps/react/docs/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + presets: [require.resolve('@docusaurus/core/lib/babel/preset')], +}; diff --git a/apps/react/docs/docs/01-Introduction/01-intro-video.mdx b/apps/react/docs/docs/01-Introduction/01-intro-video.mdx new file mode 100644 index 00000000..bb898269 --- /dev/null +++ b/apps/react/docs/docs/01-Introduction/01-intro-video.mdx @@ -0,0 +1,29 @@ +--- +id: intro-video +title: Introduction Video +--- + +export const Video = () => ( +
+ + +
+); + +