2 Revamping and restructuring Automotive Grade Linux's documentation site under GSoD'20.
4 -> [The working documentation site.](https://automotivegradelinux.readthedocs.io)
6 -> [ReadTheDocs project page.](https://readthedocs.org/projects/automotivegradelinux/)
8 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://docs-agl.readthedocs.io/en/latest/](https://docs-agl.readthedocs.io/en/latest/). The documentation site is hosted on [readthedocs](https://readthedocs.org/projects/docs-agl/) and corresponding builds are mentioned [here](https://readthedocs.org/projects/docs-agl/builds/).
10 ## Download Repository
12 Kindly check [this](https://wiki.automotivelinux.org/agl-distro/contributing)
13 and clone with commit-msg hook :
16 $ git clone "ssh://$USER@gerrit.automotivelinux.org:29418/AGL/documentation" && scp -p -P 29418 $USER@gerrit.automotivelinux.org:hooks/commit-msg "documentation/.git/hooks/"
19 ## Building a local site
21 1. Change into the directory
27 2. Install MkDocs and rtd-dropdown theme
30 $ sudo pip install -r requirements.txt
33 3. Serve locally (defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/)):
39 Process to **add new or edit existing** markdown files to AGL documentation:
41 ## Directory Structure
43 Find existing or add new markdowns in the following directory structure.
48 │ ├── 0_Getting_Started
50 │ │ └── 2_Building_AGL_Image
53 | ├──<Chapter-Number>_<Chapter-Name>
54 | | ├──<Subchapter-Number>_<Subchapter-Name>
55 | | | ├──<Index-Number>_<Markdown-Title>.md
59 ## Markdown Formatting
61 1. Add following at the start of each markdown :
72 [<enter-title>](../<Chapter-Number>_<Chapter-Name>/<Subchapter-Number>_<Subchapter-Name>/<Index-Number>_<Markdown-Title>.md)
77 [LinkChecker](https://wummel.github.io/linkchecker/) is a tool that allows to
78 check all the hyperlinks in the site.
80 For testing hyperlinks as soon as the local site is running, do:
83 linkchecker http://localhost:8000
86 The ```linkchecker``` output will display the broken link and there location in
95 #recent version of git-review (>=1.28.0 is required)
96 sudo pip3 install git-review
99 2. Write commit message
102 # track all the new changes
105 # Write the commit message
109 3. Push changes for review to Gerrit