From 26acace0b5dbbf5f470cfd9ff129e9009673cbba Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Thu, 22 May 2025 10:38:18 -0400 Subject: [PATCH] Move fioctl reference to appendix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Files renamed, ``.jobserv.yml`` updated. QA: checked rendered output, and ran `fioctl gen-rst` to check that autogenerated content will work. This commit applies to issue FFTK-1810, "Move fioctl…reference…appendix" Signed-off-by: Katrina Prosise --- .jobserv.yml | 2 +- .../fioctl => appendix/fioctl-command-reference}/fioctl.rst | 0 .../fioctl => appendix/fioctl-command-reference}/index.rst | 0 source/index.rst | 6 ++++++ source/reference-manual/factory/factory.rst | 4 +--- 5 files changed, 8 insertions(+), 4 deletions(-) rename source/{reference-manual/factory/fioctl => appendix/fioctl-command-reference}/fioctl.rst (100%) rename source/{reference-manual/factory/fioctl => appendix/fioctl-command-reference}/index.rst (100%) diff --git a/.jobserv.yml b/.jobserv.yml index eb306d238..4efc1fea9 100644 --- a/.jobserv.yml +++ b/.jobserv.yml @@ -23,7 +23,7 @@ scripts: export fv=$(wget -q -O- https://api.github.com/repos/foundriesio/fioctl/releases/latest | grep tag_name | sed -E 's/.*"([^"]+)".*/\1/') wget -O /tmp/fioctl https://github.com/foundriesio/fioctl/releases/download/${fv}/fioctl-linux-amd64 chmod +x /tmp/fioctl - /tmp/fioctl gen-rst ./source/reference-manual/factory/fioctl/ + /tmp/fioctl gen-rst ./source/appendix/fioctl-command-reference/ make OUTDIR=/archive SPHINXBUILD=sphinx-build singlehtml html diff --git a/source/reference-manual/factory/fioctl/fioctl.rst b/source/appendix/fioctl-command-reference/fioctl.rst similarity index 100% rename from source/reference-manual/factory/fioctl/fioctl.rst rename to source/appendix/fioctl-command-reference/fioctl.rst diff --git a/source/reference-manual/factory/fioctl/index.rst b/source/appendix/fioctl-command-reference/index.rst similarity index 100% rename from source/reference-manual/factory/fioctl/index.rst rename to source/appendix/fioctl-command-reference/index.rst diff --git a/source/index.rst b/source/index.rst index dfdf33bb9..0cf3e20e1 100644 --- a/source/index.rst +++ b/source/index.rst @@ -116,6 +116,12 @@ Documentation Overview glossary/index +.. toctree:: + :caption: Appendix + :name: sec-appendix + + appendix/fioctl-command-reference/index + .. toctree:: :caption: Release Notes :name: sec-release-notes diff --git a/source/reference-manual/factory/factory.rst b/source/reference-manual/factory/factory.rst index fdd68e631..d11e849ec 100644 --- a/source/reference-manual/factory/factory.rst +++ b/source/reference-manual/factory/factory.rst @@ -8,8 +8,7 @@ This section provides support for working with and customizing FoundriesFactory * Topics that deal with how CI functions include :ref:`ref-factory-definition` and :ref:`ref-ci-webhooks`. -* :ref:`ref-fioctl` provides a helpful CLI tool for :ref:`ref-api-access`, - while using :ref:`event queues` helps with managing a large number of devices. +* :ref:`event queues` helps with managing a large number of devices. Each Factory has a set of git repositories used for customizing the LmP platform, defining container and Docker Compose apps, and managing CI build jobs. These repositories are explored under :ref:`ref-factory-sources`. @@ -22,7 +21,6 @@ The FoundriesFactory :ref:`sbom` (SBOM) feature can assist with for license comp Factory Sources factory-definition - Fioctl sboms api-access ci-webhooks