From 4223e16cc0d98780f973d7907a64f19b51f0c671 Mon Sep 17 00:00:00 2001 From: Karel van Klink <karel.vanklink@geant.org> Date: Wed, 5 Jul 2023 16:36:44 +0200 Subject: [PATCH] update documentation --- docs/source/conf.py | 2 +- docs/source/index.rst | 2 +- docs/source/quickstart.rst | 8 +------- docs/vale/styles/Vocab/geant-jargon/accept.txt | 1 + 4 files changed, 4 insertions(+), 9 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e5cf04f..fdc60eb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -49,7 +49,7 @@ def setup(app): # -- Project information ----------------------------------------------------- project = 'Lightweight Service Orchestrator' -copyright = '2023, GÉANT' +copyright = '2023, GÉANT Vereniging' author = 'GÉANT Orchestration & Automation Team' # -- General configuration --------------------------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index 73d885f..1a75263 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,7 +8,7 @@ Documentation for LSO (Lightweight Service Orchestrator). :caption: Contents: quickstart - modules + lso `Swagger API Docs <_static/openapi.html>`__ diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 4258a1a..9d8f2db 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -50,10 +50,4 @@ Examples curl http://localhost:44444/api/version -* (Not available yet) List all available playbooks - - .. code-block:: bash - - curl http://localhost:44444/api/playbook - -* View the docs by loading `http://localhost:44444/docs` in your browser +* View the docs by loading <http://localhost:44444/docs> in your browser diff --git a/docs/vale/styles/Vocab/geant-jargon/accept.txt b/docs/vale/styles/Vocab/geant-jargon/accept.txt index 3303705..41520f5 100644 --- a/docs/vale/styles/Vocab/geant-jargon/accept.txt +++ b/docs/vale/styles/Vocab/geant-jargon/accept.txt @@ -1,2 +1,3 @@ [LSO|lso] [Ss]ubpackages +Vereniging -- GitLab