C-Docs: New structure

[csit.git] / docs / content / overview / csit / suite_generation.md

diff --git a/docs/content/methodology/suite_generation.md b/docs/content/overview/csit/suite_generation.md
similarity index 81%
rename from docs/content/methodology/suite_generation.md
rename to docs/content/overview/csit/suite_generation.md
index 4fa9dee..84a19b8 100644 (file)
--- a/docs/content/methodology/suite_generation.md
+++ b/docs/content/overview/csit/suite_generation.md
@@ -1,14 +1,13 @@
 ---
 title: "Suite Generation"
 ---
 title: "Suite Generation"

-weight: 19
+weight: 5

 ---
 
 # Suite Generation
 
 ---
 
 # Suite Generation
 

-CSIT uses robot suite files to define tests.
-However, not all suite files available for Jenkins jobs
-(or manually started bootstrap scripts) are present in CSIT git repository.
-They are generated only when needed.
+CSIT uses robot suite files to define tests. However, not all suite files
+available for Jenkins jobs (or manually started bootstrap scripts) are present
+in CSIT git repository. They are generated only when needed.

 
 ## Autogen Library
 
 
 ## Autogen Library
 


@@ -35,7 +34,7 @@ the same content, it is one of checks that autogen works correctly.
 
 Not all suites present in CSIT git repository act as template for autogen.
 The distinction is on per-directory level. Directories with
 
 Not all suites present in CSIT git repository act as template for autogen.
 The distinction is on per-directory level. Directories with

-regenerate_testcases.py script usually consider all suites as templates
+`regenerate_testcases.py` script usually consider all suites as templates

 (unless possibly not included by the glob patten in the script).
 
 The script also specifies minimal frame size, indirectly, by specifying protocol
 (unless possibly not included by the glob patten in the script).
 
 The script also specifies minimal frame size, indirectly, by specifying protocol


@@ -43,25 +42,25 @@ The script also specifies minimal frame size, indirectly, by specifying protocol
 
 ### Constants
 
 
 ### Constants
 

-Values in Constants.py are taken into consideration when generating suites.
+Values in `Constants.py` are taken into consideration when generating suites.

 The values are mostly related to different NIC models and NIC drivers.
 
 ### Python Code
 
 The values are mostly related to different NIC models and NIC drivers.
 
 ### Python Code
 

-Python code in resources/libraries/python/autogen contains several other
+Python code in `resources/libraries/python/autogen` contains several other

 information sources.
 
 #### Testcase Templates
 
 The test case part of template suite is ignored, test case lines
 information sources.
 
 #### Testcase Templates
 
 The test case part of template suite is ignored, test case lines

-are created according to text templates in Testcase.py file.
+are created according to text templates in `Testcase.py` file.

 
 #### Testcase Argument Lists
 
 Each testcase template has different number of "arguments", e.g. values
 to put into various placeholders. Different test types need different
 
 #### Testcase Argument Lists
 
 Each testcase template has different number of "arguments", e.g. values
 to put into various placeholders. Different test types need different

-lists of the argument values, the lists are in regenerate_glob method
-in Regenerator.py file.
+lists of the argument values, the lists are in `regenerate_glob` method
+in `Regenerator.py` file.

 
 #### Iteration Over Values
 
 
 #### Iteration Over Values
 


@@ -103,9 +102,9 @@ only in testbeds/NICs with TG-TG line available.
 
 #### Other Topology Info
 
 
 #### Other Topology Info
 

-Some bonding tests need two (parallel) links between DUTs.
-Autogen does not care, as suites are agnostic.
-Robot tag marks the difference, but the link presence is not explicitly checked.
+Some bonding tests need two (parallel) links between DUTs. Autogen does not
+care, as suites are agnostic. Robot tag marks the difference, but the link
+presence is not explicitly checked.

 
 ### Job specs
 
 
 ### Job specs