X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2F07_How_To_Contribute%2F08_Adding_Documentation.md;h=4da6165403d52b30a9eacf69923dc87d5ebffbfd;hb=refs%2Ftags%2Fquillback_16.92.0;hp=a54058d1c30f64606f1fef8ec5a5fd80ada095ea;hpb=120a2677992ea299eea5fb5cb0ed1081f76bb92c;p=AGL%2Fdocumentation.git diff --git a/docs/07_How_To_Contribute/08_Adding_Documentation.md b/docs/07_How_To_Contribute/08_Adding_Documentation.md index a54058d..4da6165 100644 --- a/docs/07_How_To_Contribute/08_Adding_Documentation.md +++ b/docs/07_How_To_Contribute/08_Adding_Documentation.md @@ -5,7 +5,7 @@ title: Adding Documentation The [documentation gerrit repository](https://gerrit.automotivelinux.org/gerrit/admin/repos/AGL/documentation) contains AGL documentation website template and content, rendering is visible at -[https://automotivegradelinux.readthedocs.io/en/latest/](https://automotivegradelinux.readthedocs.io/en/latest/). +[https://docs.automotivelinux.org](https://docs.automotivelinux.org). The documentation site is hosted on [readthedocs](https://readthedocs.org/projects/automotivegradelinux/) and corresponding builds are mentioned @@ -34,7 +34,13 @@ $ git clone "ssh://@gerrit.automotivelinux.org:29418/AGL/documentation" && $ sudo pip install -r requirements.txt ``` -3. Serve locally (default rendered at [127.0.0.1:8000/](127.0.0.1:8000/)): +3. If pip is not already installed then install it + ```sh + $ sudo apt-install python3-pip + ``` + + +4. Serve locally (default rendered at [127.0.0.1:8000/](127.0.0.1:8000/)): ```sh $ sudo mkdocs serve @@ -87,17 +93,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.