You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "Anonymitaet (via GitHub)" <gi...@apache.org> on 2023/02/28 04:12:52 UTC
[GitHub] [pulsar] Anonymitaet opened a new issue, #19658: [feat][workflow] add dead link checker to CI/CD
Anonymitaet opened a new issue, #19658:
URL: https://github.com/apache/pulsar/issues/19658
### Discussed in https://github.com/apache/pulsar/discussions/19144
<div type='discussions-op-text'>
<sup>Originally posted by **Anonymitaet** January 6, 2023</sup>
# Issue
Sometimes 404 errors occur in docs.
Currently, we use the following ways to check them:
### Method 1: use tools to check them manually at regular intervals
- [Dr. Link Checker](https://www.drlinkcheck.com/)
- [W3C Link Checker](https://validator.w3.org/checklink?uri=http%3A%2F%2Fpulsar.apache.org%2Fdocs&hide_type=all&recursive=on&depth=4&check=Check)
- [Dead Link Checker](https://www.deadlinkchecker.com/)
#### Disadvantages
- It's easy to forget to do this task.
- It entirely depends on the contributor's willingness.
### Method 2: check the links through the local preview process
It reminds you of 404 errors if any.
#### Disadvantages
- Some contributors need to preview docs on the local machines and the link check step is skipped.
- Even though contributors preview docs and get reminders of 404 issues, they can ignore this error and still submit doc PRs.
# Solution
Can we implement a `dead link check` to the CI/CD process in `pulsar-site`?
### Example
Skywalking
<img width="1017" alt="image" src="https://user-images.githubusercontent.com/50226895/210919627-62826cd9-8998-4169-8fa8-3eba19cd73b2.png">
### Benefits
- Docs submitted from all contributors can be checked in a prominent and easy way
- If we want to ensure no 404 links in docs, we can set this check as `required`. In this way, PRs can not be merged with 404 issues.
- (Other doc-related checks, e.g., **grammar checks, typo checks**, etc can also be implemented)
cc @momo-jun @DaveDuggins @D-2-Ed
</div>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] github-actions[bot] commented on issue #19658: [feat][workflow] add dead link checker to CI/CD
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on issue #19658:
URL: https://github.com/apache/pulsar/issues/19658#issuecomment-1491180123
The issue had no activity for 30 days, mark with Stale label.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] momo-jun commented on issue #19658: [feat][workflow] add dead link checker to CI/CD
Posted by "momo-jun (via GitHub)" <gi...@apache.org>.
momo-jun commented on issue #19658:
URL: https://github.com/apache/pulsar/issues/19658#issuecomment-1447677872
Great proposal. +1.
Broken links always bother and can be introduced unexpectedly to a doc version when doc updates are made. Now we can use the local build command to auto-detect most broken links, but some can be missed. For example, https://github.com/apache/pulsar-site/pull/434/files.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org