Skip to content
Merged
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
2 changes: 2 additions & 0 deletions source/getting-started/fioup-registration/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

:next_title: Installing Fioctl

.. _gs-register-fioup:

Registering Your Device with Fioup
==================================

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ Prerequisites

- Completed the :ref:`tutorial-gs-with-docker` tutorial.
- Completed the :ref:`gs-install-fioctl` section.

For **Arduino UNO Q** and **Container-Only** Factories:

- Completed the :ref:`gs-register-fioup` section.

For **LmP** Factories:

- Completed the :ref:`gs-flash-device` section.
- Completed the :ref:`gs-register` section.

Expand Down
6 changes: 5 additions & 1 deletion source/tutorials/creating-first-target/what-is-a-target.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ Devices configured to watch a tag and Hardware ID (``MACHINE``) that match your

.. note::

At this point, your device should be registered, as covered in the :ref:`Getting Started guide <gs-register>`.
At this point, your device should be registered, as covered in:

- :ref:`gs-register-fioup` for **Arduino UNO Q** and **Container-Only** Factories, or
- :ref:`gs-register` for **LmP** Factories.

If your device is online, it will automatically receive an update with your latest **Target**.
The next tutorial will cover this in detail.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
Customizing the Platform
========================

.. important::

This covers **LmP** platform customization.
This is suitable for **LmP**-based Factories, which include the ``meta-subscriber-overrides.git`` and ``lmp-manifest.git`` repositories.

Check warning on line 9 in source/tutorials/customizing-the-platform/customizing-the-platform.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.em-dash] Did you mean to you use an em dash '—'? Raw Output: {"message": "[Fio-docs.em-dash] Did you mean to you use an em dash '—'?", "location": {"path": "source/tutorials/customizing-the-platform/customizing-the-platform.rst", "range": {"start": {"line": 9, "column": 1}}}, "severity": "WARNING"}

**Arduino UNO Q** and **Container-Only** users should skip this tutorial.

Docker Compose Apps are the recommended way to create applications.
However, you are also allowed to customize and change the platform when needed.

Expand Down Expand Up @@ -47,6 +54,7 @@
Prerequisites
-------------

- Have an **LmP**-based Factory.

Check warning on line 57 in source/tutorials/customizing-the-platform/customizing-the-platform.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.em-dash] Did you mean to you use an em dash '—'? Raw Output: {"message": "[Fio-docs.em-dash] Did you mean to you use an em dash '—'?", "location": {"path": "source/tutorials/customizing-the-platform/customizing-the-platform.rst", "range": {"start": {"line": 57, "column": 1}}}, "severity": "WARNING"}
- Completed the Getting Started guide up through :ref:`gs-register`.
- Read the :ref:`ref-linux` reference manual.

Expand Down
10 changes: 9 additions & 1 deletion source/tutorials/deploying-first-app/configure-your-device.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
Configure Your Device
^^^^^^^^^^^^^^^^^^^^^

Your device should be registered to your Factory according to the :ref:`Getting Started guide <gs-register>`.
Your device should be registered to your Factory.

.. tip::

You can register your device following:

- :ref:`gs-register-fioup`, for **Arduino UNO Q** and **Container-Only** Factories, or
- :ref:`gs-register`, for **LmP** Factories

Once registered, two services start to communicate with a Factory: ``aktualizr-lite`` and ``fioconfig``.

**aktualizr-lite**:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
Cloning Container Repository
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. tip::

When your Factory is first created, a single branch (``main``) is created.
We suggest using a ``devel`` branch for development.
Once changes are tested and approved, migrate them to ``main``.

Clone and enter your ``containers.git``:

.. code-block:: console

$ git clone -b devel https://source.foundries.io/factories/<factory>/containers.git
$ git clone https://source.foundries.io/factories/<factory>/containers.git
$ cd containers

Your ``containers.git`` repository is initialized with a simple application example in ``shellhttpd.disabled``.
Expand Down
8 changes: 5 additions & 3 deletions source/tutorials/getting-started-with-docker/gs-summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ The FoundriesFactory™ Platform CI will build and deploy this app as a **Target

.. important::

If you followed this tutorial before flashing and registering your device,
The following tutorials require a device to be registered to the Factory.

If you followed this tutorial before registering your device,
return to the ``Getting Started`` section and complete the following:

- :ref:`gs-flash-device`.
- :ref:`gs-register`.
- :ref:`gs-register-fioup`, for **Arduino UNO Q** and **Container-Only** Factories, or
- :ref:`gs-flash-device` and :ref:`gs-register`, for **LmP** Factories.

3 changes: 1 addition & 2 deletions source/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@
As the concepts build upon others, follow them sequentially.

.. important::
The tutorials assume you have followed the Getting Started and that you have a :ref:`registered device <gs-register>`.
The tutorials assume you have followed the ``Getting Started`` section and that you have a registered device for either a :ref:`Arduino UNO Q / Container-Only Factory <gs-register-fioup>` or an :ref:`LmP Factory <gs-register>`.

Check warning on line 10 in source/tutorials/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.sentence-length] Aim for sentences no longer than 25 words Raw Output: {"message": "[Fio-docs.sentence-length] Aim for sentences no longer than 25 words", "location": {"path": "source/tutorials/index.rst", "range": {"start": {"line": 10, "column": 4}}}, "severity": "INFO"}

Make sure you have ``git`` and :ref:`Fioctl <gs-install-fioctl>` installed on your host machine.
``QEMU`` is also required if it is set in your Factory.

:ref:`tutorial-gs-with-docker` introduces ``docker-compose`` apps.
Next is :ref:`tutorial-creating-first-target` —learning what a :term:`Target` is through experience is key to using your Factory.
Expand Down
6 changes: 5 additions & 1 deletion source/tutorials/working-with-tags/working-with-tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,12 @@ Learning Objectives
Prerequisites
-------------

- Completed the Getting Started guide up through :ref:`gs-register`.
- Completed the ``Getting Started`` section.
- Completed the :ref:`tutorial-creating-first-target` tutorial.
- Registered a device using the appropriate method below:

- :ref:`gs-register-fioup`, for **Arduino UNO Q** and **Container-Only** Factories, or
- :ref:`gs-flash-device` and :ref:`gs-register`, for **LmP** Factories.

Instructions
------------
Expand Down