Skip to content

Commit

Permalink
doc: add glossary references
Browse files Browse the repository at this point in the history
Problem: glossary terms are not referenced when used in
guide documents.

Reference them on first use in each document.
  • Loading branch information
garlick committed Oct 9, 2023
1 parent 220ce0b commit 3a39a37
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions doc/guide/interact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,13 @@ 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,
commands fall back to the compiled-in URI of the Flux system instance.
commands fall back to the compiled-in URI of the Flux :term:`system instance`.
When there isn't a broker of the system instance running on the local node,
commands fail with an error like::

Expand Down
6 changes: 3 additions & 3 deletions doc/guide/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -280,8 +280,8 @@ can run Flux. No surprise there. What does that look like and how is it
leveraged to provide expected workload manager abstractions?

First let's try our workload commands in the "outer" Flux instance, in this
case a standalone system instance, although this section applies to all Flux
instances.
case a standalone :term:`system instance`, although this section applies to all
Flux instances.

.. code-block:: console
Expand Down

0 comments on commit 3a39a37

Please sign in to comment.