Merge branch 'feature/website' into 'main'

Feature/Publish docs as website with Docusaurus

See merge request devpro-labs/enablement/tech-notes!6

Author: Bertrand Thomas

.github/workflows/ci.yml

@@ -1,14 +1,9 @@
 name: CI
 
 on:
-  # push:
-  #   branches:
-  #     - main
-  pull_request:
+  push:
     branches:
       - main
-  # schedule:
-  #   - cron: "0 2 * * 1-5"
   workflow_dispatch: {}
 
 env:
@@ -35,3 +30,7 @@ jobs:
       - name: Lint YAML files
         run: |
           yamllint .
+      - name: Install JavaScript dependencies
+        run: npm install
+      - name: Build website
+        run: npm run build

.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch: {}
+
+jobs:
+  build:
+    name: Build website
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install dependencies
+        run: npm install
+      - name: Build static files
+        run: npm run build
+      - name: Upload artifact for GitHub Pages
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,26 @@
+# local
+.DS_Store
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+*.local
+*.log*
+.docusaurus
+.cache-loader
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# dist
+/node_modules
+/dist
+/doc_build
+/build
+
+# IDE
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+.idea

.gitlab-ci.yml

@@ -20,3 +20,10 @@ lint-yaml:
   script:
     - pip install yamllint
     - yamllint .
+
+build-website:
+  stage: build
+  image: node:lts
+  script:
+    - npm install
+    - npm run build

.vscode/settings.json

@@ -1,3 +1,8 @@
 {
-  "files.eol": "\n"
+  "files.eol": "\n",
+  "files.exclude": {
+    "**/.docusaurus": true,
+    "**/doc_build": true,
+    "**/build": true
+  }
 }