From ceb2c923f4bb06007e568b52c2f70a2df69b5ac5 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Mon, 8 May 2023 15:09:25 +0200
Subject: [PATCH] update docs
---
docs/source/index.rst | 6 +++---
docs/source/quickstart.rst | 1 +
lso/__init__.py | 2 +-
lso/playbook.py | 4 ++--
4 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 85ec421..73d885f 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,7 +1,7 @@
-GOAT Lightweight Service Orchestrator
-=====================================
+Lightweight service orchestrator
+================================
-Documentation for LSO: a Lightweight Service Orchestrator
+Documentation for LSO (Lightweight Service Orchestrator).
.. toctree::
:maxdepth: 1
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
index fe28eb9..4258a1a 100644
--- a/docs/source/quickstart.rst
+++ b/docs/source/quickstart.rst
@@ -35,6 +35,7 @@ Running the app
-------------------
* Create a settings file, see `config.json.example` for an example.
+* If necessary, set the environment vairable `ANSIBLE_HOME` to a custom path.
* Run the app like this (`app.py` starts the server on port 44444):
.. code-block:: bash
diff --git a/lso/__init__.py b/lso/__init__.py
index 757477d..84133fb 100644
--- a/lso/__init__.py
+++ b/lso/__init__.py
@@ -34,7 +34,7 @@ def create_app():
app.include_router(default.router, prefix='/api')
app.include_router(device.router, prefix='/api/device')
- # test that config params are available and can be loaded
+ # test that config params are loaded and available
config.load()
logging.info('FastAPI app initialized')
diff --git a/lso/playbook.py b/lso/playbook.py
index c3d403f..c9fb60d 100644
--- a/lso/playbook.py
+++ b/lso/playbook.py
@@ -117,8 +117,8 @@ def run_playbook(
:param dict extra_vars: Any extra vars needed for the playbook to run.
:param str inventory: The inventory that the playbook is executed against.
:param str callback: Callback URL where the playbook should send a status
- update when execution is completed. This is used for WFO to continue
- with the next step in a workflow.
+ update when execution is completed. This is used for
+ workflow-orchestrator to continue with the next step in a workflow.
:return: Result of playbook launch, this could either be successful or
unsuccessful.
:rtype: :class:`PlaybookLaunchResponse`
--
GitLab