From 533fc29508879a64e36cd9e486844beec8dc162e Mon Sep 17 00:00:00 2001 From: "Karsten A. M. Guenther" Date: Tue, 16 Apr 2024 20:07:28 +0200 Subject: [PATCH] chore: fix glossary by adding review suggestions --- docs/getting_started/glossary.rst | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/getting_started/glossary.rst b/docs/getting_started/glossary.rst index f0001b7..d8f05dd 100644 --- a/docs/getting_started/glossary.rst +++ b/docs/getting_started/glossary.rst @@ -109,7 +109,7 @@ If a ``config.txt`` file is present in the :ref:`variant ` dir Pipeline -------- -A pipeline is a directed graph of steps with a single entry point and a single exit point. The steps are executed in a specific order. +A pipeline is a directed graph of :ref:`steps ` with a single entry point and a single exit point. The :ref:`steps ` are executed in a specific order. .. _glossary_platform: @@ -137,6 +137,14 @@ A quality gate is a check of quality criteria at the end of a pipeline. It is defined by the development team, e.g., by a test manager inside the pipeline configuration. It protects a branch of a repository. +.. _glossary_release: + +Release +------- + +A software version that fulfills a complete set of quality criteria. Usually this is sent to a customer. + + .. _glossary_snapshot: Snapshot @@ -145,13 +153,7 @@ Snapshot A software version that fulfills a certain set of quality criteria. Might be sent to a customer. -.. _glossary_release: - -Release -------- - -A software version that fulfills a complete set of quality criteria. Usually this is sent to a customer. - +.. _glossary_spl: Software Product Line (SPL) --------------------------- @@ -164,6 +166,8 @@ But they all start from some common :ref:`components ` like Thinking this way, making a new software is like building a new car but faster and easier because we already have the :ref:`components ` we need. +.. _glossary_spl_core: + SPL Core --------