[Enhancement]: add md link check github action (#1320)

* add md link check action

* add config

* fix doc link

* fix dead links

* change dev-1.x to 1.x

* fix mmocr url

Author: RunningLeon

.github/ISSUE_TEMPLATE/1-bug-report.yml

@@ -9,7 +9,7 @@ body:
     label: Checklist
     options:
     - label: I have searched related issues but cannot get the expected help.
-    - label: 2. I have read the [FAQ documentation](https://github.com/open-mmlab/mmdeploy/blob/master/docs/en/faq.md) but cannot get the expected help.
+    - label: 2. I have read the [FAQ documentation](https://github.com/open-mmlab/mmdeploy/tree/1.x/docs/en/faq.md) but cannot get the expected help.
     - label: 3. The bug has not been fixed in the latest version.
 - type: textarea
   attributes:

.github/ISSUE_TEMPLATE/config.yml

@@ -2,7 +2,7 @@ blank_issues_enabled: false
 
 contact_links:
   - name: 💥 FAQ
-    url: https://github.com/open-mmlab/mmdeploy/blob/master/docs/en/faq.md
+    url: https://github.com/open-mmlab/mmdeploy/tree/1.x/docs/en/faq.md
     about: Check if your issue already has solutions
   - name: 💬 Forum
     url: https://github.com/open-mmlab/mmdeploy/discussions

.github/md-link-config.json

@@ -0,0 +1,33 @@
+{
+  "ignorePatterns": [
+
+    {
+      "pattern": "^https://developer.nvidia.com/"
+    },
+    {
+      "pattern": "^https://docs.openvino.ai/"
+    },
+    {
+      "pattern": "^https://developer.android.com/"
+    },
+    {
+      "pattern": "^https://developer.qualcomm.com/"
+    },
+    {
+      "pattern": "^http://localhost"
+    }
+  ],
+  "httpHeaders": [
+    {
+      "urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": true,
+  "retryCount": 5,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [200, 206, 429]
+}

.github/workflows/lint.yml

@@ -27,6 +27,15 @@ jobs:
         run: |
           python .github/scripts/check_index_rst.py docs/en/index.rst
           python .github/scripts/check_index_rst.py docs/zh_cn/index.rst
+      - name: Check markdown link
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+#          check-modified-files-only: 'yes'
+          config-file: '.github/md-link-config.json'
+          folder-path: 'docs/en, docs/zh_cn'
+          file-path: './README.md, ./LICENSE, ./README_zh-CN.md'
       - name: Check doc link
         run: |
           python .github/scripts/doc_link_checker.py --target docs/zh_cn

README.md

@@ -19,10 +19,10 @@
   <div>&nbsp;</div>
 </div>
 
-[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdeploy.readthedocs.io/en/latest/)
+[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdeploy.readthedocs.io/en/1.x/)
 [![badge](https://github.com/open-mmlab/mmdeploy/workflows/build/badge.svg)](https://github.com/open-mmlab/mmdeploy/actions)
-[![codecov](https://codecov.io/gh/open-mmlab/mmdeploy/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdeploy)
-[![license](https://img.shields.io/github/license/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/blob/master/LICENSE)
+[![codecov](https://codecov.io/gh/open-mmlab/mmdeploy/branch/1.x/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdeploy)
+[![license](https://img.shields.io/github/license/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/tree/1.x/LICENSE)
 [![issue resolution](https://img.shields.io/github/issues-closed-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
 [![open issues](https://img.shields.io/github/issues-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
 
@@ -75,7 +75,7 @@ The benchmark can be found from [here](docs/en/03-benchmark/benchmark.md)
 
 All kinds of modules in the SDK can be extended, such as `Transform` for image processing, `Net` for Neural Network inference, `Module` for postprocessing and so on
 
-## [Documentation](https://mmdeploy.readthedocs.io/en/latest/)
+## [Documentation](https://mmdeploy.readthedocs.io/en/1.x/)
 
 Please read [getting_started](docs/en/get_started.md) for the basic usage of MMDeploy. We also provide tutoials about:
 

README_zh-CN.md

@@ -19,10 +19,10 @@
   <div>&nbsp;</div>
 </div>
 
-[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdeploy.readthedocs.io/zh_CN/latest/)
+[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmdeploy.readthedocs.io/zh_CN/1.x/)
 [![badge](https://github.com/open-mmlab/mmdeploy/workflows/build/badge.svg)](https://github.com/open-mmlab/mmdeploy/actions)
-[![codecov](https://codecov.io/gh/open-mmlab/mmdeploy/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdeploy)
-[![license](https://img.shields.io/github/license/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/blob/master/LICENSE)
+[![codecov](https://codecov.io/gh/open-mmlab/mmdeploy/branch/1.x/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdeploy)
+[![license](https://img.shields.io/github/license/open-mmlab/mmdeploy.svg)](https://github.com/open-mmlab/mmdeploy/tree/1.x/LICENSE)
 [![issue resolution](https://img.shields.io/github/issues-closed-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
 [![open issues](https://img.shields.io/github/issues-raw/open-mmlab/mmdeploy)](https://github.com/open-mmlab/mmdeploy/issues)
 
@@ -75,7 +75,7 @@ MMDeploy 是 [OpenMMLab](https://openmmlab.com/) 模型部署工具箱，**为
 - Net 推理
 - Module 后处理
 
-## [中文文档](https://mmdeploy.readthedocs.io/zh_CN/latest/)
+## [中文文档](https://mmdeploy.readthedocs.io/zh_CN/1.x/)
 
 - [快速上手](docs/zh_cn/get_started.md)
 - [编译](docs/zh_cn/01-how-to-build/build_from_source.md)
@@ -119,7 +119,7 @@ MMDeploy 是 [OpenMMLab](https://openmmlab.com/) 模型部署工具箱，**为
 
 ## 基准与模型库
 
-基准和支持的模型列表可以在[基准](https://mmdeploy.readthedocs.io/zh_CN/latest/benchmark.html)和[模型列表](https://mmdeploy.readthedocs.io/en/latest/supported_models.html)中获得。
+基准和支持的模型列表可以在[基准](https://mmdeploy.readthedocs.io/zh_CN/1.x/03-benchmark/benchmark.html)和[模型列表](https://mmdeploy.readthedocs.io/en/1.x/03-benchmark/supported_models.html)中获得。
 
 ## 贡献指南
 

demo/tutorials/tutorials_1.ipynb

@@ -6,7 +6,7 @@
         "id": "mAWHDEbr6Q2i"
       },
       "source": [
-        "[![Open in colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-mmlab/mmdeploy/blob/master/demo/tutorials_1.ipynb)\n",
+        "[![Open in colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-mmlab/mmdeploy/tree/1.x/demo/tutorials_1.ipynb)\n",
         "# 前言\n",
         "OpenMMLab 的算法如何部署？是很多社区用户的困惑。而模型部署工具箱 [MMDeploy](https://zhuanlan.zhihu.com/p/450342651) 的开源，强势打通了从算法模型到应用程序这 \"最后一公里\"！\n",
         "今天我们将开启模型部署入门系列教程，在模型部署开源库 MMDeploy 的辅助下，介绍以下内容：\n",

docker/CPU/Dockerfile

@@ -85,9 +85,9 @@ ENV PATH="/root/workspace/ncnn/build/tools/quantize/:${PATH}"
 ### install mmdeploy
 WORKDIR /root/workspace
 ARG VERSION
-RUN git clone -b dev-1.x https://github.com/open-mmlab/mmdeploy.git &&\
+RUN git clone -b 1.x https://github.com/open-mmlab/mmdeploy.git &&\
     cd mmdeploy &&\
-    if [ -z ${VERSION} ] ; then echo "No MMDeploy version passed in, building on dev-1.x" ; else git checkout tags/v${VERSION} -b tag_v${VERSION} ; fi &&\
+    if [ -z ${VERSION} ] ; then echo "No MMDeploy version passed in, building on 1.x" ; else git checkout tags/v${VERSION} -b tag_v${VERSION} ; fi &&\
     git submodule update --init --recursive &&\
     rm -rf build &&\
     mkdir build &&\

docker/GPU/Dockerfile

@@ -65,9 +65,9 @@ RUN cp -r /usr/local/lib/python${PYTHON_VERSION}/dist-packages/tensorrt* /opt/co
 ENV ONNXRUNTIME_DIR=/root/workspace/onnxruntime-linux-x64-${ONNXRUNTIME_VERSION}
 ENV TENSORRT_DIR=/workspace/tensorrt
 ARG VERSION
-RUN git clone -b dev-1.x https://github.com/open-mmlab/mmdeploy &&\
+RUN git clone -b 1.x https://github.com/open-mmlab/mmdeploy &&\
     cd mmdeploy &&\
-    if [ -z ${VERSION} ] ; then echo "No MMDeploy version passed in, building on dev-1.x" ; else git checkout tags/v${VERSION} -b tag_v${VERSION} ; fi &&\
+    if [ -z ${VERSION} ] ; then echo "No MMDeploy version passed in, building on 1.x" ; else git checkout tags/v${VERSION} -b tag_v${VERSION} ; fi &&\
     git submodule update --init --recursive &&\
     mkdir -p build &&\
     cd build &&\

docs/en/01-how-to-build/android.md

@@ -97,7 +97,7 @@ make -j$(nproc) install
   <tr>
   <td>OpenJDK </td>
   <td>It is necessary for building Java API.</br>
-  See <a href='https://github.com/open-mmlab/mmdeploy/blob/dev-1.x/csrc/mmdeploy/apis/java/README.md'> Java API build </a> for building tutorials.
+  See <a href='https://github.com/open-mmlab/mmdeploy/tree/1.x/csrc/mmdeploy/apis/java/README.md'> Java API build </a> for building tutorials.
   </td>
   </tr>
 </tbody>