From 8afc70f412404efc8eda8ca62741af4ad7504347 Mon Sep 17 00:00:00 2001 From: Jim Garlick Date: Fri, 6 Oct 2023 15:32:57 -0700 Subject: [PATCH] doc: add glossary references Problem: glossary terms are not referenced when used in guide documents. Reference them on first use in each document. --- doc/guide/interact.rst | 6 +++--- doc/guide/start.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/guide/interact.rst b/doc/guide/interact.rst index 47e7d7f7d055..c0c276710be1 100644 --- a/doc/guide/interact.rst +++ b/doc/guide/interact.rst @@ -166,9 +166,9 @@ socket and looks something like:: local:///tmp/flux-lMDa6Z/local-0 -In the *initial program* (batch script, interactive alloc shell, or whatever), -the FLUX_URI environment variable is set to the local URI of the rank 0 -broker. Flux commands in the initial program, which also runs on rank 0, +In the :term:`initial program` (batch script, interactive alloc shell, or +whatever), the FLUX_URI environment variable is set to the local URI of the rank +0 broker. Flux commands in the initial program, which also runs on rank 0, read FLUX_URI and reference the instance that started them. When running outside of an instance, FLUX_URI will not be set. In this case, diff --git a/doc/guide/start.rst b/doc/guide/start.rst index 5f438af5388e..09b25ca785d9 100644 --- a/doc/guide/start.rst +++ b/doc/guide/start.rst @@ -22,7 +22,7 @@ parallel, as a *parallel program* if you will. phases: #. Initialize -#. The rank 0 broker runs the **initial program** to completion +#. The rank 0 broker runs the :term:`initial program` to completion #. Finalize By default, the initial program is an interactive shell. If :man1:`flux-start`