Skip to content

Commit

Permalink
Update title page to reflect messaging guidelines
Browse files Browse the repository at this point in the history 
Changes to intro/product summary blurb made to follow Marketing
messaging guidelines. Link at top no goes to product page of the
foundries.io website.

Note that other requested changes which involve the sidebar,
header, or footer will be handled in a separate PR.

QA: Ran linkcheck and viewed built HTML.

This commit addresses FFTK-3449

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
  • Loading branch information
@kprosise
kprosise committed Sep 3, 2024
1 parent 795da92 commit f88ee56
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions source/index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
FoundriesFactory_ Documentation
===============================

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®.
The FoundriesFactory™ platform is a comprehensive tool set for building, testing, deploying,

Check warning on line 4 in source/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.FoundriesFactory-adjective] When used with trademark, FoundriesFactory must be an adjective, followed by Platform, Saas, Service, Software, or Solution

Raw Output:
{"message": "[Fio-docs.FoundriesFactory-adjective] When used with trademark, FoundriesFactory must be an adjective, followed by Platform, Saas, Service, Software, or Solution", "location": {"path": "source/index.rst", "range": {"start": {"line": 4, "column": 5}}}, "severity": "WARNING"}
and maintaining updatable, security focused IoT and Edge products.

Combined with the :term:`Linux microPlatform` (LmP) and utilizing open source software projects including U-Boot, OP-TEE, OE/Yocto Project, and Docker®,

Check warning on line 7 in source/index.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/index.rst", "range": {"start": {"line": 7, "column": 1}}}, "severity": "INFO"}

Check warning on line 7 in source/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Linux-trademark] 'Linux' should be marked as a registered trademark first time it occurs in body of text.

Raw Output:
{"message": "[Fio-docs.Linux-trademark] 'Linux' should be marked as a registered trademark first time it occurs in body of text.", "location": {"path": "source/index.rst", "range": {"start": {"line": 7, "column": 26}}}, "severity": "INFO"}

Check warning on line 7 in source/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.expand-acronyms] 'TEE' 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] 'TEE' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/index.rst", "range": {"start": {"line": 7, "column": 118}}}, "severity": "WARNING"}
The FoundriesFactory Platform brings together key features and functions for developing professional embedded devices.

.. toctree::
:maxdepth: 2
Expand Down Expand Up @@ -102,12 +103,4 @@ OE/Yocto Project, the Linux microPlatform™ and Docker®.
v93 <https://github.com/foundriesio/docs/blob/main/release-notes/rn_v93.md>
v92 <https://github.com/foundriesio/docs/blob/main/release-notes/rn_v92.md>

.. ifconfig:: todo_include_todos is True

**Documentation-wide TODO List**
-------------------------------------------

(This only appears when ``todo_include_todos`` is True.)

.. todolist::
.. _FoundriesFactory: https://foundries.io
.. _FoundriesFactory: https://foundries.io/products/

0 comments on commit f88ee56

Please sign in to comment.