diff options
author | Vinod Ahuja <vahuja@unomaha.edu> | 2022-12-19 14:13:11 -0600 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2023-01-03 12:45:47 +0000 |
commit | 86d7bc6e530903dd6e559711c65fb7f66a94e35a (patch) | |
tree | 34c4f754d187fd8191f6162dbbb48eeb66c54b1f | |
parent | 120a2677992ea299eea5fb5cb0ed1081f76bb92c (diff) |
Updating test hyperlink option
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>
-rw-r--r-- | docs/07_How_To_Contribute/08_Adding_Documentation.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/07_How_To_Contribute/08_Adding_Documentation.md b/docs/07_How_To_Contribute/08_Adding_Documentation.md index a54058d..091b520 100644 --- a/docs/07_How_To_Contribute/08_Adding_Documentation.md +++ b/docs/07_How_To_Contribute/08_Adding_Documentation.md @@ -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. |