#3074: Add KGO documentation.

ESMValGroup · Jun 19, 2024 · d9c4fc2 · d9c4fc2
1 parent cd4d187
commit d9c4fc2
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/adding_a_recipe.rst b/esmvaltool/utils/recipe_test_workflow/doc/source/adding_a_recipe.rst
@@ -61,7 +61,7 @@ in the ``[[COMPUTE]]`` section in the site-specific ``.cylc`` file in the
 
     cylc vip -O <site>
 
-#. Update the KGO:
+#. Update the Known Good Outputs (|KGOs|):
 
     #. Locate the workflow run folder of the workflow you just completed.
 

diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/common.txt b/esmvaltool/utils/recipe_test_workflow/doc/source/common.txt
@@ -8,6 +8,7 @@
 .. |ESMs| replace:: :term:`ESMs <ESM>`
 .. |ESMValCore| replace:: :term:`ESMValCore`
 .. |ESMValTool| replace:: :term:`ESMValTool`
+.. |KGOs| replace:: :term:`KGOs`
 .. |Rose| replace:: :term:`Rose`
 
 .. Links

diff --git a/esmvaltool/utils/recipe_test_workflow/doc/source/glossary.rst b/esmvaltool/utils/recipe_test_workflow/doc/source/glossary.rst
@@ -24,6 +24,13 @@ Glossary
      routine evaluation of |ESMs| in |CMIP|, see the
      `ESMValTool Documentation`_.
 
+   KGOs
+    Known Good Outputs are outputs from an ESMValTool recipe that have been
+    confirmed (typically by a scientist) to be as expected. KGOs are used in
+    the compare task in the |RTW| to check whether any changes have been
+    introduced to the outputs from an ESMValTool recipe after changes are made
+    to either ESMValCore or ESMValTool.
+
    Rose
      Rose is a toolkit for writing, editing and running application
      configurations, see the `Rose Documentation`_.