summaryrefslogtreecommitdiffstats
path: root/docs/7_How_To_Contribute
diff options
context:
space:
mode:
authorVinod Ahuja <vahuja@unomaha.edu>2022-11-09 13:02:42 -0600
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2022-11-14 14:08:05 +0000
commit33727f4e9619f9da65fdfc608a10a92887c7257c (patch)
tree37dfba0923413e47bdd4f17a02ab928e6c2fd7da /docs/7_How_To_Contribute
parent8be9db6f309e1e1b547e187c5db6ceac15f85a50 (diff)
Adding file naming and indexing
Adding details of file naming convention and indexing the files. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu> Change-Id: I189d725d2a4793f687826ffb4ecfca8c71b0f44a Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28130 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/7_How_To_Contribute')
-rw-r--r--docs/7_How_To_Contribute/8_Adding_Documentation.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/7_How_To_Contribute/8_Adding_Documentation.md b/docs/7_How_To_Contribute/8_Adding_Documentation.md
index 7797ab5..3777ecc 100644
--- a/docs/7_How_To_Contribute/8_Adding_Documentation.md
+++ b/docs/7_How_To_Contribute/8_Adding_Documentation.md
@@ -49,16 +49,23 @@ Find existing or add new markdowns in the following directory structure.
```sh
documentation
├── docs
-│   ├── 0_Getting_Started
+│   ├── 1_Getting_Started
│   │   ├── 1_Quickstart
│   │   └── 2_Building_AGL_Image
| ├── .....
| |
-| ├──<Chapter-Number>_<Chapter-Name>
-| | ├──<Subchapter-Number>_<Subchapter-Name>
-| | | ├──<Index-Number>_<Markdown-Title>.md
+| ├──<Chapter_Number>_<Chapter_Name>
+| | ├──<Subchapter_Number>_<Subchapter_Name>
+| | | ├──<Index_Number>_<Markdown_Title>.md
| | | ├── .....
```
+**File Naming convention** AGL follows Snake Case (snake_case) naming convention to name the documentation files.
+This type of naming combines words simply by replacing the space with an underscore (_).
+All the names will also include a index number before the name.
+Index number will use two digit numbers from 01-99 followed by name of the file.
+For example: If the file name is Build Process then it will be written as 01_build_process.md
+
+**Note:** If a file needs to be inserted in between already created sequences, then the index number will be the last index number followed by new numbering. For example, A new file is inserted between 06-07, then the index number for the new file will be 07_01, as in gist sorting, 07_01 will appear after 06 and before 07.
## Markdown Formatting
@@ -74,6 +81,9 @@ documentation
```sh
[<enter-title>](../<Chapter-Number>_<Chapter-Name>/<Subchapter-Number>_<Subchapter-Name>/<Index-Number>_<Markdown-Title>.md)
+
+
+
```
## Test Hyperlinks