Merge main branch. Refine release docs

Author: fernandinand

.github/workflows/checks.yml

@@ -7,11 +7,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-
-    # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED
     - uses: actions/setup-node@v3
       with:
-        node-version: 16
+        node-version: 20
 
     - name: Generate dist
       run: |
@@ -33,12 +31,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-
-    # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED
     - uses: actions/setup-node@v3
       with:
-        node-version: 16
-
+        node-version: 20
+        cache: 'yarn'
     - name: Generate dist
       run: |
         yarn install

.github/workflows/dist-dev.yml

@@ -8,6 +8,7 @@ on:
     paths-ignore:
       - 'scripts/**'
       - 'README.md'
+  workflow_dispatch:
 
 concurrency: 
   group: dist-dev-${{ github.head_ref }}
@@ -18,18 +19,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-
-    # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED
     - uses: actions/setup-node@v3
       with:
-        node-version: 16
+        node-version: 20
+        cache: 'yarn'
 
     - name: Install
       run: |
        yarn install
 
     - name: Generate dist
+      env:
+          SMARTLOOK_KEY: ${{ secrets.SMARTLOOK_KEY }}
       run: |
+        echo "VITE_SMARTLOOK_KEY=$SMARTLOOK_KEY" > ./src/.env
         yarn build
 
     - name: "Check dist dir consistency"

.github/workflows/dist-prod.yml

@@ -15,18 +15,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-
-    # need Node 16 or less to get rid of ERR_OSSL_EVP_UNSUPPORTED
     - uses: actions/setup-node@v3
       with:
-        node-version: 16
+        node-version: 20
+        cache: 'yarn'
 
     - name: Install
       run: |
        yarn install
 
     - name: Generate dist
+      env:
+          SMARTLOOK_KEY: ${{ secrets.SMARTLOOK_KEY }}
       run: |
+        echo "VITE_SMARTLOOK_KEY=$SMARTLOOK_KEY" > ./src/.env
         yarn build
 
     - name: "Check dist dir consistency"

.gitignore

@@ -18,4 +18,7 @@ git-output.txt
 .node-version
 .vscode
 *-snippet.txt
-redirect_test.txt
+redirect_test.txt
+
+src/.vitepress/cache
+src/.vitepress/dist

README.md

@@ -17,7 +17,7 @@ Use GitHub Pull Requests to propose changes, we will review and merge your chang
 - Check official [vuepress documentation](https://vuepress.vuejs.org/)
 - Check the [Mergin Maps Documentation Guidelines](https://merginmaps.com/docs/misc/write-docs/)
 
-<div><img align="left" width="45" height="45" src="https://raw.githubusercontent.com/MerginMaps/docs/main/src/.vuepress/public/slack.svg"><a href="https://merginmaps.com/community/join">Join our community chat</a><br/>and ask questions!</div>
+<div><img align="left" width="45" height="45" src="https://raw.githubusercontent.com/MerginMaps/docs/main/src/public/slack.svg"><a href="https://merginmaps.com/community/join">Join our community chat</a><br/>and ask questions!</div>
 
 # Development
 
@@ -49,6 +49,8 @@ You can also spin-up a node Docker container using the provided compose file
 docker compose up mm-docs
 ```
 
+The minimum required version of Node.js is 18.
+
 ## Translations
 
 At the moment we do not support translations, see https://github.com/MerginMaps/docs/issues/133
@@ -65,20 +67,6 @@ yarn build
 
 and see the result in `dist` folder
 
-### Error for nodejs 17
-
-If you get `opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ]`, run
- ```bash
- export NODE_OPTIONS=--openssl-legacy-provider
- ```
- 
- or on Windows
- ```bash
- set NODE_OPTIONS=--openssl-legacy-provider
- ```
-  
- or downgrade `nodejs` to 16 or less. More here: https://github.com/webpack/webpack/issues/14532
-
 # License
 
 The Mergin Maps product documentation in the `src` are licensed under a [CC-BY license](LICENSE).

REDIRECTS

@@ -180,6 +180,7 @@ https://merginmaps.com/docs/manage/plugin-sync-project/	https://merginmaps.com/d
 https://merginmaps.com/docs/misc/privacy/	N/A -- handled by https://merginmaps.com/privacy-policy/
 https://merginmaps.com/docs/reference/licensing/	https://merginmaps.com/docs/misc/licensing/
 https://merginmaps.com/docs/reference/privacy/	N/A -- handled by https://merginmaps.com/privacy-policy/
+https://merginmaps.com/docs/server/administer/environment/	https://merginmaps.com/docs/server/environment/
 https://merginmaps.com/docs/setup/install-input/	https://merginmaps.com/docs/setup/install-mobile-app/
 https://merginmaps.com/docs/setup/subscriptions/	https://merginmaps.com/docs/manage/subscriptions/
 https://merginmaps.com/docs/setup/working-with-organisations/	https://merginmaps.com/docs/manage/workspaces/

docker-compose.yml

@@ -1,7 +1,7 @@
 
 services:
   mm-docs:
-    image: node:16-alpine
+    image: node:20-alpine
     restart: on-failure
     volumes:
       - .:/docs

package.json

@@ -10,20 +10,18 @@
   },
   "repository": "merginmaps/docs",
   "scripts": {
-    "dev": "vuepress dev src",
-    "build": "vuepress build src",
-    "export": "vuepress export src"
+    "dev": "vitepress dev src",
+    "build": "vitepress build src",
+    "preview": "vitepress preview src"
   },
   "devDependencies": {
-    "@vuepress/plugin-medium-zoom": "^1.9.8",
-    "sass": "^1.62.1",
-    "sass-loader": "10",
-    "vuepress": "^1.9.8",
-    "vuepress-plugin-clean-urls": "^1.1.2",
-    "vuepress-plugin-fulltext-search": "^2.2.1"
+    "sass": "^1.86.0",
+    "vitepress": "^1.6.3",
+    "vitepress-plugin-image-viewer": "^1.1.6",
+    "vue": "^3.5.13"
   },
   "dependencies": {
-    "@gtm-support/vue2-gtm": "1.0.0",
+    "@gtm-support/vue-gtm": "^3.1.0",
     "smartlook-client": "^10.0.0"
   }
 }

scripts/check-redirects/main.py

@@ -44,8 +44,9 @@ def slashify(url):
     return path
 
 page_extension = '.md'
-iamge_extensions = ['.jpg', '.png', '.gif', '.xcf']
+iamge_extensions = ['.jpg', '.png', '.gif', '.xcf', '.svg', '.ico']
 data_extensions = ['.json', '.zip']
+vue_extensions = ['.vue', '.js', '.ts']
 
 deleted_pages = []
 renamed_pages_or_data_files = []
@@ -63,7 +64,7 @@ def slashify(url):
                 deleted_pages.append(line_parts[1].strip())
         elif status[0] == 'R':
             old_filename, file_extension = os.path.splitext(line_parts[1])
-            if file_extension.strip() not in iamge_extensions:
+            if file_extension.strip() not in iamge_extensions + vue_extensions + data_extensions:
                 renamed_pages_or_data_files.append( (line_parts[1].strip(),line_parts[2].strip()) )
                 if file_extension not in captured_exts:
                     captured_exts.append(file_extension)

scripts/unreferenced_images.bash

@@ -13,7 +13,7 @@ stringarray=($PICS)
 for i in "${stringarray[@]}"
 do 
   bi="$(basename -- $i)"    
-  A1=`grep -rn "$bi" $SRC_DIR --include \*.md --include \*.vue --include \*.styl --include="config.js"`
+  A1=`grep -rn "$bi" $SRC_DIR --include \*.md --include \*.vue --include \*.styl --include="config.mts"`
   if [ ! -z "$A1" ]
   then
    USED_PICS=$((USED_PICS + 1))