docs: publish docs with docusaurus (#268)

Rework the documentation to be a static website instead of just the
GitHub README.md. Use docusaurus to create the website, and the CI to
publish to GitHub pages on commits to main.
Block `release-please` releases unless the documentation for that version
has been generated.

Closes #244

Signed-off-by: Francesco Canovai <[email protected]>
Signed-off-by: Gabriele Bartolini <[email protected]>
Co-authored-by: Leonardo Cecchi <[email protected]>
Co-authored-by: Gabriele Bartolini <[email protected]>

Author: 3 people

.github/workflows/publish-docs.yml

@@ -0,0 +1,64 @@
+# This workflow builds and deploys the Docusaurus documentation to GitHub Pages
+# when changes are pushed to the main branch.
+name: Deploy Docusaurus to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'web/docs/**'
+
+# Prevent parallel deployments when multiple commits are pushed to main
+# in a short time.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          # Use the latest LTS version of Node.js already installed on the runner.
+          node-version: latest
+          check-latest: 'false'
+          cache: yarn
+          cache-dependency-path: web/package-lock.json
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Install dependencies
+        working-directory: web
+        run: yarn install --frozen-lockfile --non-interactive
+
+      - name: Build website
+        working-directory: web
+        run: yarn build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: web/build
+
+  deploy:
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.wordlist.txt

@@ -3,6 +3,7 @@ BarmanObjectStore
 BarmanObjectStoreConfiguration
 BarmanObjectStores
 CloudNativePG
+Docusaurus
 EnvVar
 Gi
 IfNotPresent
@@ -13,6 +14,7 @@ ObjectStore
 ObjectStoreSpec
 ObjectStoreStatus
 PITR
+README
 RecoveryWindow
 RetentionPolicy
 ServerRecoveryWindow
@@ -42,12 +44,14 @@ gcs
 gf
 github
 hostpath
+http
 https
 imagePullPolicy
 io
 isWALArchiver
 kubectl
 kubernetes
+localhost
 md
 minio
 namespace