Skip to content

Clarify purpose of factory types #904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kprosise wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify purpose of factory types #904

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions source/getting-started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,19 @@
Getting Started
===============

FoundriesFactory includes two ways of getting started.
Most people, such as :ref:`gs-arduino-uno-q` users, will be using a container-only Factory and can follow the steps outlined in the :ref:`ref-gs-container-only` guide.
Other users will be creating a Factory based on the Linux microPlatform and call follow the steps outlined in the :ref:`ref-gs-lmp` guide.
The FoundriesFactory® Platform has two paths for getting started, depending on your Factory type.

Check warning on line 6 in source/getting-started/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.

Raw Output:
{"message": "[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.", "location": {"path": "source/getting-started/index.rst", "range": {"start": {"line": 6, "column": 5}}}, "severity": "WARNING"}
Copy link
Copy Markdown
Collaborator

@angolini angolini Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like this sentence. Because it makes me think if I know which type of factory do I have/want.

I would say instead:

Suggested change
The FoundriesFactory® Platform has two paths for getting started, depending on your Factory type.
The FoundriesFactory® Platform provides two flavors/configurations/types/products of FoundriesFactory: container-only Factory (here use the right name) and LmP Based Factory.

not that I don't know the product names, we have an agreement to never say only Factory. And "LmP Based Factory" is far from being a good name.

But, my point is that this is supposed to be the very first sentence a newcommer will read, so the reader does not know anything, the reader does not know which is a factory, and does not know what factory type s/he has/need

Copy link
Copy Markdown
Contributor Author

@kprosise kprosise Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think explaining what a Factory is first would be appropriate


Most will find themselves using a container-only Factory, such as those with the :ref:`gs-arduino-uno-q`.
This simplifies managing your Factory by focusing solely on creating and managing apps,
without making changes to the Operating System.

Proceed with :ref:`ref-gs-container-only`.

Other users will be creating a Factory based on the LmP—The FoundriesFactory embedded Linux® distro.

Check warning on line 14 in source/getting-started/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.

Raw Output:
{"message": "[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.", "location": {"path": "source/getting-started/index.rst", "range": {"start": {"line": 14, "column": 61}}}, "severity": "WARNING"}
This allows for customization of the platform, such as adding packages that can not run as
containers, or changes to support hardware requirements.
Comment on lines +15 to +16
Copy link
Copy Markdown
Collaborator

@angolini angolini Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure "adding packages that can not run as containers" is a good way to describe the need of a package installed into the rootfs. I would at least avoid the "can not" and use something more vague as "might". But I would suggest:

Suggested change
This allows for customization of the platform, such as adding packages that can not run as
containers, or changes to support hardware requirements.
This allows for customization of the platform, such as installing packages to the rootfs, or changes to support hardware requirements.

Copy link
Copy Markdown
Contributor Author

@kprosise kprosise Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just copied it from the customizing LmP tutorial/page. I will edit it here and update the source in a different PR.


Proceed with :ref:`ref-gs-lmp`.

Check warning on line 18 in source/getting-started/index.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Branding-and-names] Use 'LmP' instead of 'lmp'

Raw Output:
{"message": "[Fio-docs.Branding-and-names] Use 'LmP' instead of 'lmp'", "location": {"path": "source/getting-started/index.rst", "range": {"start": {"line": 18, "column": 30}}}, "severity": "INFO"}

.. toctree::
:maxdepth: 1
Expand Down
Loading