chore(ci): fix deploy ci for 2.6

Signed-off-by: Swilder-M <[email protected]>

.github/scripts/directory_check.py

@@ -2,6 +2,7 @@
 import sys
 import json
 import re
+from urllib.parse import urlparse
 
 directory_file = sys.argv[1]
 docs_path = sys.argv[2]
@@ -17,13 +18,21 @@ def check_md_content(md_file):
         return
 
     md_content = re.sub(r'<!--([\s\S]*?)-->', '', open(md_file, 'r').read())
+
+    if 'ee' in directory_file:
+        md_content = re.sub(r'{% emqxce %}([\s\S]*?){% endemqxce %}', '', md_content)
+    else:
+        md_content = re.sub(r'{% emqxee %}([\s\S]*?){% endemqxee %}', '', md_content)
+
     image_list = re.findall('(.*?)!\[(.*?)\]\((.*?)\)', md_content)
     url_list = re.findall('(.*?)\[(.*?)\]\((.*?)\)', md_content)
     for url in url_list:
         if url[0].endswith('!'):
             continue
         if url[2].startswith(('http://', 'https://', '<', '#', 'mailto:', 'tel:')):
             continue
+        if urlparse(url[2]).path.endswith('.html'):
+            continue
         url_path = url[2].split('.md')[0]
         ref_md_path = os.path.join(f'{"/".join(md_file.split("/")[:-1])}/', f'{url_path}.md')
 
@@ -56,7 +65,7 @@ def get_md_files(dir_config, path):
             if md_name.startswith(('http://', 'https://')):
                 continue
             elif md_name == './':
-                md_list.append(f'{docs_path}/{path}/README.md')
+                md_list.append(f'{docs_path}/{path}/index.md')
             else:
                 md_list.append(f'{docs_path}/{path}/{md_name}.md')
 
@@ -83,8 +92,6 @@ def get_md_files(dir_config, path):
 
         for file in md_file_list:
             check_md_content(file)
-    else:
-        sys.exit(f'No {directory_file} file!')
 
     if not success:
         sys.exit('No pass!')

.github/scripts/remove_unused.py

@@ -10,7 +10,7 @@ def get_markdown_file(dir_config, base_path):
     for row in dir_config:
         if row.get('path'):
             current_files.append(
-                f'{base_path}/README.md' if row['path'] == './'
+                f'{base_path}/index.md' if row['path'] == './'
                 else f'{base_path}/{row["path"]}.md'
             )
         if row.get('children'):

.github/workflows/check_markdown.yaml

@@ -1,25 +1,25 @@
-name: Check markdown
+name: Check Docs
 
 on: [push, pull_request]
 
 jobs:
-  Markdown_Checker:
+  markdown_check:
     runs-on: ubuntu-latest
     steps:
-    - name: Check out code
+    - name: check out code
       uses: actions/checkout@main
-  
-    - name: Install markdownlint
+
+    - name: install markdownlint
       run: sudo npm install -g markdownlint-cli
 
-    - name: Check markdown
+    - name: check markdown
       run: markdownlint -c .github/workflows/markdown_config.json ./
 
-  Directory_Checker:
+  directory_check:
     runs-on: ubuntu-latest
     steps:
-    - name: Check out code
+    - name: check out code
       uses: actions/checkout@main
-  
-    - name: Check directory config
+
+    - name: check directory config
       run: python3 .github/scripts/directory_check.py directory.json $(pwd)

.github/workflows/deploy_docs.yaml

@@ -1,7 +1,7 @@
 name: Deploy Docs
 
 concurrency: 
-  group: ${{ github.ref }}
+  group: ${{ github.ref_name }}
   cancel-in-progress: true
 
 on:
@@ -17,28 +17,28 @@ jobs:
     if: github.repository_owner == 'emqx'
     steps:
     - name: clone docs
-      uses: actions/checkout@v2
+      uses: actions/checkout@main
       with:
         fetch-depth: 0
         path: docs-files
 
     - name: clone frontend
-      uses: actions/checkout@v2
+      uses: actions/checkout@main
       with:
-        repository: 'emqx/emqx-io-docs-frontend'
+        repository: 'emqx/docs-emqx-com-frontend'
+        ref: next
         token: ${{ secrets.CI_GIT_TOKEN }}
         path: frontend
 
     - name: use node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
-        node-version: 14.15
+        node-version-file: 'frontend/.nvmrc'
 
-    - name: use python
-      uses: actions/setup-python@v2
+    - name: use pnpm
+      uses: pnpm/action-setup@v4
       with:
-        python-version: '3.8'
-        architecture: 'x64'
+        version: 8
 
     - name: set env
       run: |
@@ -59,51 +59,66 @@ jobs:
 
     - name: move files
       run: |
-        rm frontend/docs/en/README.md || true
-        rm frontend/docs/zh/README.md || true
+        rm frontend/docs/en/index.md || true
+        rm frontend/docs/zh/index.md || true
         rm frontend/docs/*.md || true
-        rm frontend/README.md
-        mkdir -p frontend/docs/en/${VERSION}/
-        mkdir -p frontend/docs/zh/${VERSION}/
-        mkdir -p frontend/docs/.vuepress/public/api/
-        cp -r docs-files/en_US/* frontend/docs/en/${VERSION}/
-        cp -r docs-files/zh_CN/* frontend/docs/zh/${VERSION}/
-        cp docs-files/directory.json frontend/docs/.vuepress/config/directory.json
+        rm frontend/index.md || true
+        mkdir -p frontend/docs/en/${DOCS_TYPE}/${VERSION}/
+        mkdir -p frontend/docs/zh/${DOCS_TYPE}/${VERSION}/
+        mkdir -p frontend/docs/public/api/
+        cp -r docs-files/en_US/* frontend/docs/en/${DOCS_TYPE}/${VERSION}/
+        cp -r docs-files/zh_CN/* frontend/docs/zh/${DOCS_TYPE}/${VERSION}/
+        cp docs-files/directory.json frontend/docs/.vitepress/config/directory.json
 
     - name: generate version config
       run: |
         cd docs-files
-        python3 .github/scripts/generate_version.py $(git tag | egrep "v(.*)$" | xargs echo -n) > ../frontend/docs/.vuepress/public/api/${DOCS_TYPE}_versions.json
-        cat ../frontend/docs/.vuepress/public/api/${DOCS_TYPE}_versions.json
+        python3 .github/scripts/generate_version.py $(git tag | egrep "v(.*)$" | xargs echo -n) > ../frontend/docs/public/api/${DOCS_TYPE}_versions.json
+        cat ../frontend/docs/public/api/${DOCS_TYPE}_versions.json
 
     - name: build docs
       run: |
         cd frontend
-        yarn && yarn build
+        pnpm install
+        pnpm build
 
-    - name: upload dist
+    - name: set aws credentials
+      uses: aws-actions/configure-aws-credentials@v4
+      with:
+        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        aws-region: ${{ secrets.AWS_DEFAULT_REGION }}
+
+    - name: upload dist to s3
+      run: |
+        aws s3 rm --recursive s3://docs-emqx-com/zh/${DOCS_TYPE}/${VERSION} || true
+        aws s3 rm --recursive s3://docs-emqx-com/en/${DOCS_TYPE}/${VERSION} || true
+        aws s3 cp --recursive frontend/docs/.vitepress/dist/ s3://docs-emqx-com/
+        aws cloudfront create-invalidation --distribution-id ${{ secrets.AWS_DOCS_CLOUDFRONT_ID }} --paths "/zh/${DOCS_TYPE}/${VERSION}/*" "/en/${DOCS_TYPE}/${VERSION}/*" "/api/${DOCS_TYPE}_versions.json" "/sitemap_${DOCS_TYPE}_${VERSION}.xml"
+
+    - name: upload dist to cos
       run: |
         pip3 install coscmd
-        coscmd config -a ${{ secrets.TENCENT_COS_ID }} -s ${{ secrets.TENCENT_COS_KEY }} -b neugates-io-1302406139 -r ap-hongkong
-        coscmd delete -r -f docs/en/${VERSION} || true
-        coscmd delete -r -f docs/zh/${VERSION} || true
-        coscmd config -a ${{ secrets.TENCENT_COS_ID }} -s ${{ secrets.TENCENT_COS_KEY }} -b neugates-io-1302406139 -e cos.accelerate.myqcloud.com
-        cd frontend/docs/.vuepress/
-        coscmd upload -r dist/ /docs/
-
-    - name: refresh cdn cache
+        coscmd config -a ${{ secrets.TENCENT_COS_ID }} -s ${{ secrets.TENCENT_COS_KEY }} -b docs-1302406139 -r ap-shanghai
+        coscmd delete -r -f en/${DOCS_TYPE}/${VERSION} || true
+        coscmd delete -r -f zh/${DOCS_TYPE}/${VERSION} || true
+        coscmd config -a ${{ secrets.TENCENT_COS_ID }} -s ${{ secrets.TENCENT_COS_KEY }} -b docs-1302406139 -e cos.accelerate.myqcloud.com
+        coscmd upload -r frontend/docs/.vitepress/dist/ /
+
+    - name: flush cdn
       run: |
         pip3 install tccli
         tccli configure set secretId ${{ secrets.TENCENT_COS_ID }}
         tccli configure set secretKey ${{ secrets.TENCENT_COS_KEY }}
-        tccli configure set region ap-hongkong
-        tccli cdn PurgePathCache --Paths '["https://neugates.io/docs/", "https://neuron-docs.emqx.net"]' --FlushType delete
+        tccli configure set region ap-shanghai
+        tccli cdn PurgePathCache --cli-unfold-argument --Paths https://docs.emqx.com/zh/${DOCS_TYPE}/${VERSION}/ https://docs.emqx.com/en/${DOCS_TYPE}/${VERSION}/ --FlushType delete
+        tccli cdn PurgeUrlsCache --cli-unfold-argument --Urls https://docs.emqx.com/api/${DOCS_TYPE}_versions.json https://docs.emqx.com/sitemap_${DOCS_TYPE}_${VERSION}.xml
 
     - name: update search index
-      uses: Swilder-M/docsearch-scraper-simple@v4
+      uses: Swilder-M/docsearch-scraper-simple@next
       env:
-        APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
-        API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
+        APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID_NEXT }}
+        API_KEY: ${{ secrets.ALGOLIA_API_KEY_NEXT }}
       with:
         docs_type: ${{ env.DOCS_TYPE }}
         docs_version: ${{ env.VERSION }}

.github/workflows/markdown_config.json

@@ -1,13 +1,13 @@
 {
-    "default": false,
-    "MD001": true,
-    "MD003": {"style": "atx"},
-    "MD011": true,
-    "MD018": true,
-    "MD019": true,
-    "MD023": true,
-    "MD025": {"level": 1, "front_matter_title": ""},
-    "MD042": true,
-    "MD046": {"style": "fenced"},
-    "MD048": {"style": "backtick"}
-  }
+  "default": false,
+  "MD001": true,
+  "MD003": {"style": "atx"},
+  "MD011": true,
+  "MD018": true,
+  "MD019": true,
+  "MD023": true,
+  "MD025": {"level": 1, "front_matter_title": ""},
+  "MD042": true,
+  "MD046": {"style": "fenced"},
+  "MD048": {"style": "backtick"}
+}

en_US/configuration/south-devices/bacnet-ip/bacnet-ip.md

@@ -42,7 +42,7 @@ For information on general configuration items, see [Connect to Southbound Devic
 
 ### Address Format
 
-> AREA ADDRESS(.PROPERTY_ID)</span>
+> AREA ADDRESS(.PROPERTY_ID)
 
 support Area
 

en_US/configuration/south-devices/ethernet-ip/ethernet-ip.md

@@ -52,7 +52,7 @@ For information on general configuration items, see [Connect to Southbound Devic
 
 ### Address Format
 
->  TAG NAME </span>
+>  TAG NAME 
 
 Connect to PLC with PLC software, the name of the point on the PLC is the address of the point in Neuron.
 

en_US/configuration/south-devices/file/file.md

@@ -18,7 +18,7 @@ File plugin is used to read or write files.
 
 ### Address Format
 
-> FILE PATH</span>
+> FILE PATH
 
 ### Address Example
 

en_US/configuration/south-devices/hj212-2017/hj212-2017.md

@@ -50,7 +50,7 @@ For information on general configuration items, see [Connect to Southbound Devic
 
 #### Pollutant Real-time Data
 
-> RT!xxxx-[Rtd\][Flag\][SampleTime\][EFlag]</span>
+> RT!xxxx-[Rtd\][Flag\][SampleTime\][EFlag]
 
 | Address              | Type   | Description                    |
 | -------------------- | ------ | ------------------------------ |

en_US/configuration/south-devices/modbus-tcp/modbus-tcp.md

@@ -67,7 +67,7 @@ For information on general configuration items, see [Connect to Southbound Devic
 
 ### Address format
 
-> SLAVE!ADDRESS\[.BIT][#ENDIAN]\[.LEN\[H]\[L]\[D]\[E]]</span>
+> SLAVE!ADDRESS\[.BIT][#ENDIAN]\[.LEN\[H]\[L]\[D]\[E]]
 
 #### **SLAVE**
 

en_US/configuration/south-devices/modbus/modbus-tcp.md

@@ -4,7 +4,7 @@
 
 Modbus is a communication protocol commonly used to connect industrial automation equipment and control systems, and it can be implemented on various physical and transport layers, including serial and Ethernet. Modbus TCP and Modbus RTU are two commonly used implementation methods.
 
-Modbus TCP uses Ethernet communication and is a protocol based on the TCP/IP protocol stack. In Neuron, the modbus-tcp and modbus-plus-tcp modules use the Modbus TCP protocol. When some devices that support Modbus RTU and other protocols need to be converted to Modbus TCP protocol for passthrough or similar functions, these two modules are also required.</br>
+Modbus TCP uses Ethernet communication and is a protocol based on the TCP/IP protocol stack. In Neuron, the modbus-tcp and modbus-plus-tcp modules use the Modbus TCP protocol. When some devices that support Modbus RTU and other protocols need to be converted to Modbus TCP protocol for passthrough or similar functions, these two modules are also required.<br />
 The difference between the two modules is that the modbus-tcp module is open source and does not require License authentication, while the modbus-plus-tcp module requires License authentication. The modbus-plus-tcp module supports configuring the Client/Server mode, as well as more data types, and also optimizes the read/write performance. Therefore, the functionality of the modbus-plus-tcp module is stronger than that of the modbus-tcp module. The modbus-tcp module is suitable for users who are familiar with the use of Neuron.
 
 ## Parameter Configuration
@@ -43,7 +43,7 @@ The difference between the two modules is that the modbus-tcp module is open sou
 
 ### Address Format
 
-> SLAVE!ADDRESS\[.BIT][#ENDIAN]\[.LEN\[H]\[L]\[D]\[E]]</span>
+> SLAVE!ADDRESS\[.BIT][#ENDIAN]\[.LEN\[H]\[L]\[D]\[E]]
 
 #### **SLAVE**
 

en_US/configuration/south-devices/opc-da/overview.md

@@ -42,7 +42,7 @@ The NeuOPC component packages can be downloaded from the [Project page](https://
 
 ## Address Format
 
-> IX!NODEID</span>
+> IX!NODEID
 
 **IX** Namespace index, IX can only be 2 when accessing NeuOPC.
 

en_US/dev-guide/dev-guide.md

@@ -96,7 +96,7 @@ $ python3 -m robot --maxerroelines=600 -P ft/ -d ft/reports ft
 3. Combining libasan runtime memory analysis, most memory issues can be resolved.
 
 :::tip
-Libasan refers to the Address Sanitizer (ASan) library, which is a memory error detection tool used to help detect memory errors during program execution, such as buffer overflows, using freed memory, and using uninitialized memory.</br>
-ASan detects memory errors by injecting additional code while the program is running. It uses a red and black tree data structure to track the allocation of memory blocks, and uses shadow memory to detect read and write access to unallocated memory. When a memory error is detected, ASan prints relevant information, such as the location and type of the error.</br>
+Libasan refers to the Address Sanitizer (ASan) library, which is a memory error detection tool used to help detect memory errors during program execution, such as buffer overflows, using freed memory, and using uninitialized memory.<br />
+ASan detects memory errors by injecting additional code while the program is running. It uses a red and black tree data structure to track the allocation of memory blocks, and uses shadow memory to detect read and write access to unallocated memory. When a memory error is detected, ASan prints relevant information, such as the location and type of the error.<br />
 Libasan is a runtime library for ASan that can be used with compilers, such as Clang, GCC, and so on. It provides the necessary functions and data structures to detect and report memory errors during program execution.
 :::

en_US/installation/installation.md

@@ -11,8 +11,8 @@ Neuron supports 32-bit/64-bit ARM and 64-bit x86 architectures on Linux-based op
 
 | Linux Distribution                                    | Required Package  |
 | ------------------------------------------------------------ | ------------------ |
-| Ubuntu 20.04 </br>Ubuntu 18.04 </br>Ubuntu16.04</br>Debian 11</br>Debian 10</br>Debian 9</br>Debian 8               | **Debian Software Package** (.deb)         |
-| CentOS Stream 9</br>CentOS Stream 8</br>CentOS 7    | **Redhat Package Manager** (.rpm)         |
+| Ubuntu 20.04 <br />Ubuntu 18.04 <br />Ubuntu16.04<br />Debian 11<br />Debian 10<br />Debian 9<br />Debian 8               | **Debian Software Package** (.deb)         |
+| CentOS Stream 9<br />CentOS Stream 8<br />CentOS 7    | **Redhat Package Manager** (.rpm)         |
 | Other Linux | **Tape Archiver** (tar.gz) |
 
 :::tip
@@ -36,15 +36,15 @@ The following table lists the hardware conditions required for the minimum deman
 :::tip
 Neuron has no upper limitation on the number of tags. It depends on the allocated CPU and memory resources. Neuron is very portable to run on limited resource like single board hardware, or on powerful servers. The following figures are the results of Neuron performance test for your reference and these benchmark results are still not the upper limits. A more powerful server can be used for more tags.
 
-Platform                         : Intel(R) Xeon(R) Gold [email protected]</br>
-Memory                           : 4G</br>
-Architecture                     : x86</br>
-OS Support                       : Ubuntu 20.04</br>
-No. of connections               : 1000 connections</br>
-No. of tags for each connection  : 300 tags</br>
-Total tags                       : 300,000 tags</br>
-Memory Usage                     : 300M</br>
-CPU Usage                        : 90%</br>
+Platform                         : Intel(R) Xeon(R) Gold [email protected]<br />
+Memory                           : 4G<br />
+Architecture                     : x86<br />
+OS Support                       : Ubuntu 20.04<br />
+No. of connections               : 1000 connections<br />
+No. of tags for each connection  : 300 tags<br />
+Total tags                       : 300,000 tags<br />
+Memory Usage                     : 300M<br />
+CPU Usage                        : 90%<br />
 
 :::
 

en_US/installation/neuron/compile.md

@@ -16,7 +16,7 @@ $ cmake .. && make
 :::tip
 There are three optional parameters in CMakeLists:
 * CMAKE_ BUILD_ Type "Debug", which compiles the debug version by default.
-* DISABLE_WERROR, which treats all warnings as errors.</br>Usage example:```cmake -DISABLE_WERROR=1 ..```
+* DISABLE_WERROR, which treats all warnings as errors.<br />Usage example:```cmake -DISABLE_WERROR=1 ..```
 * DISABLE_ ASAN, select whether to enable libasan memory detection.
 :::
 

en_US/usage/admin/log-management.md

@@ -83,7 +83,7 @@ format_name = "your format"
 Rules describe how logs are filtered, formatted, and outputted.
 Grammar:
 
-> (category).(level)    (output),(options, optional); (format name, optional)</span>
+> (category).(level)    (output),(options, optional); (format name, optional)
 
 #### category