This is an automated email from the ASF dual-hosted git repository.
pottlinger pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/creadur-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 25f383ae7 RAT-481: Add note about usage of linkchecker
25f383ae7 is described below
commit 25f383ae7e6321a435fd493b234a35ea68b398e3
Author: P. Ottlinger <[email protected]>
AuthorDate: Sat Oct 4 13:49:11 2025 +0200
RAT-481: Add note about usage of linkchecker
---
README.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/README.md b/README.md
index 9dbf3922b..b3369e2c0 100644
--- a/README.md
+++ b/README.md
@@ -108,4 +108,15 @@ $ docker compose up
```
You may need to configure shared paths from Docker -> Preferences... ->
Resources -> File Sharing in order to mount your local files.
+## Checking for broken links
+
+In order to prepare release documentation you may want to start the webpage
locally and issue:
+
+```
+$ linkchecker http://localhost:8888/rat
+$ linkchecker http://localhost:8888/rat017
+```
+
+to look for broken links automatically.
+
Happy hacking :)
