Skip to content
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

Add wireguard dependency note #750

Closed
wants to merge 2 commits into from
Closed

Add wireguard dependency note #750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f88ee56
Update title page to reflect messaging guidelines
kprosise Sep 3, 2024
85aa42b
Add iptables to wireguard dependencies
kprosise Sep 11, 2024
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
19 changes: 6 additions & 13 deletions source/index.rst
View file
Open in desktop
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 @@
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/
2 changes: 1 addition & 1 deletion source/reference-manual/remote-access/wireguard.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Install dependencies:

.. prompt:: bash

sudo apt install git wireguard wireguard-tools python3 python3-requests
sudo apt install git wireguard wireguard-tools python3 python3-requests iptables

Clone the VPN server code:

Expand Down
Loading