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.

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

Apply minor updates and fixes to documentation #778

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified source/_static/install-fioctl/application_credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/signup/build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/signup/create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/signup/no-factories.png
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem to match the old file.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/signup/signup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion source/getting-started/building-deploying-app/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ This will be covered this in more detail later.

When the container build finishes, the device will download and start the shellhttpd application.

Check the device status on the :guilabel:`devices` page and wait the ``shellhttpd`` on :guilabel:`APPS` and the green light on :guilabel:`STATUS`.
Check the device status on the :guilabel:`devices` page.
Watch for the green light under :guilabel:`STATUS`.

.. figure:: /_static/tutorials/deploying-first-app/tutorial-device.png
:width: 900
Expand Down
12 changes: 9 additions & 3 deletions source/getting-started/emulation-with-qemu/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,22 @@ Prerequisites and Pre-Work
.. figure:: /_static/qemu/example_factory_arm64.png
:width: 900
:align: center
:alt: QEMU Arm 64 bit example factory
:alt: QEMU Arm 64 bit example Factory

QEMU ARM Example Factory

Emulating Device
--------------------------
----------------

1. Go to the `Targets` tab of your Factory and download the ``lmp-base-console-image-qemuarm64-secureboot.wic.gz`` image and the ``flash.bin``:
1. Go to the `Targets` tab of your Factory and download ``lmp-base-console-image-qemuarm64-secureboot.wic.gz`` and ``flash.bin``:

.. figure:: /_static/qemu/example_required_artefacts.png
:width: 900
:align: center
:alt: Artifacts which are required to run the image with QEMU

Required QEMU artifacts

2. Make a directory for the artifacts and cd into it:

.. code-block:: shell
Expand Down Expand Up @@ -101,6 +105,8 @@ Once you’ve converted and resized the image, you can then use it with your QEM
:align: center
:alt: Login

QEMU device login

.. note::

If you are not prompted for login, press ``Enter`` to check if it gets displayed.
Expand Down
14 changes: 6 additions & 8 deletions source/getting-started/flash-device/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ Downloading the System Image

After a successful build, the FoundriesFactory™ Platform 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.

#. Click the Target with the ``prebuilt-target`` :guilabel:`Trigger`.
#. Navigate to the :guilabel:`Targets` tab of your Factory.

.. figure:: /_static/flash-device/devel.png
:width: 769
:align: center
:alt: Targets tab showing prebuilt-target

#. Expand the :guilabel:`Targets` tab clicking on it.
Target tab

#. Expand the Target information by clicking on the one named ``prebuilt-target`` on it.
This shows a link to the Factory image artifact.
Download the Factory image for your machine:

Expand All @@ -53,6 +53,8 @@ After a successful build, the FoundriesFactory™ Platform produces build artifa
:align: center
:alt: Targets tab displaying available artifacts

Target artifacts

.. note::
Most platforms require more than the ``lmp-base-console-image-<machine_name>.wic.gz`` artifact for flashing.
The required artifacts are board specific and listed on respective pages under :ref:`ref-boards` or under :ref:`ref-qemu`.
Expand Down Expand Up @@ -179,7 +181,3 @@ If the above methods to SSH into your board do not work, there are additional th

.. _Rufus: https://rufus.ie

.. todo::

Make a section dedicated to the i.MX platform to link to in the "Flash LmP
system image" section note, regarding flashing eMMC.
2 changes: 1 addition & 1 deletion source/getting-started/install-fioctl/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Go to `Application Credentials <https://app.foundries.io/settings/credentials>`_

Complete with a **Description** and the **Expiration date** and select :guilabel:`next`.

For Fioctl®, check the :guilabel:`Use for tools like fioctl` box and select your **Factory**.
Check the :guilabel:`Use for tools like fioctl` box and select your **Factory**.
You can revoke this access and set up a new credential later once you are familiar with the :ref:`ref-api-access`.

.. figure:: /_static/install-fioctl/fioctl_token.png
Expand Down
4 changes: 4 additions & 0 deletions source/user-guide/account-management/account-roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ The owner then sends invites via the :guilabel:`Member` tab on their Factory pag
:align: center
:alt: sending member invites

Inviting members to Factory

.. tip::
When inviting members, you can also select any teams to assign them automatically.

Expand All @@ -61,5 +63,7 @@ and assigns the desired role:
:align: center
:alt: UI, changing member role

Changing member role

From here, roles can be changed anytime.

Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Under :guilabel:`Preferences` is the :guilabel:`Offline device timeout` field.
:align: center
:alt: example image showing the device offline settings tab

Offline settings tab

Here you can enter the value, and select minutes or hours.
Click :guilabel:`Save`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ This will be the option farthest to the right.
.. figure:: /_static/userguide/account-management/plan-tab.png
:alt: user interface plan tab

Factory plan tab

Factory Upgrade
~~~~~~~~~~~~~~~

Expand All @@ -39,6 +41,8 @@ From here enter the required information:
:align: center
:alt: add billing details for upgrading plan

Adding new billing details

For using other forms of payment, please `contact us <https://foundriesio.atlassian.net/servicedesk/customer/portal/1/group/1/create/2>`_.

Payment and Billing
Expand Down
9 changes: 9 additions & 0 deletions source/user-guide/account-management/team-based-access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,22 @@ Team "read-write-ci" can do CI read-write operations:
:align: center
:alt: Teams example

Teams example

.. figure:: /_static/teams-example-read-only.png
:align: center
:scale: 80%
:alt: Teams example: Team read-only users

Team read-only users

.. figure:: /_static/teams-example-read-write-ci.png
:align: center
:scale: 80%
:alt: Teams example: Team read-write CI users

Team read-write CI users

A member is then added to both teams.
The member then has a combined list of scopes:

Expand Down Expand Up @@ -139,6 +145,8 @@ They cannot make changes to the devices as their scope includes ``devices:read``
:align: center
:alt: "read-only-users" scopes: read-only team with a device group

read-only team with a device group

The "lab-dev-users" team includes the ``devices:read-update`` scope.
Therefore, members of this team can modify the ``test-lab-devices`` group and its devices.
They can also view all devices in a Factory, even if they are assigned to other device groups.
Expand All @@ -147,6 +155,7 @@ They can also view all devices in a Factory, even if they are assigned to other
:align: center
:alt: "lab-dev-users" scopes: read-update team with a device group

read-update team with a device group

.. _team-based-access-tuf:

Expand Down
Loading