Skip to content

Commit ec01ec1

Browse files
committed
tutorials: handle "registering a device" confusion
Now that we support container-only factories, the registering process is specific for the factory type. We should point to both sources when mentioning the registered devices. Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
1 parent 19e0445 commit ec01ec1

8 files changed

Lines changed: 42 additions & 7 deletions

File tree

source/getting-started/fioup-registration/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _gs-register-fioup:
2+
13
Registering Your Device with Fioup
24
==================================
35

source/tutorials/creating-first-target/creating-first-target.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ Prerequisites
2424

2525
- Completed the :ref:`tutorial-gs-with-docker` tutorial.
2626
- Completed the :ref:`gs-install-fioctl` section.
27+
28+
For **Arduino UNO Q** and **Container-Only** Factories:
29+
30+
- Completed the :ref:`gs-register-fioup` section.
31+
32+
For **LmP** Factories:
33+
2734
- Completed the :ref:`gs-flash-device` section.
2835
- Completed the :ref:`gs-register` section.
2936

source/tutorials/creating-first-target/what-is-a-target.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ Devices configured to watch a tag and Hardware ID (``MACHINE``) that match your
2525

2626
.. note::
2727

28-
At this point, your device should be registered, as covered in the :ref:`Getting Started guide <gs-register>`.
28+
At this point, your device should be registered, as covered in:
29+
30+
- :ref:`gs-register-fioup` for **Arduino UNO Q** and **Container-Only** Factories, or
31+
- :ref:`gs-register` for **LmP** Factories.
32+
2933
If your device is online, it will automatically receive an update with your latest **Target**.
3034
The next tutorial will cover this in detail.
3135

source/tutorials/customizing-the-platform/customizing-the-platform.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
Customizing the Platform
44
========================
55

6+
.. important::
7+
8+
This covers **LmP** platform customization.
9+
This is suitable for **LmP**-based Factories, which include the ``meta-subscriber-overrides.git`` and ``lmp-manifest.git`` repositories.
10+
11+
**Arduino UNO Q** and **Container-Only** users should skip this tutorial.
12+
613
Docker Compose Apps are the recommended way to create applications.
714
However, you are also allowed to customize and change the platform when needed.
815

@@ -47,6 +54,7 @@ Learning Objectives
4754
Prerequisites
4855
-------------
4956

57+
- Have a **LmP**-based Factory.
5058
- Completed the Getting Started guide up through :ref:`gs-register`.
5159
- Read the :ref:`ref-linux` reference manual.
5260

source/tutorials/deploying-first-app/configure-your-device.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
Configure Your Device
22
^^^^^^^^^^^^^^^^^^^^^
33

4-
Your device should be registered to your Factory according to the :ref:`Getting Started guide <gs-register>`.
4+
Your device should be registered to your Factory.
5+
6+
.. tip::
7+
8+
You can register your device following:
9+
10+
- :ref:`gs-register-fioup`, for **Arduino UNO Q** and **Container-Only** Factories, or
11+
- :ref:`gs-register`, for **LmP** Factories
12+
513
Once registered, two services start to communicate with a Factory: ``aktualizr-lite`` and ``fioconfig``.
614

715
**aktualizr-lite**:

source/tutorials/getting-started-with-docker/gs-summary.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ The FoundriesFactory™ Platform CI will build and deploy this app as a **Target
66

77
.. important::
88

9-
If you followed this tutorial before flashing and registering your device,
9+
The following tutorials require a device registered to the Factory.
10+
11+
If you followed this tutorial before registering your device,
1012
return to the ``Getting Started`` section and complete the following:
1113

12-
- :ref:`gs-flash-device`.
13-
- :ref:`gs-register`.
14+
- :ref:`gs-register-fioup`, for **Arduino UNO Q** and **Container-Only** Factories, or
15+
- :ref:`gs-flash-device` and :ref:`gs-register`, for **LmP** Factories.
1416

source/tutorials/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The following tutorials will help familiarize you with the workflow for your Fac
77
As the concepts build upon others, follow them sequentially.
88

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

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

source/tutorials/working-with-tags/working-with-tags.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,12 @@ Learning Objectives
4141
Prerequisites
4242
-------------
4343

44-
- Completed the Getting Started guide up through :ref:`gs-register`.
44+
- Completed the Getting Started.
4545
- Completed the :ref:`tutorial-creating-first-target` tutorial.
46+
- Registered a device following:
47+
48+
- :ref:`gs-register-fioup`, for **Arduino UNO Q** and **Container-Only** Factories, or
49+
- :ref:`gs-flash-device` and :ref:`gs-register`, for **LmP** Factories.
4650

4751
Instructions
4852
------------

0 commit comments

Comments
 (0)