Merge branch 'release/1.2.5'

.github/workflows/docs.yml

@@ -0,0 +1,73 @@
+name: Build the docs
+
+on:
+  push:
+    branches:
+      - develop
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Upgrade pip
+        run: |
+          # install pip=>20.1 to use "pip cache dir"
+          python3 -m pip install --upgrade pip
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('./docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: python3 -m pip install -r ./docs/requirements.txt
+
+      - name: Set git username and email
+        run: |
+          #
+          git config --global user.email "${GH_USERNAME}@users.noreply.github.com"
+          git config --global user.name "${GH_USERNAME}"
+        env:
+          GH_USERNAME: ${{ github.actor }}
+
+      - name: Pre-fetch the gh-pages branch
+        run: git fetch
+
+      - name: Build docs with MkDocs
+        run: mkdocs build
+
+      - name: Read the tag name
+        id: get_tag_name
+        if: startsWith(github.ref, 'refs/tags/')
+        run: echo ::set-output name=TAG_NAME::${GITHUB_REF/refs\/tags\//}
+
+      # This is for a tagged version
+      - name: Create a new version of documentation and push to GH pages.
+        if: startsWith(github.ref, 'refs/tags/')
+        run: mike deploy ${{ steps.get_tag_name.outputs.TAG_NAME }} stable --push --rebase
+
+      - name: Make stable to default.
+        if: startsWith(github.ref, 'refs/tags/')
+        run: mike set-default stable --push --rebase
+
+      # This is for develop
+      - name: Deploy latest develop snapshot docs to GH pages.
+        if: github.ref == 'refs/heads/develop'
+        run: mike deploy snapshot --push --rebase

.github/workflows/master.yml

@@ -49,11 +49,3 @@ jobs:
       env:
         OSS_CENTRAL_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
         OSS_CENTRAL_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
-
-    - name: Build and deploy site docs
-      run: ./mvnw -Pdeploy-docs -f docs -DgithubToken=${{secrets.GITHUB_TOKEN}}
-
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1.0.2
-      with:
-        token: ${{secrets.CODECOV_TOKEN}}

docs/assets/css/extra.css

@@ -0,0 +1,43 @@
+/*
+ * General customizations
+ */
+ /* Customize logo size */
+.md-header__button.md-logo img, .md-header__button.md-logo {
+  height: 15%;
+  width: 15%;
+}
+
+[data-md-color-scheme="default"] {
+  /*
+   Camunda colors
+   */
+   --camunda-orange-1: #f38a07;
+   --camunda-orange-2: #f27d06;
+   --camunda-orange-3: #f04609;
+   --monochrome-50: #7f7f7f;
+
+
+  /*
+   Default colors adjustments
+   */
+   --md-primary-fg-color: var(--monochrome-50);
+   --md-accent-fg-color: var(--camunda-orange-3);
+   --md-footer-bg-color: var(--camunda-orange-1);
+}
+
+[data-md-color-scheme="slate"] {
+  /*
+   Camunda colors
+   */
+  --camunda-orange-1: #f38a07;
+  --camunda-orange-2: #f27d06;
+  --camunda-orange-3: #f04609;
+
+
+  /*
+   Default colors adjustments
+   */
+  --md-primary-fg-color: var(--monochrome-50);
+  --md-accent-fg-color: var(--camunda-orange-3);
+  --md-footer-bg-color: var(--camunda-orange-1);
+}

docs/src/orchid/resources/wiki/developer-guide/contribution.md → docs/developer-guide/contribution.md

@@ -1,10 +1,3 @@
----
-title: Contribution
-pageId: 'contribution'
----
-
-## Contribution
-
 There are several ways in which you may contribute to this project.
 
 * File new issues if you found a bug or missing feature