From 04ae17e58717419f2c997c320d4cda8e349fbb5e Mon Sep 17 00:00:00 2001
From: Christopher Haine <chaine@hpe.com>
Date: Wed, 7 Sep 2022 17:27:24 +0200
Subject: [PATCH] housekeeping
---
docs/sphinx/showroom.rst | 2 +-
docs/sphinx/stories.rst | 6 +++---
docs/sphinx/tuning.rst | 4 ++++
3 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/docs/sphinx/showroom.rst b/docs/sphinx/showroom.rst
index 7abf04eb..f2a091d9 100644
--- a/docs/sphinx/showroom.rst
+++ b/docs/sphinx/showroom.rst
@@ -1,7 +1,7 @@
Showroom
========
-"What can I use Maestro Core for?"
+"What can we use Maestro Core for?"
Overview
diff --git a/docs/sphinx/stories.rst b/docs/sphinx/stories.rst
index 8d165c19..a6257188 100644
--- a/docs/sphinx/stories.rst
+++ b/docs/sphinx/stories.rst
@@ -1,7 +1,7 @@
Users' Stories
==============
-"How can I do [...] with Maestro Core?"
+"How can we do [...] with Maestro Core?"
.. _user-metadata:
@@ -26,8 +26,8 @@ Users may define their own metadata, using a YAML schema:
Maestro Core will issue a warning.
...
-The schema syntax may be checked against Maestro Core meta-schema with `yamale
-<https://github.com/23andMe/Yamale>`__
+The schema syntax may be checked against Maestro Core meta-schema with a
+dedicated tool such as `yamale <https://github.com/23andMe/Yamale>`__
.. code-block:: shell
diff --git a/docs/sphinx/tuning.rst b/docs/sphinx/tuning.rst
index 614daeba..3503cbd9 100644
--- a/docs/sphinx/tuning.rst
+++ b/docs/sphinx/tuning.rst
@@ -10,6 +10,10 @@ Maestro features a range of environment variables, the full list and doc follows
Maestro is relying on OFI for network operations, therefore the usual OFI knobs
can also be played with.
+.. attention::
+ The following variables are the C-sides ones as extracted from doxygen. To get the environment variable name, just remove ``ENV_`` from the name.
+
+
.. doxygengroup:: MSTRO_ENV
Telemetry
--
GitLab