From c36abb4faea1e5ab4b0a97c562d6e9eca0e7d46e Mon Sep 17 00:00:00 2001 From: Susan Lauber Date: Feb 04 2019 15:07:57 +0000 Subject: Organize "next step" pages into a User Guide --- diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index f36d229..f0bb4cf 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -4,11 +4,14 @@ ** xref:virtual-machine-setup.adoc[Setting up a Virtual Machine] ** xref:physical-device-setup.adoc[Setting up a Physical Device] ** xref:initial-setup.adoc[Initial Setup once the VM or Phyical device is running] -** xref:applying-updates.adoc[Applying updates] -** xref:moving-between.adoc[Moving between stable and development nightly build trees] +** xref:applying-updates-GS.adoc[Applying updates] * xref:reference-platforms.adoc[Reference Platforms] -* xref:enabling-wireless.adoc[Enabling wireless support on the DB410c and Raspberry Pi] -* xref:general-commands.adoc[General commands] -* xref:container-support.adoc[Container support] +* xref:user-guide.adoc[User Guide] +** xref:applying-updates-UG.adoc[Updates and rollbacks] +** xref:adding-layered.adoc[Adding layered packages] +*** xref:general-commands.adoc[General commands] +*** xref:enabling-wireless.adoc[Example: Enabling wireless support on the DB410c] +** xref:container-support.adoc[Container support] +** xref:moving-between.adoc[Moving between stable and development nightly build trees] * xref:release-criteria.adoc[Release Criteria] * xref:prd.adoc[Product Requirement Doc] diff --git a/modules/ROOT/pages/adding-layered.adoc b/modules/ROOT/pages/adding-layered.adoc new file mode 100644 index 0000000..9e783ec --- /dev/null +++ b/modules/ROOT/pages/adding-layered.adoc @@ -0,0 +1,4 @@ += Adding layered packages + +This page needs to be written + diff --git a/modules/ROOT/pages/applying-updates-GS.adoc b/modules/ROOT/pages/applying-updates-GS.adoc new file mode 100644 index 0000000..70c329f --- /dev/null +++ b/modules/ROOT/pages/applying-updates-GS.adoc @@ -0,0 +1,8 @@ += Applying updates + +The latest image builds for x86\_64 and aarch64 are available at https://download.fedoraproject.org/pub/alt/iot/[here]. The OSTree update deltas are available on CDN using the following command: + +---- +sudo rpm-ostree upgrade +---- + diff --git a/modules/ROOT/pages/applying-updates-UG.adoc b/modules/ROOT/pages/applying-updates-UG.adoc new file mode 100644 index 0000000..685f40a --- /dev/null +++ b/modules/ROOT/pages/applying-updates-UG.adoc @@ -0,0 +1,30 @@ += Upgrades and Rollbacks + +There are nightly image builds for x86\_64 and aarch64 available https://download.fedoraproject.org/pub/alt/iot/[here]. + +Upgrade to the latest +--------------------- +The OSTree update deltas are available on CDN using the following command: + +---- +rpm-ostree upgrade +---- + +If this command is run as a non-privilaged user, there will be a prompt for authentication. + +Rollback to the previous tree +----------------------------- + +---- +rpm-ostree rollback +---- + +If this command is run as a non-privilaged user, there will be a prompt for authentication. + +Display the status of the currently running deployment +------------------------------------------------------ + +---- +rpm-ostree status +---- + diff --git a/modules/ROOT/pages/applying-updates.adoc b/modules/ROOT/pages/applying-updates.adoc deleted file mode 100644 index 7689256..0000000 --- a/modules/ROOT/pages/applying-updates.adoc +++ /dev/null @@ -1,8 +0,0 @@ -= Applying updates - -There's nightly image builds for x86\_64 and aarch64 available https://download.fedoraproject.org/pub/alt/iot/[here]. The OSTree update deltas are available on CDN using the following command: - ----- -sudo rpm-ostree upgrade ----- - diff --git a/modules/ROOT/pages/general-commands.adoc b/modules/ROOT/pages/general-commands.adoc index 91547fd..edd4e00 100644 --- a/modules/ROOT/pages/general-commands.adoc +++ b/modules/ROOT/pages/general-commands.adoc @@ -12,14 +12,3 @@ Add a layered package rpm-ostree install ---- -Upgrade to the latest - ----- -rpm-ostree upgrade ----- - -Rollback to the previous tree - ----- -rpm-ostree rollback ----- diff --git a/modules/ROOT/pages/user-guide.adoc b/modules/ROOT/pages/user-guide.adoc new file mode 100644 index 0000000..6bb915f --- /dev/null +++ b/modules/ROOT/pages/user-guide.adoc @@ -0,0 +1,26 @@ += User Guide + + +Welcome to the user guide for Fedora IoT. +Both this guide and Fedora IoT images are in the very early stages, so please report any issues to https://lists.fedoraproject.org/admin/lists/iot.lists.fedoraproject.org/[the mailing list]. + +image::iot-fedora.svg[SoC board] + +== Supported Platforms + +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. + +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, +please reach out to https://fedoraproject.org/wiki/User:Pbrobinson[Peter Robinson], the Fedora IoT Lead. + +== Required resources + +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 can be run on top of the base OS.