From 0410899a521a83a3171eb1bf72521aa3c69e105e Mon Sep 17 00:00:00 2001 From: ishu verma Date: Apr 30 2020 18:56:45 +0000 Subject: first set of changes to docs Signed-off-by: ishu verma --- diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index 888f8b7..3e7bff2 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -8,19 +8,28 @@ image::iot-fedora.svg[SoC board] == Supported Platforms -For the moment Fedora IoT supports the x86_64 and aarch64 architectures. +For the moment, Fedora IoT supports the x86_64 and aarch64 architectures. The components to support ARMv7 are being worked upon and will be added shortly. -We have a page covering the currently tested xref:reference-platforms.adoc[Reference Platforms]. -Other devices supported by Fedora on either x86_64 or aarch64 should work just fine but haven't been widely tested in the IoT context so your milage may vary. +Refer to the list of currently tested xref:reference-platforms.adoc[Reference Platforms]. The list of supported reference platforms will expand over time. +Other x86_64 or aarch64 platforms should work just fine but haven't been widely tested in the IoT context so your milage may vary. -The list of supported reference devices will expand with time. -If you're a hardware vendor and would like to have a device become a reference platform by actively participating and testing Fedora IoT, +If you're a hardware vendor and would like to have a device become a reference platform by actively participating and testing Fedora IoT, please reach out to https://fedoraproject.org/wiki/User:Pbrobinson[Peter Robinson], the Fedora IoT Lead. -== Required resources +== Required Resources +The current images are 4GB in size and tested with 1GB of RAM. +The Fedora IoT base image should be able to run with less resources, but of course this will limit the amount of container applications that can be run on top of the base OS. -The images being created are currently 4GB in size. -The current memory used for testing is 1GB of RAM. -The Fedora IoT base image should run with less, -but of course this limits the amount of container applications that can be run on top of the base OS. +== Download Image + +Fedora IoT images for download are available at the Fedora IoT https://iot.fedoraproject.org[landing page]. + +== Setup VM or Physical Device + +- Follow these steps to link:virtual-machine-setup.adoc[setup virtual machine] + +- Follow these steps to link:physical-device-setup.adoc[setup physical device] + + +Follow the setup instructions from initial-setup.adoc[Initial Setup] diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 9a1ccec..e60dae6 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,6 +1,27 @@ = Welcome -Welcome to Fedora Internet of Things. This is the home to the documentation for the Fedora Internet of Things objective. +Welcome to Fedora Internet of Things homepage. Fedora Internet of Things is a Fedora Edition to provide a strong foundation for IoT ecosystems. Whether you're working on a project at home, industrial gateways, smart cities or analytics with AI/ML, Fedora IoT can provide a trusted open source platform to build on. Fedora IoT rolling releases help you keep your ecosystem up-to-date. + +== Why use Fedora IoT? +The operating system (OS) for IoT systems needs to be immutable and image based, where image is fully tested centrally and signed before being deployed at scale to IoT systems. As these IoT systems are often located remotely, the OS should support atomic updates so nothing changes until the device is rebooted and rollback capability so it is easy to recover remotely if there is a failure during upgrade. + +The Fedora IoT images work with https://rpm-ostree.readthedocs.io/en/latest/[rpm-ostree], a hybrid image/package system. It supports package layering, which allows installation of RPMs for additional hardware support or applications. The GPG signed image based deployments scale well to very large numbers of clients. Updates are atomic with easy rollback capability. + +The Fedora IoT images also have excellent support for container-focused workflows. Containers allow you to separate core OS updates from application updates as well as test and deploy different versions of applications. The https://podman.io/[podman] daemon is light weight and ready for you to download or create containers for your home assistant, industrial gateways, or data storage and analytics. + +== Is Fedora IoT for you? + +If you are looking for a graphical desktop environment based on OSTree and designed for developers, look at https://silverblue.fedoraproject.org/[Fedora Silverblue]. + +If you are looking for a traditional dnf based operating system for your ARM device, look at https://arm.fedoraproject.org/[Fedora ARM] + +If you are looking for a lightweight yet powerful and scalable core OS for your Internet of Things project, you came to the right place! getting-started.adoc[Get Started with Fedora IoT]! + +If you are after an OS for Kubernetes there is https://getfedora.org/en/coreos/[Fedora CoreOS] + +== Contribute to Fedora IoT Edition +[TODO] + == Communications diff --git a/modules/ROOT/pages/obtaining-images.adoc b/modules/ROOT/pages/obtaining-images.adoc index b7e266d..56a6529 100644 --- a/modules/ROOT/pages/obtaining-images.adoc +++ b/modules/ROOT/pages/obtaining-images.adoc @@ -6,15 +6,15 @@ Available images for download are described on the IoT https://iot.fedoraproject The use of https://ostree.readthedocs.io/en/latest/[OSTree] brings fully atomic upgrades, easy rollbacks and workflows that are familiar to users of immutable, image based servers. -An OS image that is composed on the server side allows for testing the exact bits before they reach client systems, leading to more reliable updates. +An OS image that is composed on the server side allows for testing the exact bits before they reach client systems, leading to more reliable updates. The GPG signed image based deployments scale well to very large numbers of clients. Updates are atomic so nothing changes until the device is rebooted and the rollback capability makes it easy to recover remotely if there is a failure during upgrade. -The Fedora IoT images work with https://rpm-ostree.readthedocs.io/en/latest/[rpm-ostree] which is a hybrid image/package system. +The Fedora IoT images work with https://rpm-ostree.readthedocs.io/en/latest/[rpm-ostree] which is a hybrid image/package system. It supports package layering, which allows installation of RPMs for additional hardware support or applications. The Fedora IoT images also have excellent support for container-focused workflows. -Containers allow you to separate core OS updates from application updates as well as test and deploy different versions of applications. +Containers allow you to separate core OS updates from application updates as well as test and deploy different versions of applications. The https://podman.io/[podman] daemon is light weight and ready for you to download or create containers for your home assistant, industrial gateways, or data storage and analytics. == Pick the Right Tool for the Job @@ -24,6 +24,3 @@ If you are looking for a graphical desktop environment based on OSTree and desig If you are looking for a traditional dnf based operating system for your ARM device, look at https://arm.fedoraproject.org/[Fedora ARM] If you are looking for a lightweight yet powerful and scalable core OS for your Internet of Things project, you came to the right place! https://iot.fedoraproject.org/[Download the images now]! - -If you are after an OS for kubernetes there is https://getfedora.org/en/coreos/[Fedora CoreOS] - diff --git a/modules/ROOT/pages/user-guide.adoc b/modules/ROOT/pages/user-guide.adoc index 6bb915f..a2a5371 100644 --- a/modules/ROOT/pages/user-guide.adoc +++ b/modules/ROOT/pages/user-guide.adoc @@ -15,7 +15,7 @@ We have a page covering the currently tested xref:reference-platforms.adoc[Refer Other devices supported by Fedora on either x86_64 or aarch64 should work just fine but haven't been widely tested in the IoT context so your milage may vary. The list of supported reference devices will expand with time. -If you're a hardware vendor and would like to have a device become a reference platform by actively participating and testing Fedora IoT, +If you're a hardware vendor and would like to have a device become a reference platform by actively participating and testing Fedora IoT, please reach out to https://fedoraproject.org/wiki/User:Pbrobinson[Peter Robinson], the Fedora IoT Lead. == Required resources