diff --git a/docs/sphinx/showroom.rst b/docs/sphinx/showroom.rst index 7abf04eb5545fd5e130a12b23a09bb0c6fa1b0ea..f2a091d9a8c5b679554fc5da378a31268c1852d8 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 8d165c19f85755dc3fe88bf7bf85a148b267f144..a6257188af7eb8e5127b81f70861e33f75205837 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 614daebacab45829fc55be7825cd7000612f313c..3503cbd9bbaa8bc3bd923f5110e23be8b6a9fa41 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