From 8d17fd20f99e36f9c5af6e2dfef821e11a70780e Mon Sep 17 00:00:00 2001 From: Jiajie Zhong Date: Thu, 12 May 2022 11:30:01 +0800 Subject: [PATCH] [ci] Dead link check all markdown file (#10004) there are 162 markdown files in dir `docs` and all file in project is 175 files, so I think check all file will not add too much load for our ci, but it could discovered the dead link in time to avoid some thing like #9998 --- .github/workflows/docs.yml | 6 +++++- deploy/README.md | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 801b7d4d16..dfcd075a71 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,6 +19,8 @@ name: Docs on: pull_request: paths: + - '.github/workflows/docs.yml' + - '**/*.md' - 'docs/**' concurrency: @@ -50,7 +52,9 @@ jobs: steps: - uses: actions/checkout@v2 - run: sudo npm install -g markdown-link-check@3.10.0 + # NOTE: Change command from `find . -name "*.md"` to `find . -not -path "*/node_modules/*" -not -path "*/.tox/*" -name "*.md"` + # if you want to run check locally - run: | - for file in $(find ./docs -name "*.md"); do + for file in $(find . -name "*.md"); do markdown-link-check -c .dlc.json -q "$file" done diff --git a/deploy/README.md b/deploy/README.md index e03779f8c7..c1b8fa5434 100644 --- a/deploy/README.md +++ b/deploy/README.md @@ -1,4 +1,4 @@ # DolphinScheduler for Docker and Kubernetes -* [Start Up DolphinScheduler with Docker](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/installation/docker.html) +* [Start Up DolphinScheduler with Docker](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/start/docker.html) * [Start Up DolphinScheduler with Kubernetes](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/installation/kubernetes.html)