add glossary

Author: gilesknap

docs/reference/cli.rst

@@ -3,29 +3,22 @@
 Command Line Interface for IOC Management
 =========================================
 
-The python project ``epics-containers-cli`` is installed as part of the
-Python section of the initial tutorial `../tutorials/setup_workstation`.
-It provides a command line function ``ec`` with support for:
+The python project `edge-containers-cli` is installed as part of the Python section of the initial tutorial `../tutorials/setup_workstation`. It provides a command line function ``ec`` with support for:
 
 - deploying, managing and debugging IOCs and other application Instances
 
-The CLI is just a thin wrapper around the underlying tools that do the real
-work:
+The CLI is just a thin wrapper around the underlying tools that do the real work:
 
 :kubectl: the command line interface to the Kubernetes APIs
 :helm: the command line interface to the Kubernetes Helm package manager
 :podman (or docker): CLIs for container engines
 :git: the git version control system client
 
-``ec`` is useful because it saves typing and provides a consistent interface
-when working on multiple beamlines. This is because it uses the environment
-setup by the beamline repo's ``environment.sh`` script. See `environment`.
+``ec`` is useful because it saves typing and provides a consistent interface when working on multiple `ec-services-repo` s. This is because it uses the environment setup by the beamline repo's ``environment.sh`` script. See `environment`.
 
 To see the available commands, run ``ec --help``.
 
-It may be instructive to understand the underlying tools and how they are
-are being called. For this reason ``ec`` supports a ``-v`` option to show
-the underlying commands being executed. e.g.
+It may be instructive to understand the underlying tools and how they are being called. For this reason ``ec`` supports a ``-v`` option to show the underlying commands being executed. e.g.
 
 .. raw:: html
 

docs/reference/environment.rst

@@ -1,3 +1,4 @@
+
 The Environment Configuration File
 ==================================
 

docs/reference/glossary.md

@@ -0,0 +1,12 @@
+
+# Glossary
+
+(ec-services-repo)=
+## ec-services repository
+
+A repository that contains the definitions for a group of IOC and service instances that are deployed in a Kubernetes cluster. The grouping of instances is up to the facility. At DLS the instances are grouped by beamline, accelerator groupings are by location or by technical domain as appropriate.
+
+(edge-containers-cli)=
+## edge-containers-cli
+
+A command line tool for deploying and managing service and IOC instances within an [](ec-services-repo). So named 'edge' containers because these services all run close to the hardware. Historically this tool was called epics containers cli and both versions use the command line entry point ``ec``.

docs/tutorials/create_beamline.rst

@@ -3,7 +3,7 @@
 Create a Beamline Repository
 ============================
 
-In this tutorial we will create a new beamline source repository.
+In this tutorial we will create a new `ec-services-repo`.
 
 All IOC Instances that we deploy will be grouped into domains and each
 domain will have its own repository which defines those Instances.

docs/tutorials/setup_workstation.rst

@@ -140,15 +140,15 @@ environment again. (Or place its bin folder in your path permanently).
 
 .. _ec:
 
-epics-containers-cli
+edge-containers-cli
 ~~~~~~~~~~~~~~~~~~~~
 
 Above we set up a python virtual environment. Now we will install
-the epics-containers-cli python tool into that environment.
+the `edge-containers-cli` python tool into that environment.
 
 .. code-block:: bash
 
-    pip install epics-containers-cli
+    pip install edge-containers-cli
 
 This is the developer's 'outside of the container' helper tool. The command
 line entry point is ``ec``. We will be using many ``ec`` command line