Updating test hyperlink option 01/28301/2
authorVinod Ahuja <vahuja@unomaha.edu>
Mon, 19 Dec 2022 20:13:11 +0000 (14:13 -0600)
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tue, 3 Jan 2023 12:45:47 +0000 (12:45 +0000)
Suggested Linkchecker software is no longer maintained further it
requires python 2 rather python 3. Further after testing Linkchecker I
found that it missed many links.

I have tried broken-link-checker npm package which detects many of the
links not detected by Linkchecker. Therefore proposing using this new
software for checking website links.

Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: If1913104225f4b97c4b1265bdeace4b214128d6c
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28301
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
docs/07_How_To_Contribute/08_Adding_Documentation.md

index a54058d..091b520 100644 (file)
@@ -87,17 +87,23 @@ For example: If the file name is Build Process then it will be written as 01_bui
     ```
 
 ## Test Hyperlinks
-
-[LinkChecker](https://wummel.github.io/linkchecker/) is a tool that allows to
+[Broken Link Checker](https://github.com/stevenvachon/broken-link-checker) is a tool that allows to
 check all the hyperlinks in the site.
 
 For testing hyperlinks as soon as the local site is running, do:
 
 ```sh
-$ linkchecker http://localhost:8000
+$ blc http://localhost:8000 -ro
+```
+
+
+For testing hyperlinks of live website do:
+
+```sh
+$ blc https://docs.automotivelinux.org/en/master/ -ro
 ```
 
-The ```linkchecker``` output will display the broken link and there location in
+The ```Broken Link Checker``` output will display the broken link and there location in
 the site.