AQAVIT Terminology markdown (#5336)

* AQAVIT Teminonlogy markdown #5336 Signed-off-by: Sangyoon21 <[email protected]> * AQAVIT Teminonlogy markdown #5336 Signed-off-by: Sangyoon21 <[email protected]> * AQAVIT Teminonlogy markdown #5336 Signed-off-by: Sangyoon21 <[email protected]> * Update aqa-reference.markdown * Update docs/pages/aqa-reference.markdown Co-authored-by: Shelley Lambert <[email protected]> --------- Signed-off-by: Sangyoon21 <[email protected]> Co-authored-by: Shelley Lambert <[email protected]>
adoptium · May 23, 2024 · ba55ad9 · ba55ad9
1 parent e64cfd6
commit ba55ad9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/docs/pages/AQAvit-terminology.markdown b/docs/pages/AQAvit-terminology.markdown
@@ -0,0 +1,20 @@
+# AQAvit Terminology 
+
+---
+
+In AQAvit, we attempt to treat all types of test targets in the same way, to make it easier to automate and also easier to add new tests and onboard new people. This normalization starts with some agreed-upon common terminology, naming and labeling conventions, and repeatable/predictable behaviour applied across all types of test material.
+
+
+
+#### Quick review of the terminology used in AQAvit
+
+<img width="949" alt="Screenshot 2024-03-14 at 10 25 01 AM" src="https://github.com/adoptium/aqa-tests/assets/2836948/286dfdfc-39ac-4a4f-a9af-a487ade90836">
+
+
+* **group** indicates a collection of tests that are related in some way
+    * For example the openjdk group is related by where those tests are pulled from, they are the jtreg tests from the upstream OpenJDK project.
+* **level** refers to an arbitrarily divided subset of the tests in a group. The different levels that we divide tests into are sanity, extended, special and dev
+    * **sanity** level is meant to contain short-running tests that test regularly changing code and have shown to be often finding defects.
+    * **extended** level is meant to contain longer tests or tests that exercise code that is not changing as often or do not find defects as often
+    * **special** level is reserved for tests that need special setup or need to be handled in a special way
+    * **dev** level is for newly added tests and tests that are under-development or are somehow not stable and not yet ready to graduate to other levels
diff --git a/docs/pages/aqa-reference.markdown b/docs/pages/aqa-reference.markdown
@@ -1,3 +1,5 @@
 ## Reference
 
-- [How OpenJDK tests map to AQAvit test targets](How-OpenJDK-tests-map-to-AQAvit-test-targets.md)
+1. [AQAvit Terminology](AQAvit-terminology.markdown)
+
+2. [How OpenJDK tests map to AQAvit test targets](How-OpenJDK-tests-map-to-AQAvit-test-targets.md)