Prepare for deployment

.docker/Dockerfile

@@ -0,0 +1,6 @@
+FROM datajoint/miniconda3:4.10.3-py3.9-alpine
+WORKDIR /main
+COPY --chown=anaconda:anaconda ./.docker/pip_requirements.txt ${PIP_REQUIREMENTS}
+RUN /entrypoint.sh echo "Dependencies installed"
+COPY --chown=anaconda:anaconda ./mkdocs.yaml /main/mkdocs.yaml
+COPY --chown=anaconda:anaconda ./src /main/src

.docker/pip_requirements.txt

@@ -0,0 +1,3 @@
+mkdocs-material
+mkdocs-redirects
+mdx_truly_sane_lists

.github/workflows/development.yml

@@ -4,12 +4,32 @@ on:
     branches:
       - main
 jobs:
-  deploy:
+  deploy-docs:
     runs-on: ubuntu-latest
+    env:
+      DOCKER_CLIENT_TIMEOUT: "120"
+      COMPOSE_HTTP_TIMEOUT: "120"
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - name: Compile docs static artifacts
+        run: |
+          MODE=BUILD HOST_UID=$(id -u) docker-compose up --exit-code-from docs --build
+      - name: Commit documentation changes
+        run: |
+          git clone https://github.com/${GITHUB_REPOSITORY}.git \
+              --branch gh-pages --single-branch gh-pages
+          rm -R gh-pages/*
+          cp -r site/* gh-pages/
+          cd gh-pages
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add . --all
+          git commit -m "Update documentation" -a || true
+          # The above command will fail if no changes were present, so we ignore
+          # the return code.
+      - name: Push changes
+        uses: ad-m/github-push-action@master
         with:
-          python-version: 3.x
-      - run: pip install mkdocs-material
-      - run: mkdocs gh-deploy --force
+          branch: gh-pages
+          directory: gh-pages
+          github_token: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1 @@
+site

README.md

@@ -1 +1,15 @@
-# documentation
+# DataJoint Documentation
+
+This is the home for all DataJoint's open-source and commercial documentation.
+
+## Test Locally
+
+To run locally, ensure you have `Docker` and `Docker Compose` installed.
+
+Then run the following:
+
+`MODE="LIVE" HOST_UID=$(id -u) docker compose up --build`
+
+Navigate to `http://localhost/` to preview the changes.
+
+This setup supports live-reloading so all that is needed is to save the markdown files and/or `mkdocs.yaml` file to trigger a reload.

docker-compose.yaml

@@ -0,0 +1,30 @@
+# MODE="LIVE|BUILD" HOST_UID=$(id -u) docker compose up --build
+# 
+# Navigate to http://localhost/
+version: "2.4"
+services:
+  docs:
+    build:
+      dockerfile: .docker/Dockerfile
+      context: .
+    image: datajoint/documentation
+    environment:
+      - MODE
+    volumes:
+      - .:/main
+    user: ${HOST_UID}:anaconda
+    ports:
+      - 80:80
+    command:
+      - sh
+      - -c
+      - |
+        set -e
+        if echo "$${MODE}" | grep -i live &>/dev/null; then
+            mkdocs serve --config-file ./mkdocs.yaml -a 0.0.0.0:80
+        elif echo "$${MODE}" | grep -i build &>/dev/null; then
+            mkdocs build --config-file ./mkdocs.yaml
+        else
+            echo "Unexpected mode..."
+            exit 1
+        fi