Update general and existing glossary terms

The glossary was cleaned up a bit, new terms added, as well as links to related topic pages. Links to glossary terms were added in a few areas, with a focus on the 'getting started' sections. This is the first of a handful of PR commits meant to update the glossary. QA Steps: Ran build, examined output. No issues spotted. Linkcheck failed due to unrelated issue which has been identified and will be updated separately. This commit addresses FFTK-3008 Signed-off-by: Katrina Prosise <[email protected]>
foundriesio · Mar 6, 2024 · f9aa4d7 · f9aa4d7
1 parent a38630d
commit f9aa4d7
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 36 deletions.
diff --git a/source/getting-started/building-deploying-app/index.rst b/source/getting-started/building-deploying-app/index.rst
@@ -56,7 +56,7 @@ Push all committed modifications to the remote repository:
 Once your changes to the :term:`containers.git` repository were pushed, the FoundriesFactory® CI automatically started a new ``container-main`` build.
 Go to https://app.foundries.io, select your Factory and click on :guilabel:`Targets`:
 
-The latest **Target** named :guilabel:`containers-main` should be the CI job you just created.
+The latest :term:`Target` named :guilabel:`containers-main` should be the CI job you just created.
 
 .. figure:: /_static/tutorials/creating-first-target/tutorial-find-build.png
    :width: 900

diff --git a/source/getting-started/flash-device/index.rst b/source/getting-started/flash-device/index.rst
@@ -28,10 +28,10 @@ Prerequisites and Pre-Work
 
 .. _gs-download:
 
-Downloading the LmP System Image
---------------------------------
+Downloading the System Image
+----------------------------
 
-After a successful build, FoundriesFactory produces build artifacts which can be downloaded from the :guilabel:`Targets` tab of your Factory.
+After a successful build, FoundriesFactory produces build artifacts which can be downloaded from the :guilabel:`Targets` tab of your :term:`Factory`.
 
 #. Navigate to the :guilabel:`Targets` section of your Factory.
 
@@ -69,7 +69,7 @@ Please refer to this section for specifics on flashing your system image using t
 See :ref:`ref-qemu` for booting Qemu images.
 
 .. note::
-   LmP enforces eMMC boot whenever possible as this is the path to enable all security features it provides. So for platforms with available eMMC, such as the NXP® i.MX EVKs, booting from eMMC rather than SD is highly recommended and enabled by default.
+   The :term:`Linux microPlatform` (LmP) enforces eMMC boot whenever possible as this is the path to enable all security features it provides. So for platforms with available eMMC, such as the NXP® i.MX EVKs, booting from eMMC rather than SD is highly recommended and enabled by default.
 
 .. _gs-boot:
 

diff --git a/source/getting-started/signup/index.rst b/source/getting-started/signup/index.rst
@@ -19,7 +19,7 @@ Creating Your Factory
 =====================
 
 :ref:`ref-factory` is the start of your embedded OS, tailored specifically for your product.
-When you create a Factory, we immediately bootstrap the CI build process.
+When you create a :term:`Factory`, we immediately bootstrap the CI build process.
 This generates an unmodified :ref:`ref-linux` OS Image, which is from this point onward, **owned by you**.
 
 When your account is created, it is not associated with any factories.
@@ -82,7 +82,7 @@ Additionally, you will receive an email once the Factory initial setup is comple
    FoundriesFactory Targets
 
 Targets are a reference to a platform image and Docker applications.
-When developers push code, FoundriesFactory produces a new target.
+When developers push code, FoundriesFactory produces a new :term:`Target`.
 Registered devices then update and install Targets.
 
 .. note::

diff --git a/source/glossary/index.rst b/source/glossary/index.rst
@@ -4,34 +4,78 @@ Terminology
 .. Glossary::
    :sorted:
 
+   FoundriesFactory
+     :term:`Foundries.io`'s Cloud native DevSecOps platform.
+     Used for building, testing, deploying and maintaining Linux-based devices.
+     Includes the :term:`Linux microPlatform` distro, OTA update mechanisms, and management tools, such as Fioctl.
+     An instance of FoundriesFactory—customized to your needs and machine—is a :term:`Factory`.
+
+   Foundries.io
+     Provider of FoundriesFactory® DevSecOps platform and the :term:`Linux microPlatform`\™ OS.
+     `Website <https://foundries.io>`_.
+
+   Factory
+     An instance of :term:`FoundriesFactory` tailored to your device and needs.
+     Created to support a specific machine.
+     A Factory produces :term:`Target`\s.
+
+     * :ref:`Account Management, Factory <account-management>`
+     * :ref:`Creating, Factory <gs-signup>`
+     * :ref:`Git repositories, Factory <ref-factory-sources>`
+
+   Fioctl
+     Factory management tool to interact with the Foundries.io REST API.
+     Source code available via the `Fioctl GitHub repo <https://github.com/foundriesio/fioctl>`_.
+
+     * :ref:`Installing, Fioctl <gs-install-fioctl>`
+     * :ref:`Example use, Fioctl <ug-fioctl>`
+
+   Aktualizr-lite
+     Default Update agent for FoundriesFactory.
+
+     * :ref:`Reference Manual, Aktualizr-lite <ref-aktualizr-lite>`
+
+   Linux microPlatform  
+   LmP
+     The FoundriesFactory embedded Linux distro included in your Factory.
+     Included via the ``meta-lmp`` Layer.
+     Source code available via the `meta-lmp GitHub repo <https://github.com/foundriesio/meta-lmp>`_.
+
+     * :ref:`Reference Manual, LmP <ref-linux>`
+     * :ref:`Updating, LmP <ref-linux-update>`
+     * :ref:`Test plan, LmP <ref-lmp-testplan>`
+     * :ref:`Customizing, LmP <tutorial-customizing-the-platform>`
+     * :ref:`Porting, LmP <ref-pg>`
+
    Target
-     A description of the software a device should run. This description is
-     visible as metadata in :term:`targets.json`. Includes details such as OSTree
-     Hash and Docker-Compose App URIs, but is arbitrary.
+     A description of the software a device should run. This description is visible as metadata in :term:`targets.json`.
+     Includes details such as OSTree Hash and Docker-Compose App URIs, but are arbitrary.
 
-   targets.json
-     Part of `TUF Metadata <https://theupdateframework.com/metadata/>`_ that
-     specifies what Targets are valid to install. It can be summarized with
-     ``fioctl targets list`` or viewed in full with ``fioctl targets list
-     --raw``
+     * :ref:`Tutorial, Target <tutorial-creating-first-target>`
 
    Docker-Compose App
-     Also referred to as 'app'. A folder in :term:`containers.git`, containing a
-     `docker-compose.yml`. The name of this folder is the name of your
-     **Docker-Compose App**. Appending ``.disabled`` to the name of the folder will
-     prevent it from being built by the Foundries.io CI/CD.
-
-   MACHINE
-     The Yocto machine name. Officially supported by Foundries if listed
-     in :ref:`ref-linux-supported`
-
-   system image
-     The OS image produced by the Factory that is flashed to all devices. The
-     build artifact is usually named ``lmp-factory-image-<hardware-id>.wic.gz``
-
-   factory-config.yml
-     A file in the :term:`ci-scripts.git` repository of the Factory which
-     controls all configurable aspects of a Factory. Such as
-     :ref:`ref-advanced-tagging`, :ref:`ug-container-preloading`
-     and email alerts.
+   Compose App
+     Also referred to as app. A folder in :term:`containers.git`, containing a ``docker-compose.yml``.
+     The name of this folder is the name of your Docker-Compose App.
+
+     * :ref:`Tutorial, Compose Apps <tutorial-compose-app>`
+     * :ref:`User Guide, Compose Apps <ref-compose-apps>`
+
+   System Image
+     The OS image produced by the Factory that is flashed to all devices.
+     The build artifact is usually named ``lmp-factory-image-<hardware-id>.wic.gz``
+
+   ``factory-config.yml``
+     A file in the :term:`ci-scripts.git` repository of the Factory which controls all configurable aspects of a Factory.
+     Such as :ref:`ref-advanced-tagging`, :ref:`ug-container-preloading` and email alerts.
+
+     * `Factory Definition Reference Manual <ref-factory-definition>`
+
+   ``targets.json``
+     Part of `TUF Metadata <https://theupdateframework.com/metadata/>`_ that specifies what Targets are valid to install.
+     It can be summarized with ``fioctl targets list``, or viewed in full with ``fioctl targets list --raw``
+
+   ``MACHINE``
+     The Yocto machine name.
+     Officially supported by Foundries if listed in :ref:`ref-linux-supported`.
 
diff --git a/source/reference-manual/factory/factory.rst b/source/reference-manual/factory/factory.rst
@@ -3,7 +3,7 @@
 FoundriesFactory
 ================
 
-**FoundriesFactory®**: The set of tools, services, and support that enable a Factory and assist it throughout the device lifecycle.
+**FoundriesFactory®**: The set of tools, services, and support that enable a :term:`Factory` and assist it throughout the device lifecycle.
 This section provides support for working with and customizing FoundriesFactory and the LmP.
 
 * Topics that deal with how CI functions include :ref:`ref-factory-definition` and :ref:`ref-ci-webhooks`.

diff --git a/source/user-guide/account-management/account-management.rst b/source/user-guide/account-management/account-management.rst
@@ -3,8 +3,8 @@
 Factory & Account Management
 ============================
 
-This section covers topics related to using the FoundriesFactory® web UI.
-This includes managing your subscription, adding members to your Factory,
+This section covers topics related to using the :term:`FoundriesFactory`\® web UI.
+This includes managing your subscription, adding members to your :term:`Factory`,
 or setting who can interact with devices and access source code.
 
 .. toctree::