From af80c1ea968a88ef9c03fa1e9feb52ff6efc998b Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Fri, 23 Aug 2024 05:59:17 -0400 Subject: [PATCH] Update FoundriesFactory trademark usage Trademark should be unregistered, used as proper adjective, and after first occurrence other than in a title or header. QA: Used linter against source, ran build and linkcheck This commit addresses FFTK-3431 Signed-off-by: Katrina Prosise --- README.md | 2 +- .../getting-started/building-deploying-app/index.rst | 2 +- source/getting-started/emulation-with-qemu/index.rst | 2 +- source/getting-started/flash-device/index.rst | 10 ++++++---- source/getting-started/install-fioctl/index.rst | 2 +- source/getting-started/signup/index.rst | 2 +- source/index.rst | 2 +- source/porting-guide/pg.rst | 4 ++-- source/reference-manual/boards/se050_imx6ull.rst | 2 +- source/reference-manual/boards/se050_imx8mm.rst | 2 +- source/reference-manual/boards/se050_imx8mp.rst | 2 +- source/reference-manual/boards/se050_imx8mq.rst | 2 +- source/reference-manual/docker/container-secrets.rst | 2 +- source/reference-manual/factory/api-access.rst | 2 +- source/reference-manual/factory/ci-webhooks.rst | 2 +- source/reference-manual/factory/data-retention.rst | 2 +- source/reference-manual/factory/event-queues.rst | 2 +- source/reference-manual/factory/factory-sources.rst | 2 +- source/reference-manual/factory/factory.rst | 2 +- source/reference-manual/factory/sboms.rst | 2 +- source/reference-manual/index.rst | 2 +- source/reference-manual/linux/factory-device-reset.rst | 2 +- source/reference-manual/linux/linux-oss-compliance.rst | 2 +- source/reference-manual/linux/linux-supported.rst | 2 +- source/reference-manual/linux/linux-update.rst | 2 +- source/reference-manual/ota/production-targets.rst | 2 +- source/reference-manual/ota/update-rollback.rst | 2 +- source/reference-manual/security/cert-rotation.rst | 2 +- source/reference-manual/security/factory-keys.rst | 4 ++-- .../reference-manual/security/ff-security-summary.rst | 2 +- source/reference-manual/security/offline-keys.rst | 2 +- source/reference-manual/security/security.rst | 4 ++-- .../reference-manual/security/tee-on-versal-acap.rst | 6 ++---- source/reference-manual/testing/lmp-testplan.rst | 2 +- source/reference-manual/testing/testing.rst | 2 +- .../compose-app/compose-app-checking-app-state.rst | 2 +- .../compose-app/compose-app-file-structure.rst | 2 +- .../compose-app/compose-app-shellhttpd-mqtt.rst | 5 +++-- .../copy-configuration-file-using-dockerfile.rst | 2 +- .../dynamic-configuration-file.rst | 2 +- .../commit-and-push-our-changes.rst | 2 +- .../creating-first-target-summary.rst | 2 +- .../creating-first-target/find-your-build.rst | 2 +- .../creating-first-target/what-is-a-target.rst | 2 +- .../customizing-the-platform.rst | 2 +- .../deploying-first-app/deploying-first-app.rst | 2 +- .../cloning-container-repository.rst | 2 +- .../getting-started-with-docker.rst | 2 +- .../getting-started-with-docker/gs-docker-compose.rst | 2 +- .../getting-started-with-docker/gs-summary.rst | 2 +- .../working-with-tags/adapting-shellhttpd.rst | 2 +- .../account-management/account-management.rst | 2 +- .../account-management/subscription-and-billing.rst | 4 ++-- .../account-management/team-based-access.rst | 2 +- .../user-guide/containers-and-docker/compose-apps.rst | 2 +- .../containers-and-docker/container-preloading.rst | 2 +- source/user-guide/custom-ci/custom-ci-for-apps.rst | 2 +- source/user-guide/custom-ci/custom-ci-for-rootfs.rst | 2 +- source/user-guide/custom-ci/custom-ci.rst | 2 +- .../device-gateway-pki/device-gateway-pki.rst | 2 +- source/user-guide/el2g.rst | 2 +- source/user-guide/ip-protection/ip-protection.rst | 3 ++- source/user-guide/mirror-action/mirror-action.rst | 2 +- source/user-guide/offline-update/offline-update.rst | 2 +- source/user-guide/rotating-cert.rst | 4 ++-- source/user-guide/submodule/submodule.rst | 2 +- source/user-guide/troubleshooting/troubleshooting.rst | 2 +- 67 files changed, 81 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 5a70871ae..a4d6a8396 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ Before pushing, check locally: - lint: `vale ` When opening a PR, add "documentation team" for your reviewer. -For any changes that reflect changes to how FoundriesFactory is used/interacted with—the majority—please add the Customer Success team. +For any changes that reflect changes to how the FoundriesFactory™ Platform is used/interacted with—the majority—please add the Customer Success team. Someone from the documentation team will merge it once reviews are in and suggestions considered. The [PR template](.github/pull_request_template.md) has additional steps that can speed up the process. diff --git a/source/getting-started/building-deploying-app/index.rst b/source/getting-started/building-deploying-app/index.rst index 9f7f3de90..4947f9932 100644 --- a/source/getting-started/building-deploying-app/index.rst +++ b/source/getting-started/building-deploying-app/index.rst @@ -14,7 +14,7 @@ Your ``containers.git`` repository is initialized with a simple application exam .. tip:: - Directory names ending with ``.disabled`` in ``containers.git`` are **ignored** by the FoundriesFactory® CI. + Directory names ending with ``.disabled`` in ``containers.git`` are **ignored** by the FoundriesFactory™ Platform CI. Move the entire application folder ``shellhttpd.disabled`` to ``shellhttpd``: diff --git a/source/getting-started/emulation-with-qemu/index.rst b/source/getting-started/emulation-with-qemu/index.rst index 94c73da56..5ea5f3f73 100644 --- a/source/getting-started/emulation-with-qemu/index.rst +++ b/source/getting-started/emulation-with-qemu/index.rst @@ -6,7 +6,7 @@ Emulation With QEMU .. note:: This tutorial is designed to assist you in getting started with using :term:`QEMU` to emulate devices on your desktop. - Please note that we are selecting a specific machine to establish an environment for experimenting with FoundriesFactory®. + Please note that we are selecting a specific machine to establish an environment for experimenting with the FoundriesFactory™ Platform. This approach will enable you to engage with subsequent tutorials and enhance your skills. Prerequisites and Pre-Work diff --git a/source/getting-started/flash-device/index.rst b/source/getting-started/flash-device/index.rst index 456ecd500..c9bb11cb7 100644 --- a/source/getting-started/flash-device/index.rst +++ b/source/getting-started/flash-device/index.rst @@ -5,8 +5,8 @@ Flashing Your Device .. note:: - The initial FoundriesFactory® set up and build is finished very quick. Follow - its status with steps listed in :ref:`gs-watch-build` page. + The initial Factory setup and build is finished very quick. + Follow its status with steps listed in :ref:`gs-watch-build` page. Prerequisites and Pre-Work -------------------------- @@ -31,7 +31,7 @@ Prerequisites and Pre-Work Downloading the System Image ---------------------------- -After a successful build, FoundriesFactory produces build artifacts which can be downloaded from the :guilabel:`Targets` tab of your :term:`Factory`. +After a successful build, the FoundriesFactory™ Platform produces build artifacts which can be downloaded from the :guilabel:`Targets` tab of your :term:`Factory`. #. Navigate to the :guilabel:`Targets` section of your Factory. @@ -42,7 +42,9 @@ After a successful build, FoundriesFactory produces build artifacts which can be :align: center :alt: Targets tab showing prebuilt-target -#. Expand the :guilabel:`Targets` tab clicking on it. This shows a link to the Factory image artifact. Download the Factory image for your machine: +#. Expand the :guilabel:`Targets` tab clicking on it. + This shows a link to the Factory image artifact. + Download the Factory image for your machine: | E.g: ``lmp-base-console-image-.wic.gz`` diff --git a/source/getting-started/install-fioctl/index.rst b/source/getting-started/install-fioctl/index.rst index 7b1dfdfa3..f5afc1053 100644 --- a/source/getting-started/install-fioctl/index.rst +++ b/source/getting-started/install-fioctl/index.rst @@ -114,7 +114,7 @@ Authenticating Fioctl ##################### With :ref:`ref-fioctl` installed, authenticate it with our backend. -For this, you will generate OAuth2 application credentials for interacting with the FoundriesFactory® API: +For this, you will generate OAuth2 application credentials for interacting with the FoundriesFactory™ Platform API: .. prompt:: bash host:~$, auto diff --git a/source/getting-started/signup/index.rst b/source/getting-started/signup/index.rst index c63d399f5..497018389 100644 --- a/source/getting-started/signup/index.rst +++ b/source/getting-started/signup/index.rst @@ -3,7 +3,7 @@ Signing Up ========== -To begin using FoundriesFactory®, start with `creating an account `_ with us. +To begin using the FoundriesFactory™ Platform, start with `creating an account `_ with us. .. figure:: /_static/signup/signup.png :width: 380 diff --git a/source/index.rst b/source/index.rst index 181368c2f..73c751652 100644 --- a/source/index.rst +++ b/source/index.rst @@ -1,7 +1,7 @@ FoundriesFactory_ Documentation =============================== -FoundriesFactory is a cloud service to build, test, deploy, +The FoundriesFactory™ Platform is a cloud service to build, test, deploy, and maintain secure, updatable IoT and Edge products. It is used to customize open source software projects including U-Boot, OP-TEE, OE/Yocto Project, the Linux microPlatform™ and Docker®. diff --git a/source/porting-guide/pg.rst b/source/porting-guide/pg.rst index 3f56a4105..2fcebd2e7 100644 --- a/source/porting-guide/pg.rst +++ b/source/porting-guide/pg.rst @@ -6,7 +6,7 @@ Factory Porting Guide Introduction ------------ -This section provides guidelines and suggestions on how to add support for a machine not already supported by FoundriesFactory. +This section provides guidelines and suggestions on how to add support for a machine not already supported by the FoundriesFactory™ Platform. The list of currently supported machines can be found under :ref:`ref-linux-supported`. Needing to port a board could be due to: @@ -17,7 +17,7 @@ Needing to port a board could be due to: Another possible reason is to customize hardware aspects of well known hardware, but with another machine file. -The strategy used in this guide is to add support on top of the existing structure provided by the Linux® micro Platform (LmP). +The strategy used in this guide is to add support on top of the existing structure provided by the Linux® microPlatform (LmP). The LmP provides the needed configuration for the packages, images, and classes. Also provided is the container runtime and OTA infrastructure integration. diff --git a/source/reference-manual/boards/se050_imx6ull.rst b/source/reference-manual/boards/se050_imx6ull.rst index 47986d380..2ccd8129d 100644 --- a/source/reference-manual/boards/se050_imx6ull.rst +++ b/source/reference-manual/boards/se050_imx6ull.rst @@ -1,7 +1,7 @@ i.MX 6ULL Evaluation kit With SE050ARD ======================================= -This page walks through installing a FoundriesFactory® image with SE050 hardware enabled onto the NXP® ``imx6ullevk``, +This page walks through installing a FoundriesFactory™ Platform image with SE050 hardware enabled onto the NXP® ``imx6ullevk``, connected to the NXP OM-SE050ARD development platform. .. note:: diff --git a/source/reference-manual/boards/se050_imx8mm.rst b/source/reference-manual/boards/se050_imx8mm.rst index 96927b2ee..641975875 100644 --- a/source/reference-manual/boards/se050_imx8mm.rst +++ b/source/reference-manual/boards/se050_imx8mm.rst @@ -1,7 +1,7 @@ i.MX 8M Mini/Nano Evaluation Kit with SE050ARD ============================================== -This page walks through installing a SE050 hardware enabled FoundriesFactory® image onto an NXP® ``imx8mm-lpddr4-evk`` or ``imx8mn-ddr4-evk``, +This page walks through installing a SE050 hardware enabled FoundriesFactory™ Platform image onto an NXP® ``imx8mm-lpddr4-evk`` or ``imx8mn-ddr4-evk``, connected to the NXP OM-SE050ARD development platform. .. note:: diff --git a/source/reference-manual/boards/se050_imx8mp.rst b/source/reference-manual/boards/se050_imx8mp.rst index ea0f1c4dd..e58688e0a 100644 --- a/source/reference-manual/boards/se050_imx8mp.rst +++ b/source/reference-manual/boards/se050_imx8mp.rst @@ -1,7 +1,7 @@ i.MX 8M Plus Evaluation Kit With SE050ARD ========================================= -This document walks through the steps of installing a FoundriesFactory® image with SE050 hardware enabled onto the NXP® ``imx8mp-lpddr4-evk``, +This document walks through the steps of installing a FoundriesFactory™ Platform image with SE050 hardware enabled onto the NXP® ``imx8mp-lpddr4-evk``, connected to the NXP OM-SE050ARD development platform. .. note:: diff --git a/source/reference-manual/boards/se050_imx8mq.rst b/source/reference-manual/boards/se050_imx8mq.rst index 35aeacb79..008b5c742 100644 --- a/source/reference-manual/boards/se050_imx8mq.rst +++ b/source/reference-manual/boards/se050_imx8mq.rst @@ -1,7 +1,7 @@ i.MX 8M Quad Evaluation Kit with SE050ARD ========================================= -This page walks through walk installing a FoundriesFactory® image with SE050 hardware enabled onto the NXP® ``imx8mqevk``, +This page walks through walk installing a FoundriesFactory™ Platform image with SE050 hardware enabled onto the NXP® ``imx8mqevk``, connected to the NXP OM-SE050ARD development platform. .. note:: diff --git a/source/reference-manual/docker/container-secrets.rst b/source/reference-manual/docker/container-secrets.rst index 6bd1477c4..28f787201 100644 --- a/source/reference-manual/docker/container-secrets.rst +++ b/source/reference-manual/docker/container-secrets.rst @@ -24,7 +24,7 @@ However, the general approach to getting these secrets securely into your contai Overview of CI Secrets ----------------------- -The FoundriesFactory® CI System, **JobServ**, has a mechanism for configuring secrets for a project—a Factory's LmP build in this case. +The FoundriesFactory™ Platform CI System, **JobServ**, has a mechanism for configuring secrets for a project—a Factory's LmP build in this case. These secrets are placed under ``/secrets/`` when a CI Run is executed. For example, if a Factory has the following secrets: diff --git a/source/reference-manual/factory/api-access.rst b/source/reference-manual/factory/api-access.rst index 14ac3bd74..25b0e7cc0 100644 --- a/source/reference-manual/factory/api-access.rst +++ b/source/reference-manual/factory/api-access.rst @@ -3,7 +3,7 @@ API Access ========== -FoundriesFactory® APIs can be accessed via two methods: +The FoundriesFactory™ Platform APIs can be accessed via two methods: #. `OAuth2`_ tokens managed in the `Application Credentials`_ interface. #. API Tokens managed in the `API tokens`_ interface. diff --git a/source/reference-manual/factory/ci-webhooks.rst b/source/reference-manual/factory/ci-webhooks.rst index a9cf45438..ea634887c 100644 --- a/source/reference-manual/factory/ci-webhooks.rst +++ b/source/reference-manual/factory/ci-webhooks.rst @@ -53,7 +53,7 @@ Webhook data sent by the CI looks like:: "completed": "2021-07-26T18:19:24+00:00" } -This message includes an `HMAC-SHA256`_ HTTP header from the FoundriesFactory® `CI engine`_, ``X-JobServ-Sig`` to help authenticate the sender. +This message includes an `HMAC-SHA256`_ HTTP header from the FoundriesFactory™ Platform `CI engine`_, ``X-JobServ-Sig`` to help authenticate the sender. .. _HMAC-SHA256: https://en.wikipedia.org/wiki/HMAC diff --git a/source/reference-manual/factory/data-retention.rst b/source/reference-manual/factory/data-retention.rst index 426ab7d68..df282d09b 100644 --- a/source/reference-manual/factory/data-retention.rst +++ b/source/reference-manual/factory/data-retention.rst @@ -3,7 +3,7 @@ Data Retention Policies ======================= -Understanding data retention policies for Foundries.io™ FoundriesFactory® can help with the compliance processes for a product. +Understanding data retention policies for the Foundries.io™ FoundriesFactory™ Platform can help with the compliance processes for a product. This page explains how data is managed within a Factory. FoundriesFactory consists of several tightly integrated projects: diff --git a/source/reference-manual/factory/event-queues.rst b/source/reference-manual/factory/event-queues.rst index d492b7c50..49f06100c 100644 --- a/source/reference-manual/factory/event-queues.rst +++ b/source/reference-manual/factory/event-queues.rst @@ -3,7 +3,7 @@ Event Queues ============ -The FoundriesFactory® API_ exposes everything about a Factory. +The FoundriesFactory™ Platform API_ exposes everything about a Factory. In fact, ``app.foundries.io`` and Fioctl_ ® are both built on top of that API. While this API is fully functional, it can be difficult to build custom tooling for a large numbers of devices if constantly polling the API. Event queues were designed to solve this issue. diff --git a/source/reference-manual/factory/factory-sources.rst b/source/reference-manual/factory/factory-sources.rst index 8c6c43a46..a1c9e846f 100644 --- a/source/reference-manual/factory/factory-sources.rst +++ b/source/reference-manual/factory/factory-sources.rst @@ -3,7 +3,7 @@ Factory Source Code =================== -FoundriesFactory® provides you with a private git sandbox, allowing you to maintain and customize your platform. +The FoundriesFactory™ Platform provides you with a private git sandbox, allowing you to maintain and customize your platform. Navigate to ``https://source.foundries.io/factories//``: .. figure:: /_static/factory-cgit.png diff --git a/source/reference-manual/factory/factory.rst b/source/reference-manual/factory/factory.rst index 9b124c396..fdd68e631 100644 --- a/source/reference-manual/factory/factory.rst +++ b/source/reference-manual/factory/factory.rst @@ -3,7 +3,7 @@ FoundriesFactory ================ -**FoundriesFactory®**: The set of tools, services, and support that enable a :term:`Factory` and assist it throughout the device lifecycle. +**FoundriesFactory™ Platform**: The set of tools, services, and support that enable a :term:`Factory` and assist it throughout the device lifecycle. This section provides support for working with and customizing FoundriesFactory and the LmP. * Topics that deal with how CI functions include :ref:`ref-factory-definition` and :ref:`ref-ci-webhooks`. diff --git a/source/reference-manual/factory/sboms.rst b/source/reference-manual/factory/sboms.rst index 16f61a9d0..acd42c2ae 100644 --- a/source/reference-manual/factory/sboms.rst +++ b/source/reference-manual/factory/sboms.rst @@ -10,7 +10,7 @@ SBOMs are foundational to understanding: * License compliance—the software licenses of the packages. * Vulnerability management—the package versions. -The FoundriesFactory® SBOM feature extracts the SBOM data and analyzes it according to your needs. +The FoundriesFactory™ Platform's SBOM feature extracts the SBOM data and analyzes it according to your needs. .. important:: `Per our terms and conditions `_: diff --git a/source/reference-manual/index.rst b/source/reference-manual/index.rst index 5b0085e4b..7e06c72bc 100644 --- a/source/reference-manual/index.rst +++ b/source/reference-manual/index.rst @@ -3,7 +3,7 @@ Overview ======== -The FoundriesFactory® Reference Manual provides technical details, command options, and API calls, as well as instructions for some advanced use cases. +The FoundriesFactory™ Platform Reference Manual provides technical details, command options, and API calls, as well as instructions for some advanced use cases. See the User Guide or Tutorial sections for instructional focused content. .. tip:: diff --git a/source/reference-manual/linux/factory-device-reset.rst b/source/reference-manual/linux/factory-device-reset.rst index 6e1fd0a8a..a850f99ae 100644 --- a/source/reference-manual/linux/factory-device-reset.rst +++ b/source/reference-manual/linux/factory-device-reset.rst @@ -4,7 +4,7 @@ Factory Reset ============= In this context, Factory reset means restoring a device to the original state. -This is a feature of LmP, rather than of FoundriesFactory®. +This is a feature of LmP, rather than of the FoundriesFactory™ Platform. A reset is performed as a script in ramdisk during boot. It is triggered by the presence of specific files. Presence of the files is specified in the following order: diff --git a/source/reference-manual/linux/linux-oss-compliance.rst b/source/reference-manual/linux/linux-oss-compliance.rst index 095a272f2..3461e864f 100644 --- a/source/reference-manual/linux/linux-oss-compliance.rst +++ b/source/reference-manual/linux/linux-oss-compliance.rst @@ -2,7 +2,7 @@ OSS Compliance With FoundriesFactory ==================================== The Yocto Project provides a set of tools to help with Open Source Software (OSS) compliance. -FoundriesFactory® is configured to use some of them by default. +The FoundriesFactory™ Platform is configured to use some of them by default. These provide a good starting point when working with license requirements. There are several OSS licenses. diff --git a/source/reference-manual/linux/linux-supported.rst b/source/reference-manual/linux/linux-supported.rst index 28f0f797a..24d6ed05b 100644 --- a/source/reference-manual/linux/linux-supported.rst +++ b/source/reference-manual/linux/linux-supported.rst @@ -7,7 +7,7 @@ The :ref:`ref-factory-definition` (``ci-scripts.git``) contains a ``machines:`` The table below shows the corresponding ``MACHINE`` for a device. .. warning:: - Do not change this value, as it will be declined by the FoundriesFactory® CI. + Do not change this value, as it will be declined by the FoundriesFactory™ Platform CI. If needed, please ask a `support engineer `_. diff --git a/source/reference-manual/linux/linux-update.rst b/source/reference-manual/linux/linux-update.rst index 9b332ba3c..6c5ad85f3 100644 --- a/source/reference-manual/linux/linux-update.rst +++ b/source/reference-manual/linux/linux-update.rst @@ -3,7 +3,7 @@ Updating the Linux microPlatform Core ===================================== -The FoundriesFactory® platform manifest is tailored to make consuming core platform updates easily. +The FoundriesFactory™ Platform manifest is tailored to make consuming core platform updates easily. At Foundries.io™, we often `release`_ Linux® microPlatform (LmP) updates as an effort to get the latest features and security fixes out to users. .. _release: diff --git a/source/reference-manual/ota/production-targets.rst b/source/reference-manual/ota/production-targets.rst index 431c7d2be..d4f07aedc 100644 --- a/source/reference-manual/ota/production-targets.rst +++ b/source/reference-manual/ota/production-targets.rst @@ -9,7 +9,7 @@ This is set at the :ref:`device registration time If the attribute is absent, it designates a **test device**. As noted in the :ref:`offline keys documentation `, -FoundriesFactory® leverages The Update Framework (TUF) to deliver Over-the-Air (OTA) software updates to devices. +The FoundriesFactory™ Platform leverages The Update Framework (TUF) to deliver Over-the-Air (OTA) software updates to devices. Production versus test devices receive different copies of the TUF metadata: - Test devices receive :ref:`CI targets `. diff --git a/source/reference-manual/ota/update-rollback.rst b/source/reference-manual/ota/update-rollback.rst index 8fc24f0a0..f87cf81c9 100644 --- a/source/reference-manual/ota/update-rollback.rst +++ b/source/reference-manual/ota/update-rollback.rst @@ -41,7 +41,7 @@ If a boot on a new version of rootfs fails three times then: Rollback Driven by a Bootloader Update Failure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The FoundriesFactory® OTA update service supports bootloader update. +The FoundriesFactory™ Platform OTA update service supports bootloader update. Effectively, boot artifacts are included into `OSTree`_ — managed rootfs. Therefore, a rollback procedure in the case of a bootloader update failure, is the same as in the case of the ostree update failure. The only difference is how and when the rollback is triggered. diff --git a/source/reference-manual/security/cert-rotation.rst b/source/reference-manual/security/cert-rotation.rst index 127f9087d..dcfb1c657 100644 --- a/source/reference-manual/security/cert-rotation.rst +++ b/source/reference-manual/security/cert-rotation.rst @@ -8,7 +8,7 @@ A device receives an x509 client certificate during device registration that is This validity period is common in IoT, but security bodies like NIST_ recommend changing such keys on a yearly basis. Certificate rotation is the process you can use to do this. -The FoundriesFactory® process for rotating device certificates is based on the industry standard `RFC 7030`_ Enrollment over Secure Transport (EST). +The FoundriesFactory™ Platform's process for rotating device certificates is based on the industry standard `RFC 7030`_ Enrollment over Secure Transport (EST). .. _NIST: https://www.nist.gov/ diff --git a/source/reference-manual/security/factory-keys.rst b/source/reference-manual/security/factory-keys.rst index 587e8d201..ef3af9aa7 100644 --- a/source/reference-manual/security/factory-keys.rst +++ b/source/reference-manual/security/factory-keys.rst @@ -24,7 +24,7 @@ to configure the keys used by the Yocto Project. .. note:: The device RoT key (the key used for secure boot, for example) is shown in the diagrams. - However it is not an online key and is not used during the FoundriesFactory® build. + However it is not an online key and is not used during the Factory build. i.MX Secure Boot Flow """"""""""""""""""""" @@ -196,7 +196,7 @@ recommended to rotate the keys as needed. The suggestion is to rotate them every the used keys often. So, it is highly recommended to rotate the keys each 6 to 24 months. - Please note that, depending on the key, it may be required to trigger a :ref:`ref-boot-software-updates` to correctly change the FoundriesFactory keys used. A mismatch in used keys could lead to devices failing to boot, which would then rollback to the previous stable version using the old keys. + Please note that, depending on the key, it may be required to trigger a :ref:`ref-boot-software-updates` to correctly change the Factory keys used. A mismatch in used keys could lead to devices failing to boot, which would then rollback to the previous stable version using the old keys. In the following sections, the command line is shown on how to create the key pair for U-Boot, OP-TEE and Linux Kernel Modules. This is assuming the ``lmp-manifest`` repository is diff --git a/source/reference-manual/security/ff-security-summary.rst b/source/reference-manual/security/ff-security-summary.rst index f999bc587..f7196da96 100644 --- a/source/reference-manual/security/ff-security-summary.rst +++ b/source/reference-manual/security/ff-security-summary.rst @@ -8,7 +8,7 @@ This page provides a brief summary of cryptographic keys used by your Factory. Secure Connection to Cloud Services ----------------------------------- -The following certificates are required to access the FoundriesFactory® CI servers. +The following certificates are required to access the FoundriesFactory™ Platform CI servers. For detailed information, check :ref:`ref-secure-cloud-services`. .. list-table:: Device Gateway Certificates Summary diff --git a/source/reference-manual/security/offline-keys.rst b/source/reference-manual/security/offline-keys.rst index b303cee04..082d03e05 100644 --- a/source/reference-manual/security/offline-keys.rst +++ b/source/reference-manual/security/offline-keys.rst @@ -3,7 +3,7 @@ Offline Factory TUF Keys ======================== -FoundriesFactory® uses `The Update Framework (TUF) `_ +The FoundriesFactory™ Platform uses `The Update Framework (TUF) `_ for multi-level key management strategy to secure software updates. Part of this strategy utilizes roles to separate software update responsibilities. By restricting each role's responsibilities or actions it is trusted to perform, diff --git a/source/reference-manual/security/security.rst b/source/reference-manual/security/security.rst index c8a90c18f..92d125c69 100644 --- a/source/reference-manual/security/security.rst +++ b/source/reference-manual/security/security.rst @@ -8,7 +8,7 @@ Overview Security has multiple layers and dimensions. It starts at booting the device, and goes all the way to running software on it, and connecting to cloud services. -A FoundriesFactory® Factory provides a set of features to target each aspect. +Your Factory provides a set of features to target each aspect. The following sections focus on how to securely: @@ -34,7 +34,7 @@ A brief summary of the crypto keys used in a Factory can be found in: Secure Connection to Cloud Services ----------------------------------- -Your devices communicate with a set of FoundriesFactory cloud services, +Your devices communicate with a set of FoundriesFactory™ Platform cloud services, the central of which is the :ref:`Device Gateway `. The `Device Gateway` enforces Factory devices establishing the `Mutual TLS (mTLS) `_ connection to it. During the `TLS Handshake `_ phase in `Mutual TLS`, diff --git a/source/reference-manual/security/tee-on-versal-acap.rst b/source/reference-manual/security/tee-on-versal-acap.rst index 71ca85e63..d9747c3ab 100644 --- a/source/reference-manual/security/tee-on-versal-acap.rst +++ b/source/reference-manual/security/tee-on-versal-acap.rst @@ -107,10 +107,8 @@ Working Effectively With the Boot Firmware One of the features that make the `Versal AI Core Series VCK190 Evaluation Kit`_ a friendly platform to develop on is its integrated JTAG support: a single USB cable provides the different consoles as well as the JTAG port. -At Foundries.io, via the FoundriesFactory CI, we build and deliver a WIC image that allows Versal ACAP platforms to boot securely. -This way an a user can just flash the WIC image on a uSD card, plug it in the corresponding slot, and boot to a secured and functional system. - -More so, we deliver all the individual components that form the binaries along with the pointers to the corresponding git trees and versions. +The FoundriesFactory™ Platform CI builds and delivers a WIC image that allows Versal ACAP platforms to boot securely. +This way you can flash the WIC image on a uSD card, plug it in the corresponding slot, and boot to a secured and functional system. Imagine that Xilinx/AMD releases a new version of the PLM firmware, the firmware controls the actual cryptographic operations requested by OP-TEE. diff --git a/source/reference-manual/testing/lmp-testplan.rst b/source/reference-manual/testing/lmp-testplan.rst index 0923f37fc..584bf7904 100644 --- a/source/reference-manual/testing/lmp-testplan.rst +++ b/source/reference-manual/testing/lmp-testplan.rst @@ -4,7 +4,7 @@ Test Plan ######### -Below you will find the test plan Foundries.io uses for FoundriesFactory®. +Below you will find the test plan Foundries.io uses for the FoundriesFactory™ Platform. Test results for each release can be found in the `release notes `_. What to Test diff --git a/source/reference-manual/testing/testing.rst b/source/reference-manual/testing/testing.rst index 9753196f7..757a34db6 100644 --- a/source/reference-manual/testing/testing.rst +++ b/source/reference-manual/testing/testing.rst @@ -3,7 +3,7 @@ Testing ======= -This section provides an overview of FoundriesFactory testing. +This section provides an overview of the testing done for the FoundriesFactory™ Platform. :ref:`ref-lmp-testplan` describes the *internal* testing process we follow to help ensure the quality of our releases. diff --git a/source/tutorials/compose-app/compose-app-checking-app-state.rst b/source/tutorials/compose-app/compose-app-checking-app-state.rst index 08d4a2402..7b163658e 100644 --- a/source/tutorials/compose-app/compose-app-checking-app-state.rst +++ b/source/tutorials/compose-app/compose-app-checking-app-state.rst @@ -17,7 +17,7 @@ It is responsible for the App state inquiry interval as well. - directly after device reboot - when ``aktualizr-lite`` restarts. -.. Important:: The FoundriesFactory® backend stores just the last 10 states. +.. Important:: The FoundriesFactory™ Platform's backend stores just the last 10 states. If enabled, container health is determined by a `health check`_ script. Otherwise, container health is deduced from a container state and exit code. diff --git a/source/tutorials/compose-app/compose-app-file-structure.rst b/source/tutorials/compose-app/compose-app-file-structure.rst index 853f236fc..e7744ba06 100644 --- a/source/tutorials/compose-app/compose-app-file-structure.rst +++ b/source/tutorials/compose-app/compose-app-file-structure.rst @@ -4,7 +4,7 @@ File Structure ^^^^^^^^^^^^^^ Pay attention to the file structure in the ``containers.git`` repo. -It defines when the FoundriesFactory® CI creates a Docker image or creates a Docker Compose App. +It defines when the FoundriesFactory™ Platform CI creates a Docker image or creates a Docker Compose App. Most Docker Compose App structures will be similar to the ``shellhttpd`` example provided in ``containers.git``. This is the same example used in the previous tutorials. diff --git a/source/tutorials/compose-app/compose-app-shellhttpd-mqtt.rst b/source/tutorials/compose-app/compose-app-shellhttpd-mqtt.rst index 9f36d8c92..838303742 100644 --- a/source/tutorials/compose-app/compose-app-shellhttpd-mqtt.rst +++ b/source/tutorials/compose-app/compose-app-shellhttpd-mqtt.rst @@ -59,12 +59,13 @@ Check the content of ``shellhttpd-mqtt/docker-compose.yml``: The ``shellhttpd-mqtt/docker-compose.yml`` file has the configuration for the ``shellhttpd-mqtt`` app: - ``httpd-mqtt``: Name of the first service. -- ``image``: Specifies the Docker container image from ``hub.foundries.io/${FACTORY}/shellhttpd-mqtt:latest``. This was created by the FoundriesFactory CI based on the Dockerfile in ``shellhttpd-mqtt``. In this case, the same folder. +- ``image``: Specifies the Docker container image from ``hub.foundries.io/${FACTORY}/shellhttpd-mqtt:latest``. + This was created by the FoundriesFactory™ Platform CI based on the Dockerfile in ``shellhttpd-mqtt``. In this case, the same folder. - ``extra_hosts``: Map the container to access the device ``localhost`` over the address ``host.docker.internal``. ``Dockerfile`` contains the commands to assemble the ``hub.foundries.io/${FACTORY}/shellhttpd-mqtt:latest`` Docker container image. -The FoundriesFactory® CI will build and publish the image. +The CI will build and publish the image. Finally, the Docker Compose Application above will specify it. Check the content of ``shellhttpd-mqtt/Dockerfile``: diff --git a/source/tutorials/configuring-and-sharing-volumes/copy-configuration-file-using-dockerfile.rst b/source/tutorials/configuring-and-sharing-volumes/copy-configuration-file-using-dockerfile.rst index e57ee30b5..e32ac8989 100644 --- a/source/tutorials/configuring-and-sharing-volumes/copy-configuration-file-using-dockerfile.rst +++ b/source/tutorials/configuring-and-sharing-volumes/copy-configuration-file-using-dockerfile.rst @@ -49,7 +49,7 @@ Commit and push the changes. host:~$ git commit -m "Adding config file with Dockerfile" host:~$ git push -Wait for the FoundriesFactory® CI job to finish and for your device to receive the new target. +Wait for the FoundriesFactory™ Platform's CI job to finish and for your device to receive the new target. To check if your device is up-to-date, from your Factory page check :guilabel:`Devices`. You should see a new number at the end of the **Target** name. For example, ``raspberrypi3-64-lmp-5``. diff --git a/source/tutorials/configuring-and-sharing-volumes/dynamic-configuration-file.rst b/source/tutorials/configuring-and-sharing-volumes/dynamic-configuration-file.rst index 0df93c5bc..b269b179d 100644 --- a/source/tutorials/configuring-and-sharing-volumes/dynamic-configuration-file.rst +++ b/source/tutorials/configuring-and-sharing-volumes/dynamic-configuration-file.rst @@ -4,7 +4,7 @@ Dynamic Configuration File ^^^^^^^^^^^^^^^^^^^^^^^^^^ In a production environment, you may have a fleet of devices. Configuring each device would be frustrating. -FoundriesFactory® adds management capabilities to your product configuration. +The FoundriesFactory™ Platform adds management capabilities to your product configuration. With Fioctl®, the configuration file is encrypted with the devices’ public key. When the device receives the encrypted file, ``fioconfig`` stores it to a persistent volume at ``/var/sota/config.encrypted``. diff --git a/source/tutorials/creating-first-target/commit-and-push-our-changes.rst b/source/tutorials/creating-first-target/commit-and-push-our-changes.rst index 4fdda9d1b..825db5e16 100644 --- a/source/tutorials/creating-first-target/commit-and-push-our-changes.rst +++ b/source/tutorials/creating-first-target/commit-and-push-our-changes.rst @@ -5,7 +5,7 @@ In :ref:`tutorial-gs-with-docker`, you moved most of the files from the ``shellh You then built and tested a local version of the container. In this chapter, you will work on the final adjustments before sending your changes to the remote repository. -This triggers the FoundriesFactory® CI to start a new build, which compiles and publishes your application to `Foundries.io™ hub `_. +This triggers the FoundriesFactory™ Platform CI to start a new build, which compiles and publishes your application to `Foundries.io™ hub `_. Open a terminal on your host machine and navigate to the container folder used in the previous tutorial. diff --git a/source/tutorials/creating-first-target/creating-first-target-summary.rst b/source/tutorials/creating-first-target/creating-first-target-summary.rst index fe9ddafe5..0da307dec 100644 --- a/source/tutorials/creating-first-target/creating-first-target-summary.rst +++ b/source/tutorials/creating-first-target/creating-first-target-summary.rst @@ -3,7 +3,7 @@ Summary You explored what a **Target** is and the steps for creating one. The commands used in this tutorial, together with ":ref:`tutorial-gs-with-docker`", -make up a large part of the FoundriesFactory® development flow. +make up a large part of the FoundriesFactory™ Platform's development flow. To summarize this workflow: diff --git a/source/tutorials/creating-first-target/find-your-build.rst b/source/tutorials/creating-first-target/find-your-build.rst index 6d0f00534..5afc2f940 100644 --- a/source/tutorials/creating-first-target/find-your-build.rst +++ b/source/tutorials/creating-first-target/find-your-build.rst @@ -1,7 +1,7 @@ Find Your Build ^^^^^^^^^^^^^^^ -Once your changes to the :term:`containers.git` repository were pushed, the FoundriesFactory® CI automatically started a new ``container-main`` build. +Once your changes to the :term:`containers.git` repository were pushed, the FoundriesFactory™ Platform CI automatically started a new ``container-main`` build. Go to https://app.foundries.io, select your Factory and click on :guilabel:`Targets`: The latest **Target** named :guilabel:`containers-main` should be the CI job you just created. 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 58bc4b86e..6fe43c90b 100644 --- a/source/tutorials/creating-first-target/what-is-a-target.rst +++ b/source/tutorials/creating-first-target/what-is-a-target.rst @@ -3,7 +3,7 @@ Targets ^^^^^^^ -The FoundriesFactory® CI created your first **Target** triggered by changes to the ``containers.git``. +The FoundriesFactory™ Platform's CI created your first **Target** triggered by changes to the ``containers.git``. .. hint:: diff --git a/source/tutorials/customizing-the-platform/customizing-the-platform.rst b/source/tutorials/customizing-the-platform/customizing-the-platform.rst index 2e866280d..dd1a97653 100644 --- a/source/tutorials/customizing-the-platform/customizing-the-platform.rst +++ b/source/tutorials/customizing-the-platform/customizing-the-platform.rst @@ -29,7 +29,7 @@ The same ``shellhttpd`` application used in other tutorials is now being added t .. tip:: If you are not familiar with the Yocto Project/OpenEmbedded you can still follow this tutorial. - The FoundriesFactory® CI helps simplify this process by building the platform in the cloud. + The FoundriesFactory™ Platform CI helps simplify this process by building the platform in the cloud. .. note:: diff --git a/source/tutorials/deploying-first-app/deploying-first-app.rst b/source/tutorials/deploying-first-app/deploying-first-app.rst index d0c860067..817b06406 100644 --- a/source/tutorials/deploying-first-app/deploying-first-app.rst +++ b/source/tutorials/deploying-first-app/deploying-first-app.rst @@ -4,7 +4,7 @@ Deploying Your First Application ================================ In the tutorial :ref:`tutorial-creating-first-target`, you learned about **Targets**. -This is core to understanding how FoundriesFactory® works. +This is core to understanding how the FoundriesFactory™ Platform works. Now you will learn how devices *consume* Targets. You will also learn how to configure a device with the desired applications. 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 6449d503b..51965c7b3 100644 --- a/source/tutorials/getting-started-with-docker/cloning-container-repository.rst +++ b/source/tutorials/getting-started-with-docker/cloning-container-repository.rst @@ -17,7 +17,7 @@ Your ``containers.git`` repository is initialized with a simple application exam .. tip:: - Directory names ending with ``.disabled`` in ``containers.git`` are **ignored** by the FoundriesFactory® CI. + Directory names ending with ``.disabled`` in ``containers.git`` are **ignored** by the FoundriesFactory™ Platform CI. For better understanding, it is best to go through the files in ``shellhttpd.disabled`` gradually. Create a new folder with the name ``shellhttpd``: diff --git a/source/tutorials/getting-started-with-docker/getting-started-with-docker.rst b/source/tutorials/getting-started-with-docker/getting-started-with-docker.rst index 4219659bc..c3360dc67 100644 --- a/source/tutorials/getting-started-with-docker/getting-started-with-docker.rst +++ b/source/tutorials/getting-started-with-docker/getting-started-with-docker.rst @@ -3,7 +3,7 @@ Getting Started With Docker =========================== -FoundriesFactory® gives you the ability to update ``docker-compose`` applications Over The Air (OTA). +The FoundriesFactory™ Platform gives you the ability to update ``docker-compose`` applications Over The Air (OTA). This tutorial gets you started with Docker and ``docker-compose``, with the basic commands and concepts that will help you create your own apps. diff --git a/source/tutorials/getting-started-with-docker/gs-docker-compose.rst b/source/tutorials/getting-started-with-docker/gs-docker-compose.rst index cf544fa8f..e0339173f 100644 --- a/source/tutorials/getting-started-with-docker/gs-docker-compose.rst +++ b/source/tutorials/getting-started-with-docker/gs-docker-compose.rst @@ -41,7 +41,7 @@ Review the ``docker-compose.yml`` file: Most of the parameters were already used in the previous commands. The only thing to change is the image parameter. -In the next tutorial, you will build and deploy with FoundriesFactory®, where ``hub.foundries.io`` will be necessary. +In the next tutorial, you will build and deploy using the FoundriesFactory™ Platform, where ``hub.foundries.io`` will be necessary. As you are still developing locally, edit the image parameter to use the image and tag from the previous steps, ``shellhttpd:1.0``: diff --git a/source/tutorials/getting-started-with-docker/gs-summary.rst b/source/tutorials/getting-started-with-docker/gs-summary.rst index 17b3df1f5..7abcc8dac 100644 --- a/source/tutorials/getting-started-with-docker/gs-summary.rst +++ b/source/tutorials/getting-started-with-docker/gs-summary.rst @@ -2,7 +2,7 @@ Summary ------- You have learned the basic commands and structure of Docker and ``docker-compose`` applications. In the next tutorial, you will commit and push your changes to the remote ``containers.git`` repository. -The FoundriesFactory® CI will build and deploy this app as a **Target** which can be applied to your device. +The FoundriesFactory™ Platform CI will build and deploy this app as a **Target** which can be applied to your device. .. important:: diff --git a/source/tutorials/working-with-tags/adapting-shellhttpd.rst b/source/tutorials/working-with-tags/adapting-shellhttpd.rst index 9e4114e0c..7e19272c7 100644 --- a/source/tutorials/working-with-tags/adapting-shellhttpd.rst +++ b/source/tutorials/working-with-tags/adapting-shellhttpd.rst @@ -138,5 +138,5 @@ Check what Target your device is running: ---- ------- ------ ------ ---- ---------- raspberrypi3-64-lmp-10 OK flask-mqtt-nginx,mosquitto,shellhttpd-mqtt true -Whenever you push changes to the ``devel`` branch, FoundriesFactory® CI will build and generate a new Target tagged with ``devel``. +Whenever you push changes to the ``devel`` branch, the CI will build and generate a new Target tagged with ``devel``. As a result, devices following ``devel`` will update to the latest Target. diff --git a/source/user-guide/account-management/account-management.rst b/source/user-guide/account-management/account-management.rst index b6fb8ee54..e04d92917 100644 --- a/source/user-guide/account-management/account-management.rst +++ b/source/user-guide/account-management/account-management.rst @@ -3,7 +3,7 @@ Factory & Account Management ============================ -This section covers topics related to using the :term:`FoundriesFactory`\® web UI. +This section covers topics related to using the FoundriesFactory™ Platform web UI. This includes managing your subscription, adding members to your :term:`Factory`, or setting who can interact with devices and access source code. diff --git a/source/user-guide/account-management/subscription-and-billing.rst b/source/user-guide/account-management/subscription-and-billing.rst index 8238dd5e2..522c0eb33 100644 --- a/source/user-guide/account-management/subscription-and-billing.rst +++ b/source/user-guide/account-management/subscription-and-billing.rst @@ -4,8 +4,8 @@ Managing Your Subscription ========================== .. hint:: - FoundriesFactory® is a DevSecOps platform subscription service. - Per month or annual plan choices, + The FoundriesFactory™ Platform is a DevSecOps subscription service. + Per month or annual plan choices are available. both provide access to all FoundriesFactory features and support. Subscriptions apply per Factory; diff --git a/source/user-guide/account-management/team-based-access.rst b/source/user-guide/account-management/team-based-access.rst index b8a0c9230..e370e3309 100644 --- a/source/user-guide/account-management/team-based-access.rst +++ b/source/user-guide/account-management/team-based-access.rst @@ -9,7 +9,7 @@ Team Based Factory Access * :ref:`API Scopes ` for available token scopes. .. tip:: - The FoundriesFactory® :ref:`API documentation` covers available scopes. + The FoundriesFactory™ Platform :ref:`API documentation` covers available scopes. Larger organizations often need to restrict the access level a user has to the Factory. For example, some users might only need access for managing devices, diff --git a/source/user-guide/containers-and-docker/compose-apps.rst b/source/user-guide/containers-and-docker/compose-apps.rst index 02a5643d8..da7ea5878 100644 --- a/source/user-guide/containers-and-docker/compose-apps.rst +++ b/source/user-guide/containers-and-docker/compose-apps.rst @@ -3,7 +3,7 @@ Compose Apps ============ -Docker-compose applications, or "Compose Apps", are how application development is approached with FoundriesFactory®. +Docker-compose applications, or "Compose Apps", are how application development is approached with the FoundriesFactory™ Platform. However, Docker-compose does not specify how to **distribute** applications. Compose Apps fill in this gap for Factory devices. diff --git a/source/user-guide/containers-and-docker/container-preloading.rst b/source/user-guide/containers-and-docker/container-preloading.rst index afc65b9f2..3a642797c 100644 --- a/source/user-guide/containers-and-docker/container-preloading.rst +++ b/source/user-guide/containers-and-docker/container-preloading.rst @@ -92,7 +92,7 @@ Check the latest Target you just created: New Target -When the FoundriesFactory® CI finishes, click Target. +When the FoundriesFactory™ Platform CI finishes, click Target. Find :guilabel:`Runs` and download the image from ``assemble-system-image``. Flash the image and boot the device. diff --git a/source/user-guide/custom-ci/custom-ci-for-apps.rst b/source/user-guide/custom-ci/custom-ci-for-apps.rst index 3105eda20..153e08b37 100644 --- a/source/user-guide/custom-ci/custom-ci-for-apps.rst +++ b/source/user-guide/custom-ci/custom-ci-for-apps.rst @@ -3,7 +3,7 @@ Custom CI To Build Compose App Targets ====================================== -FoundriesFactory® includes all you need to build a containerized application and securely deploy it on devices. +The FoundriesFactory™ Platform includes all you need to build a containerized application and securely deploy it on devices. This includes: * a git repository diff --git a/source/user-guide/custom-ci/custom-ci-for-rootfs.rst b/source/user-guide/custom-ci/custom-ci-for-rootfs.rst index 949bd6f7d..7ea21e50d 100644 --- a/source/user-guide/custom-ci/custom-ci-for-rootfs.rst +++ b/source/user-guide/custom-ci/custom-ci-for-rootfs.rst @@ -3,7 +3,7 @@ Custom CI for RootFS ==================== -FoundriesFactory® includes all you need to build a Linux®-based operating system and securely deploy it. +The FoundriesFactory™ Platform includes all you need to build a Linux®-based operating system and securely deploy it. In particular, it provides you with a git repo and a CI service that handles building the kernel and :term:`rootfs`, and delivering them to devices. This is done while leveraging the TUF compliant OTA service. You can learn more in the :ref:`reference ` section. diff --git a/source/user-guide/custom-ci/custom-ci.rst b/source/user-guide/custom-ci/custom-ci.rst index 1221e220b..cc53ad679 100644 --- a/source/user-guide/custom-ci/custom-ci.rst +++ b/source/user-guide/custom-ci/custom-ci.rst @@ -3,7 +3,7 @@ Custom CI ========= -FoundriesFactory® is a Swiss Army knife. +The FoundriesFactory™ Platform is a Swiss Army knife. It includes everything you need to manage the lifecycle of a Linux®-based OS with containerized applications running on it: - Git repositories for your operating system (OE layers/recipes) and containerized applications. diff --git a/source/user-guide/device-gateway-pki/device-gateway-pki.rst b/source/user-guide/device-gateway-pki/device-gateway-pki.rst index 5291a1acf..ececadc67 100644 --- a/source/user-guide/device-gateway-pki/device-gateway-pki.rst +++ b/source/user-guide/device-gateway-pki/device-gateway-pki.rst @@ -28,7 +28,7 @@ The PKI for Device Gateway and Factory Devices is vital for the secure communica It is important to understand exactly what the given command does. Before a user sets up the PKI, their Devices and Device Gateway talk to each other by utilizing a so-called "shared PKI". -This is the default PKI that FoundriesFactory® sets up as part of new Factory provisioning. +This is the default PKI that the FoundriesFactory™ service sets up as part of new Factory provisioning. The ``fioctl`` command communicates with the end point ``https://api.foundries.io/ota/factories/$FACTORY/certs/`` to create and update Factory specific PKI keys and certificates. As long as the Factory uses the "shared PKI", the endpoint returns an empty response, as no Factory PKI is set:: diff --git a/source/user-guide/el2g.rst b/source/user-guide/el2g.rst index 59b299cf7..9db5133d8 100644 --- a/source/user-guide/el2g.rst +++ b/source/user-guide/el2g.rst @@ -3,7 +3,7 @@ Integrating NXP EdgeLock 2GO ============================ -EdgeLock® 2GO is an add-on service from NXP®, integrated into FoundriesFactory® to simplify the securing of devices during manufacturing. +EdgeLock® 2GO is an add-on service from NXP®, integrated into the FoundriesFactory™ Platform to simplify the securing of devices during manufacturing. The service enables the automated installation and secure storage of required keys, certificates, and credentials when the end device first connects to the internet. .. admonition:: Key Benefits diff --git a/source/user-guide/ip-protection/ip-protection.rst b/source/user-guide/ip-protection/ip-protection.rst index dae84537e..083c76f5b 100644 --- a/source/user-guide/ip-protection/ip-protection.rst +++ b/source/user-guide/ip-protection/ip-protection.rst @@ -3,7 +3,8 @@ Intellectual Property Protection ================================ -Protecting your Intellectual Property (IP) is important to us. Foundries.io™ follows best practices to make sure your code is protected while using FoundriesFactory®. +Protecting your Intellectual Property (IP) is important to us. +Foundries.io™ follows best practices to make sure your code is protected while using the FoundriesFactory™ Platform. .. seealso:: :ref:`ref-data-retention` diff --git a/source/user-guide/mirror-action/mirror-action.rst b/source/user-guide/mirror-action/mirror-action.rst index ea759b8e3..0df177ab8 100644 --- a/source/user-guide/mirror-action/mirror-action.rst +++ b/source/user-guide/mirror-action/mirror-action.rst @@ -3,7 +3,7 @@ Configuring Automatic Git Mirroring =================================== -This page shows how to configure source code mirroring to the FoundriesFactory® repos. +This page shows how to configure source code mirroring to the FoundriesFactory™ Platform repos. This is useful when using external Git repositories, hosted on services such as GitHub_ or Bitbucket_. While the focus is on setting up GitHub Actions and Bitbucket pipelines, the steps can be adapted for other hosting services. diff --git a/source/user-guide/offline-update/offline-update.rst b/source/user-guide/offline-update/offline-update.rst index 9e8a157d7..0d3e84eae 100644 --- a/source/user-guide/offline-update/offline-update.rst +++ b/source/user-guide/offline-update/offline-update.rst @@ -229,7 +229,7 @@ Offline Update Considerations * **Offline Update for Unregistered Devices** - When dealing with devices not registered in FoundriesFactory® or :ref:`a custom registration server `, + When dealing with devices not registered with the FoundriesFactory™ service or :ref:`a custom registration server `, several considerations arise: * Production Status: The distinction between production and non-production status of the device remains undetermined. diff --git a/source/user-guide/rotating-cert.rst b/source/user-guide/rotating-cert.rst index 75ce13a6f..09c2c7826 100644 --- a/source/user-guide/rotating-cert.rst +++ b/source/user-guide/rotating-cert.rst @@ -16,12 +16,12 @@ There are two ways to then run an Enrollment over Secure Transport (EST) server. FoundriesFactory Managed ~~~~~~~~~~~~~~~~~~~~~~~~ -Running ``fioctl keys est authorize`` will allow FoundriesFactory® to run an EST server for you at ``.est.foundries.io``. +Running ``fioctl keys est authorize`` will allow the FoundriesFactory™ service to run an EST server for you at ``.est.foundries.io``. This command will sign a CSR created in the backend with your Factory's root key. The resulting TLS certificate will be used by the FoundriesFactory EST server. .. note:: - This option requires the FoundriesFactory® backend to have a certificate authority to sign renewal requests. + This option requires the FoundriesFactory backend to have a certificate authority to sign renewal requests. This "online-ca" is configured when running ``fioctl keys ca create``. Please note that ``fioctl keys ca create`` can **only** be run once; see :ref:`ref-device-gateway-pki-details` for more information. diff --git a/source/user-guide/submodule/submodule.rst b/source/user-guide/submodule/submodule.rst index 75cdb76ba..3c7d417a4 100644 --- a/source/user-guide/submodule/submodule.rst +++ b/source/user-guide/submodule/submodule.rst @@ -3,7 +3,7 @@ Working With Git Submodules =========================== -This section shows how to add a git submodule to your FoundriesFactory® repository. +This section shows how to add a git submodule to your FoundriesFactory™ Platform repository. This is used when you want an external Git repository, such as GitHub, connected to a Factory repository as a submodule. Submodules can be used to isolate two different application teams, allowing work to take place in separate repositories. diff --git a/source/user-guide/troubleshooting/troubleshooting.rst b/source/user-guide/troubleshooting/troubleshooting.rst index c90ea965d..602c85217 100644 --- a/source/user-guide/troubleshooting/troubleshooting.rst +++ b/source/user-guide/troubleshooting/troubleshooting.rst @@ -248,7 +248,7 @@ Once the ``spldev.key`` and ``spldev.crt`` are created, add them to the reposito git add factory-keys/spldev.crt git commit -Once the commit is pushed upstream, the FoundriesFactory® CI will generate a build that fixes the issue. +Once the commit is pushed upstream, the FoundriesFactory™ Platform CI will generate a build that fixes the issue. .. _ref-troubleshooting_request-entity-too-large: