Skip to content
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

Improve introduction of fioctl guide #782

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Improve introduction of fioctl guide #782

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
13 changes: 8 additions & 5 deletions source/user-guide/fioctl/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,24 @@
Fioctl
======

This section provides details on using :ref:`Fioctl® <ref-fioctl>` by way of example.
Fioctl is an Open Source CLI tool for managing your Factory by providing a way to interact with the FoundriesFactory REST API.

Check warning on line 6 in source/user-guide/fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Fioctl-trademark] 'Fioctl' should be marked as a registered trademark first time it occurs in body of text and used as an adjective.

Raw Output:
{"message": "[Fio-docs.Fioctl-trademark] 'Fioctl' should be marked as a registered trademark first time it occurs in body of text and used as an adjective.", "location": {"path": "source/user-guide/fioctl/index.rst", "range": {"start": {"line": 6, "column": 1}}}, "severity": "WARNING"}

Check warning on line 6 in source/user-guide/fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.

Raw Output:
{"message": "[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.", "location": {"path": "source/user-guide/fioctl/index.rst", "range": {"start": {"line": 6, "column": 101}}}, "severity": "WARNING"}

Prerequisites
-------------
.. tip::
Fioctl releases happen independently of LmP releases.

Check warning on line 9 in source/user-guide/fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Fioctl-trademark] 'Fioctl' should be marked as a registered trademark first time it occurs in body of text and used as an adjective.

Raw Output:
{"message": "[Fio-docs.Fioctl-trademark] 'Fioctl' should be marked as a registered trademark first time it occurs in body of text and used as an adjective.", "location": {"path": "source/user-guide/fioctl/index.rst", "range": {"start": {"line": 9, "column": 4}}}, "severity": "WARNING"}

* Completion of the getting started guide.
* :ref:`Installing Fioctl <gs-install-fioctl>`
* :ref:`Fioctl reference manual <ref-fioctl>`
* `Fioctl source <https://github.com/foundriesio/fioctl>`_

Below you will find examples of common tasks and commands.

.. _ug-fioctl-auto-update:

Auto Updating
-------------

``fioctl version --update-to <version>``
Fioctl v0.36 and later can be updated—rather securely, via TUF—without the need to manually reinstall the binary.
Fioctl can be updated—securely via TUF—without needing to manually reinstall the binary.

Check warning on line 23 in source/user-guide/fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Fioctl-trademark] 'Fioctl' should be marked as a registered trademark first time it occurs in body of text and used as an adjective.

Raw Output:
{"message": "[Fio-docs.Fioctl-trademark] 'Fioctl' should be marked as a registered trademark first time it occurs in body of text and used as an adjective.", "location": {"path": "source/user-guide/fioctl/index.rst", "range": {"start": {"line": 23, "column": 3}}}, "severity": "WARNING"}

Check warning on line 23 in source/user-guide/fioctl/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.expand-acronyms] 'TUF' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.

Raw Output:
{"message": "[Fio-docs.expand-acronyms] 'TUF' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/user-guide/fioctl/index.rst", "range": {"start": {"line": 23, "column": 38}}}, "severity": "WARNING"}

.. code-block:: console

Expand Down
Loading