Skip to content

Commit

Permalink
Update FoundriesFactory trademark usage
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
kprosise committed Aug 23, 2024
1 parent ea15b99 commit af80c1e
Show file tree
Hide file tree
Showing 67 changed files with 81 additions and 79 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Before pushing, check locally:
- lint: `vale <path_to_file(s)>`

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.

2 changes: 1 addition & 1 deletion source/getting-started/building-deploying-app/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``:

Expand Down
2 changes: 1 addition & 1 deletion source/getting-started/emulation-with-qemu/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 6 additions & 4 deletions source/getting-started/flash-device/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------
Expand All @@ -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.

Expand All @@ -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-<machine_name>.wic.gz``
Expand Down
2 changes: 1 addition & 1 deletion source/getting-started/install-fioctl/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion source/getting-started/signup/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Signing Up
==========

To begin using FoundriesFactory®, start with `creating an account <signup_>`_ with us.
To begin using the FoundriesFactory™ Platform, start with `creating an account <signup_>`_ with us.

.. figure:: /_static/signup/signup.png
:width: 380
Expand Down
2 changes: 1 addition & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
@@ -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®.
Expand Down
4 changes: 2 additions & 2 deletions source/porting-guide/pg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/boards/se050_imx6ull.rst
Original file line number Diff line number Diff line change
@@ -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::
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/boards/se050_imx8mm.rst
Original file line number Diff line number Diff line change
@@ -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::
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/boards/se050_imx8mp.rst
Original file line number Diff line number Diff line change
@@ -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::
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/boards/se050_imx8mq.rst
Original file line number Diff line number Diff line change
@@ -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::
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/docker/container-secrets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/factory/api-access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/factory/ci-webhooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check warning on line 56 in source/reference-manual/factory/ci-webhooks.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.expand-acronyms] 'HMAC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal. Raw Output: {"message": "[Fio-docs.expand-acronyms] 'HMAC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/reference-manual/factory/ci-webhooks.rst", "range": {"start": {"line": 56, "column": 27}}}, "severity": "WARNING"}

.. _HMAC-SHA256:
https://en.wikipedia.org/wiki/HMAC
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/factory/data-retention.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/factory/event-queues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/factory/factory-sources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/<factory>/``:

.. figure:: /_static/factory-cgit.png
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/factory/factory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/factory/sboms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check warning on line 13 in source/reference-manual/factory/sboms.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.expand-acronyms] 'SBOM' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal. Raw Output: {"message": "[Fio-docs.expand-acronyms] 'SBOM' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/reference-manual/factory/sboms.rst", "range": {"start": {"line": 13, "column": 34}}}, "severity": "WARNING"}

Check warning on line 13 in source/reference-manual/factory/sboms.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.expand-acronyms] 'SBOM' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal. Raw Output: {"message": "[Fio-docs.expand-acronyms] 'SBOM' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/reference-manual/factory/sboms.rst", "range": {"start": {"line": 13, "column": 60}}}, "severity": "WARNING"}

.. important::
`Per our terms and conditions <https://foundries.io/company/terms/>`_:
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/linux/factory-device-reset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/linux/linux-oss-compliance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/linux/linux-supported.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://support.foundries.io>`_.


Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/linux/linux-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/ota/production-targets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This is set at the :ref:`device registration time <ref-factory-registration-ref>
If the attribute is absent, it designates a **test device**.

As noted in the :ref:`offline keys documentation <ref-offline-keys>`,
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 <ref-ci-targets>`.
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/ota/update-rollback.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/security/cert-rotation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Check warning on line 11 in source/reference-manual/security/cert-rotation.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.expand-acronyms] 'RFC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal. Raw Output: {"message": "[Fio-docs.expand-acronyms] 'RFC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/reference-manual/security/cert-rotation.rst", "range": {"start": {"line": 11, "column": 110}}}, "severity": "WARNING"}

.. _NIST:
https://www.nist.gov/
Expand Down
4 changes: 2 additions & 2 deletions source/reference-manual/security/factory-keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""""""""""""""""""""
Expand Down Expand Up @@ -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.

Check warning on line 199 in source/reference-manual/security/factory-keys.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.sentence-length] Aim for sentences no longer than 25 words Raw Output: {"message": "[Fio-docs.sentence-length] Aim for sentences no longer than 25 words", "location": {"path": "source/reference-manual/security/factory-keys.rst", "range": {"start": {"line": 199, "column": 3}}}, "severity": "INFO"}

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
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/security/ff-security-summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/security/offline-keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Offline Factory TUF Keys
========================

FoundriesFactory® uses `The Update Framework (TUF) <TUF_>`_
The FoundriesFactory™ Platform uses `The Update Framework (TUF) <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,
Expand Down
4 changes: 2 additions & 2 deletions source/reference-manual/security/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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 <ref-ota-architecture>`.
The `Device Gateway` enforces Factory devices establishing the `Mutual TLS (mTLS) <mTLS_>`_ connection to it.
During the `TLS Handshake <TLS_>`_ phase in `Mutual TLS`,
Expand Down
6 changes: 2 additions & 4 deletions source/reference-manual/security/tee-on-versal-acap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check warning on line 110 in source/reference-manual/security/tee-on-versal-acap.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.expand-acronyms] 'WIC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal. Raw Output: {"message": "[Fio-docs.expand-acronyms] 'WIC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/reference-manual/security/tee-on-versal-acap.rst", "range": {"start": {"line": 110, "column": 57}}}, "severity": "WARNING"}
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.

Check warning on line 111 in source/reference-manual/security/tee-on-versal-acap.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.sentence-length] Aim for sentences no longer than 25 words Raw Output: {"message": "[Fio-docs.sentence-length] Aim for sentences no longer than 25 words", "location": {"path": "source/reference-manual/security/tee-on-versal-acap.rst", "range": {"start": {"line": 111, "column": 1}}}, "severity": "INFO"}

Check warning on line 111 in source/reference-manual/security/tee-on-versal-acap.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.expand-acronyms] 'WIC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal. Raw Output: {"message": "[Fio-docs.expand-acronyms] 'WIC' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/reference-manual/security/tee-on-versal-acap.rst", "range": {"start": {"line": 111, "column": 28}}}, "severity": "WARNING"}

Imagine that Xilinx/AMD releases a new version of the PLM firmware, the firmware controls the actual cryptographic operations requested by OP-TEE.

Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/testing/lmp-testplan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check warning on line 7 in source/reference-manual/testing/lmp-testplan.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Foundriesio-trademark] 'Foundries.io' should be marked as an unregisted trademark first time it occurs in body of text IF used as an adjective. Raw Output: {"message": "[Fio-docs.Foundriesio-trademark] 'Foundries.io' should be marked as an unregisted trademark first time it occurs in body of text IF used as an adjective.", "location": {"path": "source/reference-manual/testing/lmp-testplan.rst", "range": {"start": {"line": 7, "column": 35}}}, "severity": "INFO"}
Test results for each release can be found in the `release notes <https://github.com/foundriesio/docs/tree/main/release-notes>`_.

What to Test
Expand Down
2 changes: 1 addition & 1 deletion source/reference-manual/testing/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit af80c1e

Please sign in to comment.