Skip to content

Commit a9b829d

Browse files
authored
[Chore] Fix doc deadlink error (#17466)
1 parent bccb8ec commit a9b829d

16 files changed

Lines changed: 82 additions & 83 deletions

File tree

.dlc.json

Lines changed: 0 additions & 39 deletions
This file was deleted.

.github/workflows/docs.yml

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -61,30 +61,11 @@ jobs:
6161
uses: ./.github/actions/workflow-telemetry-action
6262
with:
6363
comment_on_pr: false
64-
- run: sudo npm install -g markdown-link-check@3.13.7
65-
- run: sudo apt install plocate -y && sudo updatedb
66-
# NOTE: Change command from `find . -name "*.md"` to `find . -not -path "*/node_modules/*" -not -path "*/.tox/*" -name "*.md"`
67-
# if you want to run check locally
64+
- run: sudo snap install lychee
6865
- name: Check Dead Links
6966
run: |
7067
set -xe
71-
MAX_CONCURRENCY=6
72-
EXIT_CODE=0
73-
74-
cleanup() {
75-
pkill -P $$
76-
exit "$EXIT_CODE"
77-
}
78-
79-
trap cleanup SIGINT SIGTERM
80-
81-
for file in $(locate "$PWD*/*.md" | grep -v ./deploy/terraform/aws/README.md | grep -v ./.github); do
82-
while [ $(jobs -r | wc -l) -ge "$MAX_CONCURRENCY" ]; do
83-
wait -n || { EXIT_CODE=$?; cleanup; }
84-
done
85-
markdown-link-check -c .dlc.json -q "$file" &
86-
done
87-
wait || { EXIT_CODE=$?; cleanup; }
68+
lychee -c .github/workflows/lychee.toml -v docs/docs/*
8869
paths-filter:
8970
name: Helm-Doc-Path-Filter
9071
runs-on: ubuntu-latest

.github/workflows/lychee.toml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Don't show interactive progress bar while checking links.
2+
no_progress = false
3+
4+
# Only test links with the given schemes (e.g. https).
5+
# Omit to check links with any other scheme.
6+
# At the moment, we support http, https, file, and mailto.
7+
scheme = ["https", "http", "file"]
8+
9+
# Exclude URLs and mail addresses from checking. The values are treated as regular expressions
10+
exclude = [
11+
'^http://localhost',
12+
'http://localhost(:\d+)?',
13+
'^https://img\.shields\.io/badge',
14+
'dolphinscheduler\.apache\.org',
15+
'^http://ds1',
16+
'^http://ds1(:\d+)?',
17+
'^http://minio',
18+
'^http://minio(:\d+)?',
19+
'^https://github\.com/apache/dolphinscheduler/blob/[^/]+/script/env/dolphinscheduler_env\.sh',
20+
]
21+
22+
# Exclude paths from getting checked. The values are treated as regular expressions
23+
exclude_path = [
24+
"docs/docs/en/history-versions.md",
25+
"docs/docs/zh/history-versions.md",
26+
"docs/docs/en/faq.md",
27+
"docs/docs/zh/faq.md",
28+
]
29+
30+
# Proceed for server connections considered insecure (invalid TLS).
31+
insecure = true
32+
33+
# Comma-separated list of accepted status codes for valid links.
34+
accept = ["200", "401", "403"]
35+
36+
# Maximum number of allowed retries before a link is declared dead.
37+
max_retries = 3
38+
39+
# Minimum wait time in seconds between retries of failed requests.
40+
retry_wait_time = 10
41+
42+
# Website timeout from connect to response finished.
43+
timeout = 30
44+
45+
# When links are available using HTTPS, treat HTTP links as errors.
46+
require_https = false
47+
48+
# Check mail addresses
49+
include_mail = false
50+
51+
# Check links inside `<code>` and `<pre>` blocks as well as Markdown code
52+
# blocks.
53+
include_verbatim = false
54+
55+
# Enable the checking of fragments in links.
56+
include_fragments = false

.licenserc.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ header:
4444
- '**/node_modules/**'
4545
- '.github/actions/comment-on-issue/**'
4646
- '.github/actions/translate-on-issue/**'
47+
- '.github/workflows/lychee.toml'
4748
- '**/.gitkeep'
4849
- 'org.mockito.plugins.MockMaker'
4950
- tools/dependencies/known-dependencies.txt

docs/docs/en/contribute/join/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Apache Software Foundation takes a rigorous stance on eliminating security issues in its software projects. Apache DolphinScheduler is also very concerned Security issues related to its features and functionality.
44

5-
If you have apprehensions regarding DolphinScheduler’s security or you discover vulnerability or potential threat, don’t hesitate to get in touch with the Apache Security Team by dropping a mail at [security@apache.org](mailto:security@apache.org). Please specify the project name as DolphinScheduler in the email and provide a description of the relevant problem or potential threat. You are also urged to recommend the way to reproduce and replicate the issue. The apache security team and the DolphinScheduler community will get back to you after assessing and analysing the findings.
5+
If you have apprehensions regarding DolphinScheduler’s security or you discover vulnerability or potential threat, don’t hesitate to get in touch with the Apache Security Team by dropping a mail at [security@apache.org]. Please specify the project name as DolphinScheduler in the email and provide a description of the relevant problem or potential threat. You are also urged to recommend the way to reproduce and replicate the issue. The apache security team and the DolphinScheduler community will get back to you after assessing and analysing the findings.
66

77
Please pay attention to report the security issue on the security email before disclosing it on public domain.
88

docs/docs/en/contribute/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The command is as follow:
120120
gpg --keyserver hkp://pool.sks-keyservers.net --send-key 85E11560
121121
```
122122
123-
`pool.sks-keyservers.net` is randomly chosen from [public key server](https://sks-keyservers.net/status/).
123+
`pool.sks-keyservers.net` is randomly chosen from [public key server](https://keyserver.ubuntu.com).
124124
Each server will automatically synchronize with one another, so it would be okay to choose any one, a backup keys servers
125125
is `gpg --keyserver hkp://keyserver.ubuntu.com --send-key <YOUR_KEY_ID>`
126126

docs/docs/en/faq.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ A: 1, **first check whether the WorkerServer service exists through jps**, or di
111111

112112
A: Provide Docker image and Dockerfile.
113113

114-
Docker image address: https://hub.docker.com/r/escheduler/escheduler_images
114+
Docker image address: https://hub.docker.com/r/apache/dolphinscheduler
115115

116-
Dockerfile address: https://github.com/qiaozhanwei/escheduler_dockerfile/tree/master/docker_escheduler
116+
Dockerfile address: https://github.com/apache/dolphinscheduler/tree/dev/dolphinscheduler-dist/src/main/docker
117117

118118
---
119119

@@ -533,8 +533,8 @@ A: 1, We can successfully create scheduled task and add one record into t_schedu
533533

534534
## Q : What is the address of swagger ui
535535

536-
A: 1, For version 3.1.0+ is http://apiServerIp:apiServerPort/dolphinscheduler/swagger-ui/index.html,
537-
for version 1.2+ is http://apiServerIp:apiServerPort/dolphinscheduler/doc.html others is http://apiServerIp:apiServerPort/escheduler/doc.html.
536+
A: 1, For version 3.1.0+ is [http://apiServerIp:apiServerPort/dolphinscheduler/swagger-ui/index.html],
537+
for version 1.2+ is [http://apiServerIp:apiServerPort/dolphinscheduler/doc.html] others is [http://apiServerIp:apiServerPort/escheduler/doc.html].
538538

539539
---
540540

@@ -583,7 +583,7 @@ A: 1, It is currently judged according to natural days, at the end of last month
583583

584584
## Q : DS Backend Interface Document
585585

586-
A: 1, http://106.75.43.194:8888/dolphinscheduler/swagger-ui/index.html?language=en.
586+
A: 1, http://localhost:8888/dolphinscheduler/swagger-ui/index.html?language=en.
587587

588588
## During the operation of dolphinscheduler, the ip address is obtained incorrectly
589589

@@ -616,7 +616,7 @@ dolphin.scheduler.network.interface.preferred=eth1
616616

617617
After configuration is modified, restart the service to activation
618618

619-
If the ip address is still wrong, please download [dolphinscheduler-netutils.jar](/asset/dolphinscheduler-netutils.jar) to the machine, execute the following commands and feedback the output to the community developers:
619+
If the ip address is still wrong, please download [dolphinscheduler-netutils.jar] to the machine, execute the following commands and feedback the output to the community developers:
620620

621621
```shell
622622
java -jar target/dolphinscheduler-netutils.jar

docs/docs/zh/contribute/join/DS-License.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
如果您所使用的第三方软件并不在以上协议之中,那么很抱歉,您的代码将无法通过审核,建议您找寻其他替代方案。
1515

16-
另外,当您需要使用新的软件的时候,请将您这样做的原因、最终产出结果发邮件至dev@dolphinscheduler.apache.org讨论,当得到至少3票PPMC认同的时候,您方可以引入。
16+
另外,当您需要使用新的软件的时候,请将您这样做的原因、最终产出结果发邮件至[dev@dolphinscheduler.apache.org]讨论,当得到至少3票PPMC认同的时候,您方可以引入。
1717

1818
### 如何在DolphinScheduler合法的使用第三方开源软件
1919

docs/docs/zh/contribute/join/document.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ git clone https://github.com/<your-github-user-name>/dolphinscheduler-website
2020

2121
3. 在根目录下运行 `yarn generate` 来格式化和准备数据。
2222

23-
4. 在根目录下运行 `yarn dev` 启动本地服务器,其将允许在 http://localhost:3000。
23+
4. 在根目录下运行 `yarn dev` 启动本地服务器,其将允许在 http://localhost:3000
2424

2525
```
2626
注意:如果您在 Windows 而非 Mac 或 Linux 中克隆代码。请阅读下面的详细信息。

docs/docs/zh/contribute/join/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Apache Software Foundation在消除其软件项目中的安全性问题方面采取严格的立场。 Apache DolphinScheduler也非常关注与其功能有关的安全性问题。
44

5-
如果您对DolphinScheduler的安全性有疑虑,或者发现了漏洞或潜在威胁,请发送邮件至[security@apache.org](mailto:security@apache.org,与Apache安全团队联系。 请在电子邮件中将项目名称指定为DolphinScheduler,并提供相关问题或潜在威胁的描述。 还敦促您推荐重现和复制问题的方法。 在评估和分析调查结果之后,apache安全团队和DolphinScheduler社区将与您联系。
5+
如果您对DolphinScheduler的安全性有疑虑,或者发现了漏洞或潜在威胁,请发送邮件至[security@apache.org],与Apache安全团队联系。 请在电子邮件中将项目名称指定为DolphinScheduler,并提供相关问题或潜在威胁的描述。 还敦促您推荐重现和复制问题的方法。 在评估和分析调查结果之后,apache安全团队和DolphinScheduler社区将与您联系。
66

77
在公共领域公开该安全电子邮件之前,请注意在安全电子邮件中报告该安全问题。
88

0 commit comments

Comments
 (0)