From 33727f4e9619f9da65fdfc608a10a92887c7257c Mon Sep 17 00:00:00 2001 From: Vinod Ahuja Date: Wed, 9 Nov 2022 13:02:42 -0600 Subject: Adding file naming and indexing Adding details of file naming convention and indexing the files. Bug-AGL: [SPEC-4470] Signed-off-by: Vinod Ahuja Change-Id: I189d725d2a4793f687826ffb4ecfca8c71b0f44a Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28130 Reviewed-by: Jan-Simon Moeller Tested-by: Jan-Simon Moeller --- docs/7_How_To_Contribute/8_Adding_Documentation.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'docs/7_How_To_Contribute') 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 | ├── ..... | | -| ├──_ -| | ├──_ -| | | ├──_.md +| ├──_ +| | ├──_ +| | | ├──_.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 [](../_/_/_.md) + + + ``` ## Test Hyperlinks -- cgit 1.2.3-korg