Added Contribution Guide

[AGL/documentation.git] / docs / 5_How_To_Contribute / 8_Adding_Documentation.md

diff --git a/docs/5_How_To_Contribute/1_How_to_add_documentation_to_AGL.md b/docs/5_How_To_Contribute/8_Adding_Documentation.md
similarity index 67%
rename from docs/5_How_To_Contribute/1_How_to_add_documentation_to_AGL.md
rename to docs/5_How_To_Contribute/8_Adding_Documentation.md
index ed7eb6d..b65e971 100644 (file)
--- a/docs/5_How_To_Contribute/1_How_to_add_documentation_to_AGL.md
+++ b/docs/5_How_To_Contribute/8_Adding_Documentation.md
@@ -2,15 +2,22 @@
 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://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/).
+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/).
+The documentation site is hosted on
+[readthedocs](https://readthedocs.org/projects/automotivegradelinux/) and
+corresponding builds are mentioned
+[here](https://readthedocs.org/projects/automotivegradelinux/builds/).
 
 ## Download Repository
 
 
-Kindly check [this](https://wiki.automotivelinux.org/agl-distro/contributing) and clone with commit-msg hook :
+Clone with commit-msg hook :
 
 ```sh
-$ git clone "ssh://$USER@gerrit.automotivelinux.org:29418/AGL/documentation" && scp -p -P 29418 $USER@gerrit.automotivelinux.org:hooks/commit-msg "documentation/.git/hooks/"
+$ git clone "ssh://<LFID>@gerrit.automotivelinux.org:29418/AGL/documentation" && scp -p -P 29418 <LFID>@gerrit.automotivelinux.org:hooks/commit-msg "documentation/.git/hooks/"
 ```
 
 ## Building a local site
@@ -71,12 +78,13 @@ documentation
 
 ## Test Hyperlinks
 
-[LinkChecker](https://wummel.github.io/linkchecker/) is a tool that allows to check all the hyperlinks in the site.
+[LinkChecker](https://wummel.github.io/linkchecker/) 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
+$ linkchecker http://localhost:8000
 ```
 
 The ```linkchecker``` output will display the broken link and there location
@@ -89,25 +97,25 @@ in the site.
 
     ```sh
     #recent version of git-review  (>=1.28.0 is required)
-    sudo pip3 install git-review 
+    $ sudo pip3 install git-review 
     ```
 
 2. Write commit message
 
     ```sh
     # track all the new changes
-    git add .
+    $ git add .
 
     # Write the commit message
-    git commit --signoff
+    $ git commit --signoff
     ```
 
 3. Push changes for review to Gerrit
 
     ```sh
     # first time only
-    git review -s
+    $ git review -s
 
     # then to push use
-    git review
+    $ git review
     ```
\ No newline at end of file