[improve] repair doc dead link and error link#10439
[improve] repair doc dead link and error link#10439misi1987107 wants to merge 1 commit intoapache:devfrom
Conversation
Issue 1: Root directory README.md not updatedLocation: 当前内容:
- [Source Connectors](https://seatunnel.apache.org/docs/connector-v2/source)
- [Sink Connectors](https://seatunnel.apache.org/docs/connector-v2/sink)
- [Transform Connectors](docs/en/transform-v2)
- [SeaTunnel Zeta Engine](https://seatunnel.apache.org/docs/start-v2/locally/quick-start-seatunnel-engine/)
相关上下文:
- PR 范围:仅修改了 docs/ 目录下的文件
- 根目录 README.md:未被包含在此 PR 中Problem Description: Potential Risks:
Scope of Impact:
Severity: MINOR Improvement Suggestions: # Suggested changes
- [Source Connectors](https://seatunnel.apache.org/docs/connectors/source)
- [Sink Connectors](https://seatunnel.apache.org/docs/connectors/sink)
- [Transform Connectors](docs/en/transforms)
- [SeaTunnel Zeta Engine](https://seatunnel.apache.org/docs/getting-started/locally/quick-start-seatunnel-engine)Rationale: Maintain consistency between the project homepage and documentation structure, ensuring users can access correct documentation from any entry point. Issue 2: Lack of automated documentation link checkingLocation: CI/CD configuration (not involved in this PR) Problem Description: Potential Risks:
Scope of Impact:
Severity: MINOR Improvement Suggestions: # Sample GitHub Actions configuration
- name: Check Markdown Links
run: |
npm install -g markdown-link-check
find docs/ -name "*.md" -exec markdown-link-check {} \;Rationale: Prevent dead link issues from recurring and improve documentation quality assurance. Issue 3: PR description lacks change detailsLocation: PR description template Problem Description: Potential Risks:
Scope of Impact:
Severity: MINOR Improvement Suggestions: ### Does this PR introduce any user-facing change?
Yes. This PR fixes dead links in documentation. Previously, users clicking on links like
[exactly-once](../../concept/connector-v2-features.md) would encounter 404 errors.
After this change, all links point to the correct new documentation structure.
### How was this patch tested?
1. Verified all new file paths exist using shell commands
2. Spot-checked multiple modified files to confirm link correctness
3. Ensured link count balance (120 removed, 120 added)
4. Verified anchors (like #schema_save_mode-enum) exist in target filesRationale: Improve PR transparency and reviewability, aligning with open source project best practices. Issue 4: Some files may have been missedLocation: Some files in Problem Description: Potential Risks:
Scope of Impact:
Severity: MINOR (verification required) Improvement Suggestions: grep -r "connector-v2\|concept/\|transform-v2\|seatunnel-engine" \
docs/en/connectors/sink/{Console,Greenplum, DingTalk, SftpFile}.md \
docs/zh/connectors/sink/{Console,Greenplum, DingTalk, SftpFile}.mdIf old links are found, they should be supplemented and fixed in a subsequent PR. Rationale: Ensure the integrity and consistency of documentation fixes. |
|
Can you turn on the CI for detecting dead links? Let's run this CI for a while recently. |
@misi1987107 +1 |
Purpose of this pull request
Fix doc dead links and error links
Does this PR introduce any user-facing change?
How was this patch tested?
Check list
New License Guide
incompatible-changes.mdto describe the incompatibility caused by this PR.