Docs

.github/workflows/doc-build.yaml

@@ -0,0 +1,70 @@
+name: Build pg_tde documentation
+on:
+  push:
+    branches: 
+      - main
+      - Docs
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+
+    steps: 
+      #Pull the latest changes
+      - name: Chekout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      #Prepare the env
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+
+      #Configure git
+      - name: Configure git
+        env:
+          ROBOT_TOKEN: ${{ secrets.ROBOT_TOKEN }}
+        run: |
+          git config --global url."https://percona-platform-robot:${ROBOT_TOKEN}@github.com".insteadOf "https://github.com"
+          git config user.name "GitHub Action"
+          git config user.email "[email protected]"
+          git config user.password "${ROBOT_TOKEN}"
+          echo "GIT_USER=percona-platform-robot:${ROBOT_TOKEN}" >> $GITHUB_ENV
+
+      #Set up MkDocs
+      - name: Install MkDocs
+        run: |
+          cd documentation
+          python -m pip install --upgrade pip
+          pip install wheel
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+
+
+
+     # Deploy docs
+      - name: Deploy docs
+        run: |
+          cd documentation
+          mike deploy main -p
+          mike set-default main -p
+          mike retitle main "MVP" -p
+
+
+# - name: Install Node.js 14.x
+#        uses: percona-platform/setup-node@v2
+#        with:
+#          node-version: "14"
+#
+#      - name: Spelling
+#        run: |
+#          npx markdown-spellcheck --report --en-us --ignore-acronyms --ignore-numbers "docs/**/*.md" || true
+          # Ignore errors, just inspect results
+#      - name: Grammar
+#        run: |
+#          npx write-good --no-passive docs/**/*.md || true
+#          # Ignore errors, just inspect results
+
+

README.md

@@ -7,7 +7,7 @@ This is an `experimental` encrypted access method for PostgreSQL 16.
 To download the latest build of the main branch, use the `HEAD` release from [releases](https://github.com/Percona-Lab/postgres-tde-ext/releases).
 
 Builds are available in a tar.gz format, containing only the required files, and as a deb package.
-The deb package is built againts the pgdg16 release, but this dependency is not yet enforced in the package.
+The deb package is built against the pgdg16 release, but this dependency is not yet enforced in the package.
 
 ## Installation steps