feat!: upgrade to VuePress 2

.github/workflows/child_repo.workflow.yml

@@ -14,15 +14,15 @@ on:
         required: true
 
 env:
-  NODE_VERSION: 16
+  NODE_VERSION: 20
 
 jobs:
   dead-links:
     name: Check the dead-links on the repo
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Output event inputs for debug
         run: echo "Repo ${{ github.event.inputs.repo_name }} triggered this workflow from branch ${{ github.event.inputs.branch }} v${{ github.event.inputs.version }}"
@@ -34,14 +34,15 @@ jobs:
           name: id_rsa
           known_hosts: unnecessary
 
-      - name: Setup Node JS
-        uses: actions/setup-node@v3
+      - name: Set up Node
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
 
       # Dead links does not work because of private template
       # From iot platform
-      # - name: Check dead links 
+      # - name: Check dead links
       #   uses: ./.github/actions/dead-links
       #   with:
       #     repo_name: ${{ github.event.inputs.repo_name }}
@@ -50,16 +51,17 @@ jobs:
 
   deploy:
     name: Deploy the repo
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     needs: [dead-links]
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup Node JS
-        uses: actions/setup-node@v3
+      - name: Set up Node
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
 
       - name: Install SSH key
         uses: shimataro/ssh-key-action@v2

.github/workflows/dead_links.workflow.yml

@@ -14,15 +14,15 @@ on:
         required: true
 
 env:
-  NODE_VERSION: 16
+  NODE_VERSION: 20
 
 jobs:
   dead-links:
     name: Check the dead-links on the repo
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Output event inputs for debug
         run: echo "Repo ${{ github.event.inputs.repo_name }} triggered this workflow from branch ${{ github.event.inputs.branch }} v${{ github.event.inputs.version }}"
@@ -34,10 +34,11 @@ jobs:
           name: id_rsa
           known_hosts: unnecessary
 
-      - name: Setup Node JS
-        uses: actions/setup-node@v3
+      - name: Set up Node
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
 
       - name: Check dead links
         uses: ./.github/actions/dead-links

.github/workflows/deploy_whole_doc.yml

@@ -8,24 +8,23 @@ on:
   workflow_dispatch:
 
 env:
-  NODE_VERSION: 16
+  NODE_VERSION: 20
 
 jobs:
   prepare-matrix:
     name: Prepare matrix by getting the repo names from repositories.json
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+        uses: actions/checkout@v4
 
       - name: Install yq
         run: |
           sudo apt-get update
           sudo apt-get install python python3-pip
           pip3 install yq
         shell: bash
+
       - name: Get repo names
         id: set-matrix
         run: |
@@ -36,32 +35,21 @@ jobs:
 
   deploy_framework:
     name: Deploy framework
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     env:
       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
       AWS_DEFAULT_REGION: us-west-1
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Cache node modules
-        uses: actions/cache@v2
-        env:
-          cache-name: cache-node-modules
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
-
-      - name: Install Node JS
-        uses: actions/setup-node@v3
+      - name: Set up Node
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
-
+          cache: 'npm'
+
       - name: Deploy artefact for production
         uses: ./.github/actions/deploy_fw_artifacts
         if: ${{ github.ref == 'refs/heads/master' }}
@@ -79,34 +67,23 @@ jobs:
   deploy_child_repo:
     name: Deploy child repo ${{ matrix.repo.repo_name }}-${{ matrix.repo.doc_version }}
     needs: [prepare-matrix, deploy_framework]
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
         repo: ${{ fromJson(needs.prepare-matrix.outputs.matrix) }}
       fail-fast: false
     steps:
       - name: Recap of the build
         run: echo "Build and deploy documentation for ${{ matrix.repo.repo_name }}-${{ matrix.repo.doc_version }}"
-
-      - name: Checkout
-        uses: actions/checkout@v2
 
-      - name: Cache node modules
-        uses: actions/cache@v2
-        env:
-          cache-name: cache-node-modules
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
+      - name: Checkout
+        uses: actions/checkout@v4
 
-      - name: Checkout repository
-        uses: actions/setup-node@v3
+      - name: Set up Node
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
 
       - name: Install SSH key
         uses: shimataro/ssh-key-action@v2
@@ -146,7 +123,7 @@ jobs:
   invalidate_cloudfront:
     name: Invalidate CloudFront
     needs: [deploy_child_repo]
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     env:
       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -155,6 +132,7 @@ jobs:
       - name: Invalidate CloudFront for next-docs.kuzzle.io
         if: ${{ github.ref != 'refs/heads/master' }}
         run: aws cloudfront create-invalidation --distribution-id E2ZCCEK9GRB49U --paths "/*"
+
       - name: Invalidate CloudFront for docs.kuzzle.io
         if: ${{ github.ref == 'refs/heads/master' }}
         run: aws cloudfront create-invalidation --distribution-id E3D6RP0POLCJMM --paths "/*"

.gitignore

@@ -1,15 +1,20 @@
 /.idea
+.DS_Store
 node_modules
 dist
 algolia-records.json
 frontmatter-errors.json
 frontmatter-fixes.json
 dead_links.json
 .vscode
+.cache
+.temp
 
 .repos/plugin*
 .repos/sdk-*
 .repos/kuzzle*
 .repos/paas*
+.repos/iot-platform*
 
 version.md
+frontmatter-lint-errors.json