Skip to content

Move fioctl reference to appendix #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged

Move fioctl reference to appendix #835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .jobserv.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
0 ...eference-manual/factory/fioctl/fioctl.rst → ...endix/fioctl-command-reference/fioctl.rst
View file
Open in desktop
File renamed without changes.
0 ...reference-manual/factory/fioctl/index.rst → ...pendix/fioctl-command-reference/index.rst
View file
Open in desktop
File renamed without changes.
6 changes: 6 additions & 0 deletions source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions source/reference-manual/factory/factory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<ref-event-queues>` helps with managing a large number of devices.
* :ref:`event queues<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`.
Expand All @@ -22,7 +21,6 @@ The FoundriesFactory :ref:`sbom` (SBOM) feature can assist with for license comp

Factory Sources <factory-sources.rst>
factory-definition
Fioctl <fioctl/index.rst>
sboms
api-access
ci-webhooks
Expand Down