From db1a27f5ca24278730b4bc686ba080ca7a1d1ccc Mon Sep 17 00:00:00 2001
From: Mohammad Torkashvand <mohammad.torkashvand@geant.org>
Date: Tue, 5 Nov 2024 15:23:49 +0100
Subject: [PATCH] add Moodi to our glossary

---
 docs/source/glossary.rst    | 3 +++
 gso/utils/workflow_steps.py | 4 ++--
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index 59b699e5..b646c999 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -116,3 +116,6 @@ Glossary of terms
 
   WFO
     `Workflow Orchestrator <https://workfloworchestrator.org/>`_
+
+  Moodi
+    A service that does monitoring on demand during a workflow execution.
\ No newline at end of file
diff --git a/gso/utils/workflow_steps.py b/gso/utils/workflow_steps.py
index 01a64e58..0a56f4da 100644
--- a/gso/utils/workflow_steps.py
+++ b/gso/utils/workflow_steps.py
@@ -396,7 +396,7 @@ _is_moodi_enabled = conditional(lambda _: load_oss_params().MOODI.moodi_enabled)
 
 
 def start_moodi() -> StepList:
-    """Start monitoring on demand using Moodi Telemetry stack."""
+    """Start monitoring on demand using :term:`Moodi` Telemetry stack."""
     host = load_oss_params().MOODI.host
 
     @step("Start Moodi")
@@ -411,7 +411,7 @@ def start_moodi() -> StepList:
 
 
 def stop_moodi() -> StepList:
-    """Stop Moodi Telemetry monitoring on demand."""
+    """Stop :term:`Moodi` Telemetry monitoring on demand."""
     host = load_oss_params().MOODI.host
 
     @step("Stop Moodi")
-- 
GitLab