Skip to content

Commit b84e9b7

Browse files
committed
Cleanup docs
Linted docs, and addressed Markdown formatting issues, as much seemed to be copied directly from the ReStructuredText docs. This commit applies to issue FFTK-4610, "…lint docs…" Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
1 parent 770b9cc commit b84e9b7

File tree

6 files changed

+270
-247
lines changed

6 files changed

+270
-247
lines changed

docs/architecture.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
## Part of the FoundriesFactory™ Platform
44

5-
`aktualizr-lite` is a key component of FoundriesFactory™, the platform offered by Foundries.io provides
6-
end-to-end solution for IoT and Edge devices producers to build and OTA update OS and applications on their devices.
7-
It is embedded into [the Foundries.io™ Linux® microPlatform (LmP)](https://docs.foundries.io/latest/reference-manual/linux/linux.html) - Linux-based OS composed by means of [Yocto Framework](https://docs.yoctoproject.org/).
5+
`aktualizr-lite` is a key component of Foundries.io™ FoundriesFactory® platform.
6+
The platform provides an end-to-end solution for IoT and Edge devices producers to build and OTA update both the OS and applications.
7+
It is embedded into [the Foundries.io™ Linux® microPlatform (LmP)](https://docs.foundries.io/latest/reference-manual/linux/linux.html)
8+
—a Linux-based OS built by means of [The Yocto Project](https://docs.yoctoproject.org/).
89

9-
FoundriesFactory enables:
10-
1. **Assembling custom Linux-based OS through the Yocto framework**
10+
FoundriesFactory enables:
11+
1. **Assembling custom Linux-based OS through the Yocto Project**
1112

1213
2. **CI-Driven Builds and Deployments**
1314
1. A CI service builds your custom OS and publishes it as an OSTree repository.
@@ -17,16 +18,16 @@ FoundriesFactory™ enables:
1718
Updates are signed and verified using the TUF framework, and delivered using a proprietary
1819
Wave mechanism that enables controlled rollout of updates across fleets of devices.
1920

20-
2121
## System Overview
22-
The following diagram depicts conceptual architecture on the FoundriesFactory solution.
22+
23+
The following diagram depicts the conceptual architecture on the FoundriesFactory platform.
2324
![Aktualizr-lite architecture](img/FoundriesFactory_OTA_conceptual_architecture.png "FoundriesFactory™ OTA update system")
2425

2526
`aktualizr-lite` is a component running on devices and performs OTA update through interaction with the Device Gateway,
26-
the OSTree Service, and a container registry (FoundriesFactory's or 3rd party, e.g. github container registry)
27+
the OSTree Service, and a container registry (FoundriesFactory's or 3rd party, e.g. GitHub container registry)
2728

2829
The following diagram shows the key components used in aktualizr-lite
29-
and how they interact with FountriesFactory services.
30+
and how they interact with FountriesFactory services.
3031

3132
![Aktualizr-lite architecture](img/aktualizr-lite.png "Aktualizr-lite architecture")
3233

0 commit comments

Comments
 (0)