diff --git a/source/getting-started/fioup-registration/index.rst b/source/getting-started/fioup-registration/index.rst index f17d1cf6..5401318f 100644 --- a/source/getting-started/fioup-registration/index.rst +++ b/source/getting-started/fioup-registration/index.rst @@ -2,6 +2,8 @@ :next_title: Installing Fioctl +.. _gs-register-fioup: + Registering Your Device with Fioup ================================== diff --git a/source/tutorials/creating-first-target/creating-first-target.rst b/source/tutorials/creating-first-target/creating-first-target.rst index 74741c4c..38d03272 100644 --- a/source/tutorials/creating-first-target/creating-first-target.rst +++ b/source/tutorials/creating-first-target/creating-first-target.rst @@ -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. diff --git a/source/tutorials/creating-first-target/what-is-a-target.rst b/source/tutorials/creating-first-target/what-is-a-target.rst index 47bfb3d3..3c414381 100644 --- a/source/tutorials/creating-first-target/what-is-a-target.rst +++ b/source/tutorials/creating-first-target/what-is-a-target.rst @@ -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 `. + 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. diff --git a/source/tutorials/customizing-the-platform/customizing-the-platform.rst b/source/tutorials/customizing-the-platform/customizing-the-platform.rst index c09eb5a5..54e1d7f9 100644 --- a/source/tutorials/customizing-the-platform/customizing-the-platform.rst +++ b/source/tutorials/customizing-the-platform/customizing-the-platform.rst @@ -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. + + **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. @@ -47,6 +54,7 @@ Learning Objectives Prerequisites ------------- +- Have an **LmP**-based Factory. - Completed the Getting Started guide up through :ref:`gs-register`. - Read the :ref:`ref-linux` reference manual. diff --git a/source/tutorials/deploying-first-app/configure-your-device.rst b/source/tutorials/deploying-first-app/configure-your-device.rst index 170fe658..8ee85439 100644 --- a/source/tutorials/deploying-first-app/configure-your-device.rst +++ b/source/tutorials/deploying-first-app/configure-your-device.rst @@ -1,7 +1,15 @@ Configure Your Device ^^^^^^^^^^^^^^^^^^^^^ -Your device should be registered to your Factory according to the :ref:`Getting Started guide `. +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**: diff --git a/source/tutorials/getting-started-with-docker/cloning-container-repository.rst b/source/tutorials/getting-started-with-docker/cloning-container-repository.rst index ba9a1027..7a95806c 100644 --- a/source/tutorials/getting-started-with-docker/cloning-container-repository.rst +++ b/source/tutorials/getting-started-with-docker/cloning-container-repository.rst @@ -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//containers.git + $ git clone https://source.foundries.io/factories//containers.git $ cd containers Your ``containers.git`` repository is initialized with a simple application example in ``shellhttpd.disabled``. diff --git a/source/tutorials/getting-started-with-docker/gs-summary.rst b/source/tutorials/getting-started-with-docker/gs-summary.rst index 7abcc8da..6244861f 100644 --- a/source/tutorials/getting-started-with-docker/gs-summary.rst +++ b/source/tutorials/getting-started-with-docker/gs-summary.rst @@ -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. diff --git a/source/tutorials/index.rst b/source/tutorials/index.rst index 15ebb97d..58e79827 100644 --- a/source/tutorials/index.rst +++ b/source/tutorials/index.rst @@ -7,10 +7,9 @@ The following tutorials will help familiarize you with the workflow for your Fac 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 `. + 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 ` or an :ref:`LmP Factory `. Make sure you have ``git`` and :ref:`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. diff --git a/source/tutorials/working-with-tags/working-with-tags.rst b/source/tutorials/working-with-tags/working-with-tags.rst index 66c95d9f..84043796 100644 --- a/source/tutorials/working-with-tags/working-with-tags.rst +++ b/source/tutorials/working-with-tags/working-with-tags.rst @@ -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 ------------