Skip to content

Commit

Permalink
Add reference to managing devices
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
kprosise committed Sep 19, 2023
1 parent f722e17 commit d34788f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
15 changes: 9 additions & 6 deletions source/getting-started/register-device/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -14,12 +14,11 @@ Your Linux® microPlatform (LmP) image includes the ``lmp-device-register`` tool
.. note::
The parameter ``-f <factory>`` is only needed for the first target.

2. You will be prompted by ``lmp-device-register`` to `complete a challenge <https://www.oauth.com/oauth2-servers/device-flow/>`_ with our API. Follow the instructions on the promped message:
2. You will be prompted by ``lmp-device-register`` to `complete a challenge <https://www.oauth.com/oauth2-servers/device-flow/>`_ with our API.
Follow the instruction prompts:

.. highlight:: none

**Example Output**:

.. prompt:: text

Registering device, test, to factory gavin.
Expand All @@ -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 <ref-team-based-access>` for permissions related to device management.

0 comments on commit d34788f

Please sign in to comment.