From d34788f13e1ae4d751fb8b7ef4c21f4178657f0b Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Tue, 19 Sep 2023 12:40:51 -0400 Subject: [PATCH] Add reference to managing devices Updated getting-started/registering-device to include "managing" language to improve findability. Older (v73) docs had "Managing" page, redirect now goes to the getting started page. With same info. Small style changes also applied to the page. QA Steps: Ran linter, linkcheck, and checked html in browser. No issues to link, small fix following Slack discussion. Signed-off-by: Katrina Prosise --- source/conf.py | 2 +- source/getting-started/register-device/index.rst | 15 +++++++++------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/source/conf.py b/source/conf.py index f94ff7ed8..033735b50 100644 --- a/source/conf.py +++ b/source/conf.py @@ -394,7 +394,7 @@ "customer-factory/writing-images": "../getting-started/flash-device/index.html", "customer-factory/updating-the-core": "../reference-manual/linux/linux-update.html", "customer-factory/source-code": "../tutorials/customizing-the-platform/customizing-the-platform.html", - "customer-factory/managing": "../user-guide/account-management/account-management.html", + "customer-factory/managing": "../getting-started/register-device/index.html", "customer-factory/getting-started": "../getting-started/signup/index.html", "customer-factory/first-boot": "../getting-started/flash-device/index.html#booting-and-connecting-to-the-network", "customer-factory/extending": "../reference-manual/linux/linux-extending.html", diff --git a/source/getting-started/register-device/index.rst b/source/getting-started/register-device/index.rst index a8a7042b1..60d544bcc 100644 --- a/source/getting-started/register-device/index.rst +++ b/source/getting-started/register-device/index.rst @@ -3,9 +3,9 @@ Registering Your Device ======================= -Your Linux® microPlatform (LmP) image includes the ``lmp-device-register`` tool that registers your device via the Foundries.io™ REST API. +Your Linux® microPlatform (LmP) image includes the ``lmp-device-register`` tool that manages device registration for your device via the Foundries.io™ REST API. -1. Run this command from the device console to register it with your Factory: +1. To register a device with your Factory, run the following from the device console: .. prompt:: bash device:~$, auto @@ -14,12 +14,11 @@ Your Linux® microPlatform (LmP) image includes the ``lmp-device-register`` tool .. note:: The parameter ``-f `` is only needed for the first target. -2. You will be prompted by ``lmp-device-register`` to `complete a challenge `_ with our API. Follow the instructions on the promped message: +2. You will be prompted by ``lmp-device-register`` to `complete a challenge `_ with our API. + Follow the instruction prompts: .. highlight:: none - **Example Output**: - .. prompt:: text Registering device, test, to factory gavin. @@ -44,5 +43,9 @@ Your Linux® microPlatform (LmP) image includes the ``lmp-device-register`` tool .. note:: - **By default**, after registration devices will run **all** applications that are available in the latest Target. This behavior can be changed by enabling only specific applications. + After registration devices will run **all** applications that are available in the latest Target. + This default behavior can be changed by enabling only specific applications. Read :ref:`ug-fioctl-enable-apps` to learn how. + +.. seealso:: + :ref:`Team Based Factory Access ` for permissions related to device management.