Skip to content

[Chore][CI] Re-enable dead-link check job#10733

Open
zhangshenghang wants to merge 18 commits intoapache:devfrom
zhangshenghang:zsh/enable-dead-link-ci
Open

[Chore][CI] Re-enable dead-link check job#10733
zhangshenghang wants to merge 18 commits intoapache:devfrom
zhangshenghang:zsh/enable-dead-link-ci

Conversation

@zhangshenghang
Copy link
Copy Markdown
Member

@zhangshenghang zhangshenghang commented Apr 9, 2026

Purpose of this pull request

Re-enable the dead-link GitHub Actions job in .github/workflows/backend.yml by uncommenting the existing configuration so markdown link checking runs again in CI.

Does this PR introduce any user-facing change?

No

How was this patch tested?

  • Parsed .github/workflows/backend.yml locally to verify valid YAML syntax (YAML OK).
  • Verified only the dead-link job block was restored from comments.

Check list

  • Add License for new dependency if added
  • Update docs/en and docs/zh if needed
  • Update incompatible-changes.md if needed
  • For connector changes, update plugin mapping, dist pom, CI labels, E2E, and plugin_config

@github-actions github-actions bot added the CI&CD label Apr 9, 2026
Fix broken relative links in sink connector docs (DuckDB, GraphQL,
SensorsData) pointing to non-existent ../sink-common-options.md.
Correct path should be ../common-options/sink-common-options.md.

Fix missing .md extension on datasource-spi links in common-options
docs (en + zh).

Fix full-width closing parenthesis in Lance zh doc URL causing 404.
Update Quick Start link from non-existent start-v2 to the correct
quick-start-seatunnel-engine.md path.
- Fix broken relative links to non-existent schema-evolution.md,
  speed-limit.md, common-options.md and Config-Encryption-Decryption.md
- Fix missing .md extensions on internal tool links in overview.md
- Replace dead external URLs (Oracle XA, Lamport PDF) with working
  alternatives or plain-text citations
- Apply fixes to both English and Chinese documentation
@github-actions github-actions bot added the Zeta label Apr 9, 2026
Correct path from ../concepts/ to ./config-encryption-decryption.md
Remove links to non-existent metrics.txt and grafana-dashboard.json
files and replace with plain text descriptions.
- Add http://127.0.0.1 and src/main/java/ to dlc.json ignore patterns
- Fix broken telemetry file links in English telemetry.md
- Fix broken quick-start URL in English and Chinese about.md
Convert bare Wikipedia URLs to proper markdown links to prevent
markdown-link-check from including trailing Chinese punctuation
in the URL.
# Conflicts:
#	docs/en/engines/zeta/telemetry.md
#	docs/en/introduction/concepts/config.md
#	docs/en/introduction/concepts/gravitino-type-mapping.md
#	docs/en/introduction/how-it-works.md
#	docs/en/transforms/encrypt.md
#	docs/en/transforms/llm.md
#	docs/zh/engines/zeta/telemetry.md
#	docs/zh/introduction/concepts/config.md
#	docs/zh/introduction/concepts/gravitino-type-mapping.md
#	docs/zh/introduction/how-it-works.md
#	docs/zh/transforms/encrypt.md
#	docs/zh/transforms/llm.md
Copy link
Copy Markdown

@DanielLeens DanielLeens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pulled the latest HEAD locally and checked the workflow + ignore-list changes together with the touched docs / README links.

Re-enabling dead-link checking as a non-blocking continue-on-error job while tightening .dlc.json and fixing the broken repository links looks reasonable to me, and I do not see a blocker in the current revision.

Copy link
Copy Markdown
Contributor

@davidzollo davidzollo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 if CI passes

Copy link
Copy Markdown
Contributor

@dybyte dybyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Waiting for CI to pass.


### common options [string]

Transform 插件的通用参数。
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should we change these documents?

Comment thread docs/zh/transforms/llm.md

## tips
大模型API接口通常会有速率限制,可以配合Seatunnel的限速配置,已确保任务顺利运行。
Seatunnel限速配置请参考环境配置文档。
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Copy link
Copy Markdown

@DanielLeens DanielLeens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @zhangshenghang,

I re-pulled the latest head locally and rechecked the workflow plus the touched docs / README links together.

Runtime chain:

backend.yml dead-link job
  -> markdown-link-check -c .dlc.json
  -> scans repository markdown files
  -> hits the broken links fixed in this branch

The current branch still looks coherent to me:

  • the dead-link job is re-enabled in backend.yml
  • it stays continue-on-error, so this is a safe “restore the monitor first” rollout
  • .dlc.json now has a usable fallback retry delay (1000ms instead of 1000s)
  • the docs / README fixes are exactly in the set the checker would actually scan

I did not find a blocker in the current revision, and the PR checks are green.

Conclusion

Conclusion: can merge

  1. Blocking items
  • None.
  1. Suggested improvements
  • In a follow-up, the .dlc.json ignore patterns can be tightened further if we want to reduce long-term wildcard scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants