patches and low-level development discussion
 help / color / mirror / code / Atom feed
* [PATCH] Docs: new structure
@ 2022-09-06 13:55 Jenni Nikolaenko
  2022-09-19  9:30 ` Alyssa Ross
  0 siblings, 1 reply; 12+ messages in thread
From: Jenni Nikolaenko @ 2022-09-06 13:55 UTC (permalink / raw)
  To: devel; +Cc: Jenni Nikolaenko

Create separate folders for new parent pages, update Introduction page,
remove a and the articles from titles, quick check text for simple english

Signed-off-by: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
---
 Documentation/{ => about}/architecture.adoc   | 19 ++++-----
 Documentation/about/index.adoc                | 21 ++++++++++
 .../decisions/001-host-update-mechanism.adoc  |  2 +-
 .../decisions/002-install-options.adoc        |  4 +-
 Documentation/decisions/003-partitioning.adoc |  2 +-
 .../004-data-at-rest-encryption.adoc          |  2 +-
 .../005-virtual-machine-monitor.adoc          |  2 +-
 .../decisions/006-drivers-on-host.adoc        |  2 +-
 .../decisions/007-usb-virtual-machines.adoc   |  2 +-
 ...008-inter-vm-communication-mechanisms.adoc |  2 +-
 Documentation/decisions/index.adoc            |  2 +-
 .../building-documentation.adoc               | 10 ++---
 .../{ => development}/debugging.adoc          |  7 ++--
 .../{ => development}/first-patch.adoc        | 28 +++++++------
 Documentation/development/index.adoc          | 17 ++++++++
 Documentation/{ => development}/replying.adoc |  4 +-
 .../{ => development}/reviewing-patches.adoc  |  4 +-
 .../{ => development}/testing-patches.adoc    | 42 ++++++++-----------
 .../{ => development}/uuid-reference.adoc     |  4 +-
 Documentation/explanation.adoc                |  3 +-
 .../{ => getting-started}/creating-vms.adoc   |  2 +-
 Documentation/getting-started/index.adoc      |  7 ++++
 .../{ => getting-started}/running-vms.adoc    |  2 +-
 .../{ => getting-started}/user-partition.adoc |  8 ++--
 Documentation/how-to.adoc                     |  1 +
 Documentation/index.adoc                      | 22 +++++++---
 Documentation/{ => installation}/b4.adoc      |  3 +-
 .../{ => installation}/binary-cache.adoc      | 11 ++---
 .../{ => installation}/getting-spectrum.adoc  | 11 ++---
 Documentation/installation/index.adoc         | 18 ++++++++
 Documentation/reference.adoc                  |  3 +-
 Documentation/tutorials.adoc                  |  3 +-
 32 files changed, 171 insertions(+), 99 deletions(-)
 rename Documentation/{ => about}/architecture.adoc (84%)
 create mode 100644 Documentation/about/index.adoc
 rename Documentation/{ => development}/building-documentation.adoc (85%)
 rename Documentation/{ => development}/debugging.adoc (92%)
 rename Documentation/{ => development}/first-patch.adoc (83%)
 create mode 100644 Documentation/development/index.adoc
 rename Documentation/{ => development}/replying.adoc (93%)
 rename Documentation/{ => development}/reviewing-patches.adoc (89%)
 rename Documentation/{ => development}/testing-patches.adoc (62%)
 rename Documentation/{ => development}/uuid-reference.adoc (98%)
 rename Documentation/{ => getting-started}/creating-vms.adoc (98%)
 create mode 100644 Documentation/getting-started/index.adoc
 rename Documentation/{ => getting-started}/running-vms.adoc (93%)
 rename Documentation/{ => getting-started}/user-partition.adoc (80%)
 rename Documentation/{ => installation}/b4.adoc (96%)
 rename Documentation/{ => installation}/binary-cache.adoc (90%)
 rename Documentation/{ => installation}/getting-spectrum.adoc (85%)
 create mode 100644 Documentation/installation/index.adoc

diff --git a/Documentation/architecture.adoc b/Documentation/about/architecture.adoc
similarity index 84%
rename from Documentation/architecture.adoc
rename to Documentation/about/architecture.adoc
index 1c4307b..db82d60 100644
--- a/Documentation/architecture.adoc
+++ b/Documentation/about/architecture.adoc
@@ -1,17 +1,16 @@
 = Architecture
-:page-parent: Explanation
+:page-parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-FileCopyrightText: 2022 Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
-== Introduction
+Spectrum OS is based on the principle of security by compartmentalization.
 
-Spectrum is based on the principle of security by
-compartmentalization.  The high level stack is illustrated in the
-following diagram:
+The high level stack is illustrated in the following diagram:
 
-image::diagrams/stack.svg[]
+image::../diagrams/stack.svg[]
 
 The default set of virtual machines includes two application VMs,
 _appvm-catgirl_ (an IRC client) and _appvm-lynx_ (a text-based web
@@ -26,7 +25,7 @@ https://en.wikipedia.org/wiki/Architectural_decision[Architecturally significant
 decisions] are xref:decisions/index.adoc[recorded] as lightweight
 https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions/[ADRs].
 
-== The Spectrum host system
+== Spectrum Host System
 
 Compartmentalization is implemented using
 https://cloud-hypervisor.org/[cloud-hypervisor] virtual machines.
@@ -35,7 +34,7 @@ https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine[Kernel-based Virtual
 Machine] (KVM) to provide lightweight, hardware-accelerated VMs.
 
 While Linux (including KVM) is portable between many hardware architectures,
-cloud-hypervisor supports only x86_64 and aarch64.  Spectrum currently only
+cloud-hypervisor supports only x86_64 and aarch64. Spectrum currently only
 works on x86_64, but aarch64 support is in development.
 
 https://skarnet.org/software/s6-rc/overview.html[s6-rc] is used for service
@@ -44,7 +43,7 @@ and service scripts.
 
 https://wayland.freedesktop.org/[Wayland] is used for window management and
 display.  The Wayland architecture is well documented
-https://wayland.freedesktop.org/architecture.html[here].  The host provides only
+https://wayland.freedesktop.org/architecture.html[here]. The host provides only
 a Wayland terminal client, https://codeberg.org/dnkl/foot/[foot], which is used
 for interacting with VM consoles.  In future it will be possible for application
 VMs to display windows on the single Wayland compositor on the host system,
@@ -57,7 +56,7 @@ https://www.etalabs.net/compare_libcs.html[added safety on resource exhaustion
 and security hardening on memory allocation].  Kernel hardening will be
 investigated in future.
 
-== Exploring the Spectrum dependency tree
+== Spectrum Dependency Tree
 
 For a detailed, interactive view of dependencies, use
 https://github.com/utdemir/nix-tree[nix-tree] in the Spectrum repository:
diff --git a/Documentation/about/index.adoc b/Documentation/about/index.adoc
new file mode 100644
index 0000000..a882852
--- /dev/null
+++ b/Documentation/about/index.adoc
@@ -0,0 +1,21 @@
+= About Spectrum OS
+:description: Some words about Spectrum as the operating system, not a project. Highlights the differences between common Linux distributions and Spectrum.
+:page-nav_order: 1
+:page-has_children: true
+
+// SPDX-FileCopyrightText: 2022 Jenni Nikko <evgeniia.nikolaenko@unikie.com>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+Spectrum is a Linux-based system, derived from NixOS. This gives an actively-developed base with good hardware support, powerful and optimised compartmentalization primitives in KVM, and the reproducible packaging and configuration system that is important for a maintainable compartmentalized system.
+
+== Why Spectrum
+
+There are several features that make Spectrum OS unique:
+
+* User data and applications are managed centrally, while remaining isolated.
+That means that the system can be backed up and managed as a whole, rather than mixed up in several dozen VMs.
+
+* The host system and isolated environments are managed declaratively and reproducibly using the Nix package manager.
+This can save the user the burden of maintaining many different virtual computers, allowing finer-grained resource access controls and making it possible to verify the software running across all environments.
+
+TIP: If you are interested in why we do something _this_ way instead of _that_ way, see xref:../decisions/index.adoc[Architecture Decision Records].
diff --git a/Documentation/decisions/001-host-update-mechanism.adoc b/Documentation/decisions/001-host-update-mechanism.adoc
index 574deb4..7032146 100644
--- a/Documentation/decisions/001-host-update-mechanism.adoc
+++ b/Documentation/decisions/001-host-update-mechanism.adoc
@@ -1,6 +1,6 @@
 = 001 Host Update Mechanism
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/002-install-options.adoc b/Documentation/decisions/002-install-options.adoc
index 4412b53..a7c4175 100644
--- a/Documentation/decisions/002-install-options.adoc
+++ b/Documentation/decisions/002-install-options.adoc
@@ -1,6 +1,6 @@
-= 002 Install options
+= 002 Install Options
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/003-partitioning.adoc b/Documentation/decisions/003-partitioning.adoc
index 8494ea4..b00f528 100644
--- a/Documentation/decisions/003-partitioning.adoc
+++ b/Documentation/decisions/003-partitioning.adoc
@@ -1,6 +1,6 @@
 = 003 Partitioning
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/004-data-at-rest-encryption.adoc b/Documentation/decisions/004-data-at-rest-encryption.adoc
index 26fe273..27323db 100644
--- a/Documentation/decisions/004-data-at-rest-encryption.adoc
+++ b/Documentation/decisions/004-data-at-rest-encryption.adoc
@@ -1,6 +1,6 @@
 = 004 Data at Rest Encryption
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/005-virtual-machine-monitor.adoc b/Documentation/decisions/005-virtual-machine-monitor.adoc
index db81c72..df5a65e 100644
--- a/Documentation/decisions/005-virtual-machine-monitor.adoc
+++ b/Documentation/decisions/005-virtual-machine-monitor.adoc
@@ -1,6 +1,6 @@
 = 005 Virtual Machine Monitor
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/006-drivers-on-host.adoc b/Documentation/decisions/006-drivers-on-host.adoc
index 872044e..86d3105 100644
--- a/Documentation/decisions/006-drivers-on-host.adoc
+++ b/Documentation/decisions/006-drivers-on-host.adoc
@@ -1,6 +1,6 @@
 = 006 Drivers on Host
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/007-usb-virtual-machines.adoc b/Documentation/decisions/007-usb-virtual-machines.adoc
index 3bdf78b..24dac65 100644
--- a/Documentation/decisions/007-usb-virtual-machines.adoc
+++ b/Documentation/decisions/007-usb-virtual-machines.adoc
@@ -1,6 +1,6 @@
 = 007 USB Virtual Machine
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/008-inter-vm-communication-mechanisms.adoc b/Documentation/decisions/008-inter-vm-communication-mechanisms.adoc
index a1b7d49..9fce4ef 100644
--- a/Documentation/decisions/008-inter-vm-communication-mechanisms.adoc
+++ b/Documentation/decisions/008-inter-vm-communication-mechanisms.adoc
@@ -1,6 +1,6 @@
 = 008 Inter-VM Communication Mechanisms
 :page-parent: Architecture Decision Records
-:page-grand_parent: Explanation
+:page-grand_parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/decisions/index.adoc b/Documentation/decisions/index.adoc
index 772f382..4f3a7e1 100644
--- a/Documentation/decisions/index.adoc
+++ b/Documentation/decisions/index.adoc
@@ -1,6 +1,6 @@
 = Architecture Decision Records
 :page-has_children: true
-:page-parent: Explanation
+:page-parent: About Spectrum OS
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/building-documentation.adoc b/Documentation/development/building-documentation.adoc
similarity index 85%
rename from Documentation/building-documentation.adoc
rename to Documentation/development/building-documentation.adoc
index b491105..da5fa8c 100644
--- a/Documentation/building-documentation.adoc
+++ b/Documentation/development/building-documentation.adoc
@@ -1,5 +1,5 @@
-= Building the Documentation
-:page-parent: Tutorials
+= Building Documentation
+:page-parent: Development
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
@@ -47,6 +47,6 @@ IMPORTANT: Jekyll doesn't handle rendering of the draw.io diagrams, so
 if you modify any of those, or add new ones, you'll have to run
 `scripts/build.sh` again to do a full rebuild of the site.
 
-Once you've made your changes to the documentation, see
-xref:first-patch.adoc[Sending Your First Patch] for information
-about how to submit them for review.
+Once you made your changes to the documentation, see
+xref:first-patch.adoc[Patching] for information
+on how to submit your patch for review.
diff --git a/Documentation/debugging.adoc b/Documentation/development/debugging.adoc
similarity index 92%
rename from Documentation/debugging.adoc
rename to Documentation/development/debugging.adoc
index 3871a7c..6e529a9 100644
--- a/Documentation/debugging.adoc
+++ b/Documentation/development/debugging.adoc
@@ -1,7 +1,6 @@
-= Debugging Spectrum
-:page-parent: Explanation
-:toc:
-:toclevels: 1
+= Debugging
+:page-parent: Development
+:page-nav_order: 2
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/first-patch.adoc b/Documentation/development/first-patch.adoc
similarity index 83%
rename from Documentation/first-patch.adoc
rename to Documentation/development/first-patch.adoc
index 30672b9..7b8dd1d 100644
--- a/Documentation/first-patch.adoc
+++ b/Documentation/development/first-patch.adoc
@@ -1,11 +1,12 @@
-= Sending Your First Patch
-:page-parent: Tutorials
+= Patching
+:page-parent: Development
+:page-nav_order: 1
+:page-has_children: true
+:toc: preamble
 
 // SPDX-FileCopyrightText: 2022 Unikie
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
-== Prerequisites
-
 This tutorial assumes that you already have basic
 https://git-scm.com/[git] experience.
 
@@ -14,10 +15,10 @@ https://spectrum-os.org/git/[Spectrum source tree].  You'll also need
 to have configured `git send-email` — a guide for this can be found at
 https://git-send-email.io/.
 
-== Making your changes
+== Making Changes
 
-If you've worked on any git repository before, the process for making
-your changes will probably be very familiar.
+If you worked on any git repository before, the process for making
+your changes will be very familiar.
 
 1. Create a branch for your changes:
 +
@@ -39,7 +40,7 @@ indicates your acceptance of the
 https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt[Developer's
 Certificate of Origin], which is mandatory for Spectrum patches.
 
-== Submitting changes
+== Submitting Changes
 
 Once you're happy with how the commits on your branch look, run:
 
@@ -64,13 +65,14 @@ message that will be sent before all of your patches.
 
 Once your patch has been submitted, wait for it to be reviewed.
 Feedback, if any, will be sent as email replies to your submitted
-patch.  You can respond to feedback in your mail client.  Please use
-the Reply All button to ensure that your messages are sent to the
+patch.  You can respond to feedback in your mail client.
+
+Use the *Reply All* button to sent your messages to the
 mailing list as well as to the person who sent the feedback.
 
-If you need to make changes to your patch, and submit a new version,
+If you need to make changes to your patch and submit a new version,
 use https://git-rebase.io/[`git rebase`] to create a new version of
-your patch(es), and submit it like this:
+your patch(es) and then submit it like this:
 
 [source,shell]
 ----
@@ -81,7 +83,7 @@ The added `-v2` flag indicates that this is version two of your
 patch set.  If your patches require more rounds of changes, submit
 subsequent rounds with `-v3`, `-v4`, etc. as appropriate.
 
-If you'd like to describe what has changed from the previous version
+If you would like to describe what has changed from the previous version
 of your patches, you can do so in a xref:cover-letter[cover letter]
 as described above.
 
diff --git a/Documentation/development/index.adoc b/Documentation/development/index.adoc
new file mode 100644
index 0000000..471daf7
--- /dev/null
+++ b/Documentation/development/index.adoc
@@ -0,0 +1,17 @@
+= Development
+:description: Development progress, general development practices
+:page-nav_order: 4
+:page-has_children: true
+
+// SPDX-FileCopyrightText: 2022 Jenni Nikko <evgeniia.nikolaenko@unikie.com>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+Spectrum is free software, currently under active development.
+
+== Developer Setup
+
+Before starting, make sure you are familiar with https://git.kernel.org/pub/scm/utils/b4/b4.git/about/[b4] and the https://nixos.org/manual/nix/stable/introduction.html[Nix package manager].
+
+== Mailing Lists
+
+The Spectrum project runs several https://spectrum-os.org/mailman3/lists/?all-lists[mailing lists] on which you can ask your questions or help other people with the questions they have. All the Spectrum developers as well as many long time Linux and Spectrum users are on the lists.
diff --git a/Documentation/replying.adoc b/Documentation/development/replying.adoc
similarity index 93%
rename from Documentation/replying.adoc
rename to Documentation/development/replying.adoc
index bb8e31a..05740a0 100644
--- a/Documentation/replying.adoc
+++ b/Documentation/development/replying.adoc
@@ -1,5 +1,7 @@
 = Replying to Messages in the Mailing List Archives
-:page-parent: Tutorials
+:page-parent: Patching
+:page-grand_parent: Development
+:page-nav_order: 3
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/reviewing-patches.adoc b/Documentation/development/reviewing-patches.adoc
similarity index 89%
rename from Documentation/reviewing-patches.adoc
rename to Documentation/development/reviewing-patches.adoc
index 63ff24e..c8c971f 100644
--- a/Documentation/reviewing-patches.adoc
+++ b/Documentation/development/reviewing-patches.adoc
@@ -1,5 +1,7 @@
 = Reviewing Patches
-:page-parent: How-to Guides
+:page-parent: Patching
+:page-grand_parent: Development
+:page-nav_order: 2
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/testing-patches.adoc b/Documentation/development/testing-patches.adoc
similarity index 62%
rename from Documentation/testing-patches.adoc
rename to Documentation/development/testing-patches.adoc
index 8ba7804..99adfd2 100644
--- a/Documentation/testing-patches.adoc
+++ b/Documentation/development/testing-patches.adoc
@@ -1,5 +1,8 @@
 = Testing Patches
-:page-parent: How-to Guides
+:page-parent: Patching
+:page-grand_parent: Development
+:page-nav_order: 1
+:toc: preamble
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
@@ -8,52 +11,41 @@ Potential changes to Spectrum are posted to and discussed on the
 https://spectrum-os.org/participating.html#spectrum-devel[devel@spectrum-os.org]
 mailing list.
 
-== Apply the patch
+== Apply Patch
 
 If you haven't already, you'll first need to xref:b4.adoc[install and
 configure] https://git.kernel.org/pub/scm/utils/b4/b4.git/about/[b4].
 Then:
 
-. Find the patch series you want to test on
-  https://spectrum-os.org/lists/archives/spectrum-devel/[public-inbox].
-. Navigate to the "permalink" page for any patch in the series.
-. Copy the Message-Id for the patch, as shown on the permalink page, e.g.
-  \20220511092352.70E54C980@atuin.qyliss.net.
-. In a checkout of the appropriate git repository
-  (https://spectrum-os.org/git/spectrum[Spectrum] or
-  https://spectrum-os.org/git/nixpkgs[Spectrum Nixpkgs]), Run `b4 am`
-  with the patch's Message-Id to download all the patches in the
-  series into a file.
+1. Find the patch series you want to test on https://spectrum-os.org/lists/archives/spectrum-devel/[public-inbox].
+2. Navigate to the "permalink" page for any patch in the series.
+3. Copy the Message-Id for the patch, as shown on the permalink page, e.g.  \20220511092352.70E54C980@atuin.qyliss.net.
+4. In a checkout of the appropriate git repository   (https://spectrum-os.org/git/spectrum[Spectrum] or   https://spectrum-os.org/git/nixpkgs[Spectrum Nixpkgs]), run `b4 am` with the patch's Message-Id to download all the patches in the series into a file.
 +
-[example]
 [source,shell]
 ----
 b4 am 20220511092352.70E54C980@atuin.qyliss.net
 ----
-
-. b4 will indicate the file name it has downloaded the patches into
-  with a line like:
+b4 will indicate the file name it has downloaded the patches into with a line like:
 +
-[example]
-[listing]
+[source,shell]
+----
 Writing ./20220424_hi_host_rootfs_fix_weston_hotplugging.mbx
+----
+5. Run `git am` on that file to apply the patches, for example:
 +
-Run `git am` on that file to apply the patches, for example:
-+
-[example]
 [source,shell]
 ----
 git am 20220424_hi_host_rootfs_fix_weston_hotplugging.mbx
 ----
 
-== Post your test results
+== Post Your Results
 
 When you've tested a patch, it's really helpful to
 xref:replying.adoc[reply] with your test results.
 
-If the patch worked for you, please reply to it and include a line
-like the following, separated from any reply text:
-
+If the patch worked for you, please reply to it and include a line like the following, separated from any reply text:
+[source,shell]
 ----
 Tested-by: John Smith <john@example.com>
 ----
diff --git a/Documentation/uuid-reference.adoc b/Documentation/development/uuid-reference.adoc
similarity index 98%
rename from Documentation/uuid-reference.adoc
rename to Documentation/development/uuid-reference.adoc
index 4b0b481..0eccc82 100644
--- a/Documentation/uuid-reference.adoc
+++ b/Documentation/development/uuid-reference.adoc
@@ -1,5 +1,5 @@
 = UUID Reference
-:page-parent: Reference
+:page-parent: Development
 :toc: preamble
 :toclevels: 1
 
@@ -40,7 +40,7 @@ xref:user-partition.adoc[Spectrum user partition].
 
 === `56a3bbc3-aefa-43d9-a64d-7b3fd59bbc4e`
 
-https://github.com/endlessm/eos-installer["eosimages"] partition on the 
+https://github.com/endlessm/eos-installer["eosimages"] partition on the
 Spectrum combined live system / installer image.
 
 == Combined Image Partition IDs
diff --git a/Documentation/explanation.adoc b/Documentation/explanation.adoc
index b39cc6d..f682129 100644
--- a/Documentation/explanation.adoc
+++ b/Documentation/explanation.adoc
@@ -1,6 +1,5 @@
 = Explanation
-:page-has_children: true
-:page-nav_order: 4
+:page-nav_exclude: true
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/creating-vms.adoc b/Documentation/getting-started/creating-vms.adoc
similarity index 98%
rename from Documentation/creating-vms.adoc
rename to Documentation/getting-started/creating-vms.adoc
index d967098..e06be85 100644
--- a/Documentation/creating-vms.adoc
+++ b/Documentation/getting-started/creating-vms.adoc
@@ -1,5 +1,5 @@
 = Creating VMs
-:page-parent: Reference
+:page-parent: Getting Started
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/getting-started/index.adoc b/Documentation/getting-started/index.adoc
new file mode 100644
index 0000000..1b468ab
--- /dev/null
+++ b/Documentation/getting-started/index.adoc
@@ -0,0 +1,7 @@
+= Getting Started
+:description: Exploring Spectrum OS. Using (=How-To-Guides), Configuring (adding smth). Ready to get started with Spectrum OS? After installing you can create VMs and then configure each one.
+:page-nav_order: 3
+:page-has_children: true
+
+// SPDX-FileCopyrightText: 2022 Jenni Nikko <evgeniia.nikolaenko@unikie.com>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/running-vms.adoc b/Documentation/getting-started/running-vms.adoc
similarity index 93%
rename from Documentation/running-vms.adoc
rename to Documentation/getting-started/running-vms.adoc
index d0d3f99..9073e3c 100644
--- a/Documentation/running-vms.adoc
+++ b/Documentation/getting-started/running-vms.adoc
@@ -1,5 +1,5 @@
 = Running VMs
-:page-parent: Reference
+:page-parent: Getting Started
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/user-partition.adoc b/Documentation/getting-started/user-partition.adoc
similarity index 80%
rename from Documentation/user-partition.adoc
rename to Documentation/getting-started/user-partition.adoc
index 73bc0d0..a33d7fc 100644
--- a/Documentation/user-partition.adoc
+++ b/Documentation/getting-started/user-partition.adoc
@@ -1,11 +1,13 @@
-= The User Partition
-:page-parent: Explanation
+= User Partition
+:page-parent: Getting Started
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
 The Spectrum host system is immutable, so configuration and user data
-lives on a separate partition.  The host system discovers the user
+lives on a separate partition.
+
+The host system discovers the user
 partition by looking for the special partition type
 `9293e1ff-cee4-4658-88be-898ec863944f`.  This behavior can be
 overridden with the `ext` parameter on the host's kernel command line,
diff --git a/Documentation/how-to.adoc b/Documentation/how-to.adoc
index f43fa13..98cc842 100644
--- a/Documentation/how-to.adoc
+++ b/Documentation/how-to.adoc
@@ -1,4 +1,5 @@
 = How-to Guides
+:page-nav_exclude: true
 :page-has_children: true
 :page-nav_order: 2
 
diff --git a/Documentation/index.adoc b/Documentation/index.adoc
index 3079847..d26676b 100644
--- a/Documentation/index.adoc
+++ b/Documentation/index.adoc
@@ -1,13 +1,23 @@
-= Spectrum Docs
+= Spectrum Documentation
 :page-nav_exclude: true
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+// SPDX-FileCopyrightText: 2022 Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
-Spectrum is a compartmentalized operating system.
+== Spectrum Project
 
-If you'd like to try Spectrum, see xref:getting-spectrum.adoc[Getting
-Spectrum].
+Spectrum is an open source project that aims to create a computer operating system, based on the principle of security by compartmentalization, that has a lower barrier to entry and is easier to use and maintain than other such systems. For more information on the Spectrum project, see https://spectrum-os.org/.
 
-To learn about what Spectrum is and how it's implemented, start with
-the xref:architecture.adoc[architecture overview].
+Spectrum is made of free and open source software. It is free for anyone to use, modify, and distribute. If you want to be involved with the Spectrum project, see https://spectrum-os.org/contributing.html.
+
+The Spectrum project source code is https://spectrum-os.org/git/spectrum.
+
+== Spectrum OS
+
+Spectrum is an in-development operating system that aims to afford its users security by compartmentalization, while also improving upon other similar projects by maintaining a high level of usability.
+
+To learn about what Spectrum OS is and how it's implemented, start with
+the xref:about/architecture.adoc[architecture overview].
+
+If you want to try Spectrum, see xref:../installation/index.adoc[Build and Run].
diff --git a/Documentation/b4.adoc b/Documentation/installation/b4.adoc
similarity index 96%
rename from Documentation/b4.adoc
rename to Documentation/installation/b4.adoc
index 2519894..1ba87b2 100644
--- a/Documentation/b4.adoc
+++ b/Documentation/installation/b4.adoc
@@ -1,5 +1,6 @@
 = Installing and Configuring b4
-:page-parent: Tutorials
+:page-parent: Build and Run
+:page-nav_order: 3
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/binary-cache.adoc b/Documentation/installation/binary-cache.adoc
similarity index 90%
rename from Documentation/binary-cache.adoc
rename to Documentation/installation/binary-cache.adoc
index 6e69b39..232f96c 100644
--- a/Documentation/binary-cache.adoc
+++ b/Documentation/installation/binary-cache.adoc
@@ -1,10 +1,11 @@
-= Setting Up the Binary Cache
-:page-parent: How-to Guides
+= Setting Up Binary Cache
+:page-parent: Build and Run
+:page-nav_order: 1
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
-Building Spectrum from source can take a very long time.  To avoid
+Building Spectrum OS from source can take a very long time.  To avoid
 having to wait when building the system to try it out or test patches,
 an x86_64 binary cache service is available.  If configured to do so,
 Nix will download build outputs from the cache, instead of building
@@ -20,7 +21,7 @@ encounter any trouble with it.
 The binary cache is currently not able to provide logs, due to a
 https://github.com/NixOS/nix/pull/6051[Nix bug].
 
-== On NixOS
+== For NixOS
 
 The following configuration adds the Spectrum binary cache as a
 substituter, and tells Nix to trust builds signed with its public key.
@@ -38,7 +39,7 @@ substituter, and tells Nix to trust builds signed with its public key.
 }
 ----
 
-== On Non-NixOS systems
+== For Non-NixOS Systems
 
 Add the following configuration to /etc/nix/nix.conf:
 
diff --git a/Documentation/getting-spectrum.adoc b/Documentation/installation/getting-spectrum.adoc
similarity index 85%
rename from Documentation/getting-spectrum.adoc
rename to Documentation/installation/getting-spectrum.adoc
index b3fa1ef..a0ea1c4 100644
--- a/Documentation/getting-spectrum.adoc
+++ b/Documentation/installation/getting-spectrum.adoc
@@ -1,10 +1,11 @@
 = Getting Spectrum
-:page-parent: Tutorials
+:page-parent: Build and Run
+:page-nav_order: 2
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
 
-To get Spectrum, you need to build it from source.  As long as you're
+To get Spectrum OS, you need to build it from source.  As long as you're
 running Linuxfootnote:[Building from other operating systems might
 work, but hasn't been tested.  Patches are welcome to support building
 from other operating systems, as long as they're not too invasive.]
@@ -17,7 +18,7 @@ lot of time waiting for builds.
 
 == Trying Spectrum
 
-If you want to try Spectrum out to get a feel for it, without
+If you want to try Spectrum OS out to get a feel for it, without
 installing it, you can run it in a development VM with some example
 applications.
 
@@ -34,7 +35,7 @@ nix-shell -I nixpkgs=../../../nixpkgs-spectrum --run 'make run'
 This builds just enough of Spectrum to try it out in a VM, but it will
 still take a very long time.
 
-== Building an installer
+== Building Installer
 
 [source,shell]
 ----
@@ -48,7 +49,7 @@ named "result" will appear, pointing to a Spectrum USB installer
 image.
 
 CAUTION: Spectrum is not yet suitable for real-world use.  Do not use
-your Spectrum system for anything important or sensitive.  Spectrum is
+your Spectrum OS for anything important or sensitive.  Spectrum is
 currently missing many important security properties, and there is no
 procedure for updating to new versions of Spectrum -- you have to
 reinstall.
diff --git a/Documentation/installation/index.adoc b/Documentation/installation/index.adoc
new file mode 100644
index 0000000..99e9723
--- /dev/null
+++ b/Documentation/installation/index.adoc
@@ -0,0 +1,18 @@
+= Build and Run
+:description: How to download and install Spectrum OS.
+:page-nav_order: 2
+:page-has_children: true
+
+// SPDX-FileCopyrightText: 2022 Jenni Nikko <evgeniia.nikolaenko@unikie.com>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+To try Spectrum OS out or xref:../development/testing-patches.adoc[test patches], you need to build the system from the source.
+
+In order to speed up the build process, set up the binary cache. After building Spectrum OS, you can install and configure the b4 utility to be able to work with patches.
+
+
+TIP: Note that Spectrum OS currently works only on x86-64. AAarch64 support is in development.
+
+Currently, there is no implementation for a software update.
+
+You can replace the installation with some other OS.
diff --git a/Documentation/reference.adoc b/Documentation/reference.adoc
index 44b359d..55259ea 100644
--- a/Documentation/reference.adoc
+++ b/Documentation/reference.adoc
@@ -1,6 +1,5 @@
 = Reference
-:page-has_children: true
-:page-nav_order: 3
+:page-nav_exclude: true
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/tutorials.adoc b/Documentation/tutorials.adoc
index cd1fb12..fcef31b 100644
--- a/Documentation/tutorials.adoc
+++ b/Documentation/tutorials.adoc
@@ -1,6 +1,5 @@
 = Tutorials
-:page-nav_order: 1
-:page-has_children: true
+:page-nav_exclude: true
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
-- 
2.34.1




^ permalink raw reply	[flat|nested] 12+ messages in thread
end of thread, other threads:[~2022-11-08 15:05 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <RE: [PATCH] Docs: new structure>
2022-10-28 11:05 ` [PATCH] Docs: new structure Jenni Nikolaenko
2022-10-28 11:24   ` Jenni Nikolaenko
2022-11-01 12:14     ` Alyssa Ross
2022-11-01 12:13   ` Alyssa Ross
2022-11-04 13:57     ` Jenni Nikolaenko
2022-11-08  9:03       ` Alyssa Ross
2022-11-08 15:05         ` Jenni Nikolaenko
2022-09-06 13:55 Jenni Nikolaenko
2022-09-19  9:30 ` Alyssa Ross
2022-09-28 12:52   ` Jenni N
2022-09-29  8:58     ` Alyssa Ross
2022-10-28 11:22   ` Jenni Nikolaenko

Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).