* [PATCH v4] Docs: new structure
@ 2022-11-08 14:52 Jenni Nikolaenko
2022-11-08 14:57 ` Jenni Nikolaenko
2022-11-08 18:33 ` Alyssa Ross
0 siblings, 2 replies; 3+ messages in thread
From: Jenni Nikolaenko @ 2022-11-08 14:52 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 | 51 +++++++++---------
Documentation/about/index.adoc | 32 ++++++++++++
Documentation/appendices/index.adoc | 13 +++++
Documentation/appendices/user-partition.adoc | 17 ++++++
.../{ => appendices}/uuid-reference.adoc | 8 +--
Documentation/building-documentation.adoc | 52 -------------------
.../decisions/001-host-update-mechanism.adoc | 4 +-
.../decisions/002-install-options.adoc | 4 +-
Documentation/decisions/003-partitioning.adoc | 2 +-
.../004-data-at-rest-encryption.adoc | 4 +-
.../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 +-
Documentation/{ => development}/b4.adoc | 6 ++-
.../build-configuration.adoc | 13 +++--
.../development/building-documentation.adoc | 52 +++++++++++++++++++
.../{ => development}/debugging.adoc | 12 ++---
.../{ => development}/first-patch.adoc | 32 ++++++------
Documentation/development/index.adoc | 27 ++++++++++
Documentation/{ => development}/replying.adoc | 13 ++---
.../{ => development}/reviewing-patches.adoc | 4 +-
.../{ => development}/testing-patches.adoc | 28 +++++-----
.../development/working-with-patches.adoc | 12 +++++
Documentation/explanation.adoc | 6 ---
.../{ => getting-started}/creating-vms.adoc | 3 +-
Documentation/getting-started/index.adoc | 13 +++++
.../{ => getting-started}/running-vms.adoc | 3 +-
Documentation/how-to.adoc | 6 ---
Documentation/index.adoc | 29 +++++++++--
.../{ => installation}/binary-cache.adoc | 22 +++++---
.../{ => installation}/getting-spectrum.adoc | 16 +++---
Documentation/installation/index.adoc | 23 ++++++++
Documentation/reference.adoc | 6 ---
Documentation/tutorials.adoc | 6 ---
Documentation/user-partition.adoc | 12 -----
37 files changed, 341 insertions(+), 200 deletions(-)
rename Documentation/{ => about}/architecture.adoc (56%)
create mode 100644 Documentation/about/index.adoc
create mode 100644 Documentation/appendices/index.adoc
create mode 100644 Documentation/appendices/user-partition.adoc
rename Documentation/{ => appendices}/uuid-reference.adoc (96%)
delete mode 100644 Documentation/building-documentation.adoc
rename Documentation/{ => development}/b4.adoc (91%)
rename Documentation/{ => development}/build-configuration.adoc (73%)
create mode 100644 Documentation/development/building-documentation.adoc
rename Documentation/{ => development}/debugging.adoc (79%)
rename Documentation/{ => development}/first-patch.adoc (80%)
create mode 100644 Documentation/development/index.adoc
rename Documentation/{ => development}/replying.adoc (68%)
rename Documentation/{ => development}/reviewing-patches.adoc (88%)
rename Documentation/{ => development}/testing-patches.adoc (82%)
create mode 100644 Documentation/development/working-with-patches.adoc
delete mode 100644 Documentation/explanation.adoc
rename Documentation/{ => getting-started}/creating-vms.adoc (98%)
create mode 100644 Documentation/getting-started/index.adoc
rename Documentation/{ => getting-started}/running-vms.adoc (90%)
delete mode 100644 Documentation/how-to.adoc
rename Documentation/{ => installation}/binary-cache.adoc (74%)
rename Documentation/{ => installation}/getting-spectrum.adoc (79%)
create mode 100644 Documentation/installation/index.adoc
delete mode 100644 Documentation/reference.adoc
delete mode 100644 Documentation/tutorials.adoc
delete mode 100644 Documentation/user-partition.adoc
diff --git a/Documentation/architecture.adoc b/Documentation/about/architecture.adoc
similarity index 56%
rename from Documentation/architecture.adoc
rename to Documentation/about/architecture.adoc
index 1c4307b..b311e77 100644
--- a/Documentation/architecture.adoc
+++ b/Documentation/about/architecture.adoc
@@ -1,32 +1,31 @@
= Architecture
-:page-parent: Explanation
+:page-parent: About Spectrum
// SPDX-FileCopyrightText: 2022 Unikie
// 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 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
browser); and a system VM, _netvm_ (which handles hardware network
-devices and provides network services to application VMs). Refer to
-xref:creating-vms.adoc[Creating VMs] and xref:running-vms.adoc[Running
+devices and provides network services to application VMs).
+Refer to xref:../getting-started/creating-vms.adoc[Creating VMs] and
+xref:../getting-started/running-vms.adoc[Running
VMs] for more information about using VMs in Spectrum.
== Architecture Decision Records (ADRs)
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].
+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,8 +34,8 @@ 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
-works on x86_64, but aarch64 support is in development.
+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
management. Utilities like kmod, util-linux and busybox are installed for boot
@@ -44,20 +43,22 @@ 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
-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,
-using Wayland virtio-gpu contexts. X11 applications are not currently
-supported, but could be in future.
+https://wayland.freedesktop.org/architecture.html[here].
+The host provides onlya 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, using Wayland virtio-gpu
+contexts. X11 applications are not currently supported, but could be in future.
All host user space components are built with the https://musl.libc.org/[musl C
-library]. In comparison to other libc implementations, musl has
+library].
+In comparison to other libc implementations, musl has
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.
+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:
@@ -66,5 +67,5 @@ https://github.com/utdemir/nix-tree[nix-tree] in the Spectrum repository:
[listing]
nix-build img/live -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz --no-out-link | xargs -o nix-tree
-https://diode.zone/w/8DBDQ6HQUe5UUdLkpDuL35[See video of Spectrum live image
-interactive analysis with nix-tree]
+See the https://diode.zone/w/8DBDQ6HQUe5UUdLkpDuL35[video] of Spectrum live
+image interactive analysis with nix-tree.
diff --git a/Documentation/about/index.adoc b/Documentation/about/index.adoc
new file mode 100644
index 0000000..6961b6a
--- /dev/null
+++ b/Documentation/about/index.adoc
@@ -0,0 +1,32 @@
+= About Spectrum
+: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 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+Spectrum is a Linux-based system that uses the
+https://github.com/NixOS/nix[Nix package manager] and
+the https://github.com/NixOS/nixpkgs[Nix Packages collection] (Nixpkgs).
+
+This gives an actively-developed base with good
+hardware support, powerful and optimised compartmentalization primitives in
+https://www.linux-kvm.org/page/Main_Page[KVM], and the reproducible packaging
+and configuration system that is important
+for a maintainable compartmentalized system.
+
+== Why Spectrum
+
+* 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/appendices/index.adoc b/Documentation/appendices/index.adoc
new file mode 100644
index 0000000..ebacda7
--- /dev/null
+++ b/Documentation/appendices/index.adoc
@@ -0,0 +1,13 @@
+= Appendices
+:description: Additional information.
+:page-nav_order: 5
+:page-has_children: true
+:page-has_toc: false
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+This section provides additional information on how to work with:
+
+* xref:../appendices/user-partition.adoc[user partition]
+* xref:../appendices/uuid-reference.adoc[universally unique identifier (UUID)].
diff --git a/Documentation/appendices/user-partition.adoc b/Documentation/appendices/user-partition.adoc
new file mode 100644
index 0000000..4121340
--- /dev/null
+++ b/Documentation/appendices/user-partition.adoc
@@ -0,0 +1,17 @@
+= Appendix A. User Partition
+:page-parent: Appendices
+: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
+
+The Spectrum host system is immutable, so configuration and user data
+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, which works in a similar way to the standard Linux `root`
+parameter.
diff --git a/Documentation/uuid-reference.adoc b/Documentation/appendices/uuid-reference.adoc
similarity index 96%
rename from Documentation/uuid-reference.adoc
rename to Documentation/appendices/uuid-reference.adoc
index 4b0b481..146c068 100644
--- a/Documentation/uuid-reference.adoc
+++ b/Documentation/appendices/uuid-reference.adoc
@@ -1,7 +1,7 @@
-= UUID Reference
-:page-parent: Reference
-:toc: preamble
+= Appendix B. UUID
+:page-parent: Appendices
:toclevels: 1
+: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
@@ -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/building-documentation.adoc b/Documentation/building-documentation.adoc
deleted file mode 100644
index b491105..0000000
--- a/Documentation/building-documentation.adoc
+++ /dev/null
@@ -1,52 +0,0 @@
-= Building the Documentation
-:page-parent: Tutorials
-
-// SPDX-FileCopyrightText: 2022 Unikie
-// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
-
-This tutorial assumes that you have https://nixos.org/[Nix] installed.
-You may also want to xref:binary-cache.adoc[configure the Spectrum
-binary cache], to avoid having to wait for dependencies to compile on
-your local system.
-
-1. Get a copy of the Spectrum source code:
-+
-[source,shell]
-----
-git clone https://spectrum-os.org/git/spectrum
-----
-2. Enter the documentation directory:
-+
-[source,shell]
-----
-cd spectrum/Documentation
-----
-3. Enter the development environment:
-+
-[source,shell]
-----
-nix-shell -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz
-----
-4. In the development shell, do an initial build of the documentation
-site:
-+
-[source,shell]
-----
-scripts/build.sh
-----
-5. Run a development server for previewing changes locally:
-+
-[source,shell]
-----
-jekyll serve
-----
-+
-This will serve a local copy of the documentation at http://localhost:4000/.
-+
-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.
diff --git a/Documentation/decisions/001-host-update-mechanism.adoc b/Documentation/decisions/001-host-update-mechanism.adoc
index 574deb4..39f9f28 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
// SPDX-FileCopyrightText: 2022 Unikie
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
@@ -11,7 +11,7 @@ Proposed
== Context
-Spectrum currently has no implementation for software update. The host --
+Spectrum currently has no implementation for software update. The host --
consisting of the Linux kernel, KVM, cloud-hypervisor and minimal user space
tools -- will require software updates to support feature development and
security fixes.
diff --git a/Documentation/decisions/002-install-options.adoc b/Documentation/decisions/002-install-options.adoc
index 4412b53..4a745eb 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
// 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..a13b8cc 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
// 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..5b0f518 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
// SPDX-FileCopyrightText: 2022 Unikie
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
@@ -20,5 +20,5 @@ User data is encrypted.
== Consequences
Spectrum needs to come with enough software to get the encryption key
-via different methods (password, usb, fido, etc.) Can we use dm-crypt
+via different methods (password, usb, fido, etc.). Can we use dm-crypt
for everything instead of LUKS?
diff --git a/Documentation/decisions/005-virtual-machine-monitor.adoc b/Documentation/decisions/005-virtual-machine-monitor.adoc
index db81c72..df1b501 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
// 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..b92d863 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
// 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..d832691 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
// 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..c1e5b87 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
// 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..a022239 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
// SPDX-FileCopyrightText: 2022 Unikie
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
diff --git a/Documentation/b4.adoc b/Documentation/development/b4.adoc
similarity index 91%
rename from Documentation/b4.adoc
rename to Documentation/development/b4.adoc
index 489ced4..5f141e9 100644
--- a/Documentation/b4.adoc
+++ b/Documentation/development/b4.adoc
@@ -1,5 +1,7 @@
= Installing and Configuring b4
-:page-parent: Tutorials
+:page-parent: Working with Patches
+:page-grand_parent: Development
+:page-nav_order: 1
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
// SPDX-FileCopyrightText: 2022 Unikie
@@ -19,7 +21,7 @@ of the Spectrum root's nix-shell.
You should be able to install b4 from your package manager.
-Using Nix, you can start a shell with b4 available by running
+Using Nix, you can start a shell with b4 available by running:
[listing]
[source,shell]
diff --git a/Documentation/build-configuration.adoc b/Documentation/development/build-configuration.adoc
similarity index 73%
rename from Documentation/build-configuration.adoc
rename to Documentation/development/build-configuration.adoc
index b89575f..c9a8c99 100644
--- a/Documentation/build-configuration.adoc
+++ b/Documentation/development/build-configuration.adoc
@@ -1,19 +1,22 @@
= Configuring the Build
-:page-parent: How-to Guides
+:page-parent: Development
+:page-nav_order: 1
:example-caption: Test
// SPDX-FileCopyrightText: 2022 Unikie
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
Some aspects of a Spectrum build can be customised using a build
-configuration file. By default, this configuration file should be
-called config.nix and located in the root of the Spectrum source tree,
-but this can be overridden by setting `spectrum-config` in the
+configuration file.
+
+By default, this configuration file should be called config.nix and located in
+the root of the Spectrum source tree, but this can be overridden by setting
+`spectrum-config` in the
https://nixos.org/manual/nix/stable/command-ref/env-common.html#env-NIX_PATH[NIX_PATH]
to the path of the configuration file.
The configuration file should contain an attribute set. The only
-currently allowed attribute name is `pkgs`, which allows using a
+currently allowed attribute name is `pkgs`. It allows using a
custom Nixpkgs to evaluate Spectrum.
.config.nix to build Spectrum with a https://nixos.org/manual/nixpkgs/unstable/#sec-overlays-definition[Nixpkgs overlay]
diff --git a/Documentation/development/building-documentation.adoc b/Documentation/development/building-documentation.adoc
new file mode 100644
index 0000000..4f464f5
--- /dev/null
+++ b/Documentation/development/building-documentation.adoc
@@ -0,0 +1,52 @@
+= Building Documentation
+:page-parent: Development
+:page-nav_order: 5
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+Make sure you have https://nixos.org/download.html[Nix] installed.
+You may also want to xref:../installation/binary-cache.adoc[configure the Spectrum
+binary cache], to avoid having to wait for dependencies to compile on
+your local system.
+
+. Get a copy of the Spectrum source code:
++
+[source,shell]
+----
+git clone https://spectrum-os.org/git/spectrum
+----
+. Enter the documentation directory:
++
+[source,shell]
+----
+cd spectrum/Documentation
+----
+. Enter the development environment:
++
+[source,shell]
+----
+nix-shell -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz
+----
+. In the development shell, do an initial build of the documentation
+site:
++
+[source,shell]
+----
+scripts/build.sh
+----
+. Run a development server for previewing changes locally:
++
+[source,shell]
+----
+jekyll serve
+----
++
+This will serve a local copy of the documentation at http://localhost:4000/.
++
+IMPORTANT: Jekyll does not handle rendering of the draw.io diagrams. If you
+modify any of those, or add new ones, run `scripts/build.sh` again to do a full
+rebuild of the site.
+
+After making changes to the documentation, see how to
+xref:first-patch.adoc[send your patch] and submit the changes for review.
diff --git a/Documentation/debugging.adoc b/Documentation/development/debugging.adoc
similarity index 79%
rename from Documentation/debugging.adoc
rename to Documentation/development/debugging.adoc
index 3871a7c..f1bbf01 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: 4
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
@@ -9,8 +8,9 @@
== Extracting core dumps when running Spectrum in a VM
When using a VM to run the Spectrum host system, a special mechanism
-is available to enable easy introspection of core files. When a
-program on the Spectrum host system dumps core, the system will
+is available to enable easy introspection of core files.
+
+When a program on the Spectrum host system dumps core, the system will
attempt to upload the core file to _its_ host (i.e. the system running
Spectrum in a VM) using the vsock(7) protocol, on port 1129271877.
diff --git a/Documentation/first-patch.adoc b/Documentation/development/first-patch.adoc
similarity index 80%
rename from Documentation/first-patch.adoc
rename to Documentation/development/first-patch.adoc
index 30672b9..aa6ebee 100644
--- a/Documentation/first-patch.adoc
+++ b/Documentation/development/first-patch.adoc
@@ -1,11 +1,11 @@
-= Sending Your First Patch
-:page-parent: Tutorials
+= Sending Your Patch
+:page-parent: Working with Patches
+:page-grand_parent: Development
+:page-nav_order: 1
// 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,19 +14,18 @@ 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.
+The process of making changes is similar to working on any git repository.
-1. Create a branch for your changes:
+. Create a branch for your changes:
+
[source,shell]
----
git checkout -b fix-docs # for example
----
-2. Make changes in your editor.
-3. Stage and commit your changes:
+. Make changes in your editor.
+. Stage and commit your changes:
+
[source,shell]
----
@@ -39,7 +38,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 +63,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 +81,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..1fccdd5
--- /dev/null
+++ b/Documentation/development/index.adoc
@@ -0,0 +1,27 @@
+= Development
+:description: Development progress, general development practices
+:page-nav_order: 4
+:page-has_children: true
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// 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
+
+* https://git.kernel.org/pub/scm/utils/b4/b4.git/about/[b4]
+* https://nixos.org/manual/nix/stable/introduction.html[Nix package manager]
+* https://docs.asciidoctor.org/[AsciiDoc] for writing the documentation
+
+
+== Mailing Lists
+
+The Spectrum project runs several
+https://spectrum-os.org/participating.html#mailing-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.
+
+For real-time feedback, use
+https://spectrum-os.org/participating.html#irc[IRC/Matrix channel].
diff --git a/Documentation/replying.adoc b/Documentation/development/replying.adoc
similarity index 68%
rename from Documentation/replying.adoc
rename to Documentation/development/replying.adoc
index bb8e31a..a1ad394 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: Working with Patches
+: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
@@ -9,14 +11,13 @@ https://spectrum-os.org/participating.html#mailing-lists[mailing
lists].
Make sure to Reply All when replying to messages, so that the message
-is sent to the mailing list and not just to the person you're
-replying to.
+is sent to the mailing list and not just to the person you reply to.
== Getting a copy of a message
-You may want to reply to a mailing list message that you don't have a
-copy of in your mail client, because you aren't subscribed to the
-list, or because you subscribed after the message was sent.
+You may want to reply to a mailing list message that you do not have a
+copy of in your mail client, because you are not subscribed to the
+list or because you subscribed after the message was sent.
To do this, find the message you want to reply to in the
https://spectrum-os.org/lists/archives[public-inbox list archives],
diff --git a/Documentation/reviewing-patches.adoc b/Documentation/development/reviewing-patches.adoc
similarity index 88%
rename from Documentation/reviewing-patches.adoc
rename to Documentation/development/reviewing-patches.adoc
index 63ff24e..ba47f25 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: Working with Patches
+: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 82%
rename from Documentation/testing-patches.adoc
rename to Documentation/development/testing-patches.adoc
index 743cd6e..0c72c93 100644
--- a/Documentation/testing-patches.adoc
+++ b/Documentation/development/testing-patches.adoc
@@ -1,5 +1,7 @@
= Testing Patches
-:page-parent: How-to Guides
+:page-parent: Working with Patches
+:page-grand_parent: Development
+:page-nav_order: 2
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
// SPDX-FileCopyrightText: 2022 Unikie
@@ -9,7 +11,7 @@ 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
. Find the patch series you want to test on
https://spectrum-os.org/lists/archives/spectrum-devel/[public-inbox].
@@ -33,15 +35,15 @@ of the Spectrum root's nix-shell, which allows you to skip this step.
----
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]
+----
Writing ./20220424_hi_host_rootfs_fix_weston_hotplugging.mbx
-+
-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]
@@ -49,14 +51,12 @@ Run `git am` on that file to apply the patches, for example:
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
+When you tested a patch, it is 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:
----
Tested-by: John Smith <john@example.com>
----
@@ -66,10 +66,10 @@ patch replies will be automatically included in the commit message
when a patch is applied.
It's also helpful to explain in your reply how you tested the patch,
-but you don't have to if it's obvious. (For example, if a patch is
+but you don't have to if it's obvious. For example, if a patch is
supposed to fix a bug, and you verified that after applying the patch
the bug is fixed, just the Tested-by line on its own is enough to
-indicate that.)
+indicate that.
If you found an issue with the patch, do not include a Tested-by line,
and instead reply to the patch explaining what you tested, what you
diff --git a/Documentation/development/working-with-patches.adoc b/Documentation/development/working-with-patches.adoc
new file mode 100644
index 0000000..a2694ed
--- /dev/null
+++ b/Documentation/development/working-with-patches.adoc
@@ -0,0 +1,12 @@
+= Working with Patches
+:page-parent: Development
+:page-nav_order: 3
+:page-has_children: true
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+Patches are the way for contributors to submit code to the Spectrum project.
+
+Make sure to xref:../development/b4.adoc[install and configure the b4 utility]
+for applying and testing other people's patches.
diff --git a/Documentation/explanation.adoc b/Documentation/explanation.adoc
deleted file mode 100644
index b39cc6d..0000000
--- a/Documentation/explanation.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-= Explanation
-:page-has_children: true
-:page-nav_order: 4
-
-// 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..725316c 100644
--- a/Documentation/creating-vms.adoc
+++ b/Documentation/getting-started/creating-vms.adoc
@@ -1,5 +1,6 @@
= Creating VMs
-:page-parent: Reference
+:page-parent: Getting Started
+: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
diff --git a/Documentation/getting-started/index.adoc b/Documentation/getting-started/index.adoc
new file mode 100644
index 0000000..10dde7f
--- /dev/null
+++ b/Documentation/getting-started/index.adoc
@@ -0,0 +1,13 @@
+= Getting Started
+:description: Exploring Spectrum OS. Using (=How-To-Guides), Configuring (adding smth).
+:page-nav_order: 3
+:page-has_children: true
+:page-has_toc: false
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+Ready to get started with Spectrum? Here is what you can do next:
+
+* xref:../getting-started/creating-vms.adoc[Create your own VM] to use others applications.
+* xref:../getting-started/running-vms.adoc[Start some applications].
diff --git a/Documentation/running-vms.adoc b/Documentation/getting-started/running-vms.adoc
similarity index 90%
rename from Documentation/running-vms.adoc
rename to Documentation/getting-started/running-vms.adoc
index d0d3f99..ca70835 100644
--- a/Documentation/running-vms.adoc
+++ b/Documentation/getting-started/running-vms.adoc
@@ -1,5 +1,6 @@
= Running VMs
-:page-parent: Reference
+:page-parent: Getting Started
+: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/how-to.adoc b/Documentation/how-to.adoc
deleted file mode 100644
index f43fa13..0000000
--- a/Documentation/how-to.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-= How-to Guides
-:page-has_children: true
-: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/index.adoc b/Documentation/index.adoc
index 3079847..e0a45c7 100644
--- a/Documentation/index.adoc
+++ b/Documentation/index.adoc
@@ -1,13 +1,32 @@
-= Spectrum Docs
+= Spectrum Documentation
:page-nav_exclude: true
// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+// SPDX-FileCopyrightText: 2022 Unikie
// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
-Spectrum is a compartmentalized operating system.
-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 easy to use and maintain.
+
+== Using Spectrum
To learn about what Spectrum is and how it's implemented, start with
-the xref:architecture.adoc[architecture overview].
+the xref:about/architecture.adoc[architecture overview].
+
+If you want to try Spectrum, see xref:../installation/index.adoc[Build and Run]
+ to setup a development environment.
+
+
+== Developing and Contributing
+
+Spectrum is made of free and open-source software. It is free for anyone to
+ use, modify, and distribute.
+
+Once you are up and running, see
+ xref:../development/index.adoc[Development] to understand how to work with
+ Spectrum's code and participate in the collaborative development process.
+
+If you are thinking of contributing to Spectrum docs, see
+ xref:../development/building-documentation.adoc[Building Documentation].
diff --git a/Documentation/binary-cache.adoc b/Documentation/installation/binary-cache.adoc
similarity index 74%
rename from Documentation/binary-cache.adoc
rename to Documentation/installation/binary-cache.adoc
index 6e69b39..ab53666 100644
--- a/Documentation/binary-cache.adoc
+++ b/Documentation/installation/binary-cache.adoc
@@ -1,5 +1,6 @@
-= 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
@@ -20,10 +21,9 @@ 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.
+Add the following configuration to /etc/nixos/configuration.nix:
[source,nix]
----
@@ -38,7 +38,13 @@ substituter, and tells Nix to trust builds signed with its public key.
}
----
-== On Non-NixOS systems
+This configuration adds the Spectrum binary cache as a substituter and makes
+Nix trust builds signed with its public key.
+
+To apply changes, rebuild your system with the https://nixos.wiki/wiki/Nixos-rebuild[nixos-rebuild] command.
+
+
+== For Non-NixOS Systems
Add the following configuration to /etc/nix/nix.conf:
@@ -48,6 +54,10 @@ substituters = https://cache.dataaturservice.se/spectrum/ https://cache.nixos.or
trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= spectrum-os.org-1:rnnSumz3+Dbs5uewPlwZSTP0k3g/5SRG4hD7Wbr9YuQ=
----
+Run `systemctl restart nix-daemon.service` after making any changes in the Nix
+configuration. After that the binary cache will be used automatically when
+`nix-build` is run.
+
If you have other binary caches configured besides cache.nixos.org,
make sure to add the Spectrum cache URL and public key to the existing
configuration lines in your nix.conf file.
diff --git a/Documentation/getting-spectrum.adoc b/Documentation/installation/getting-spectrum.adoc
similarity index 79%
rename from Documentation/getting-spectrum.adoc
rename to Documentation/installation/getting-spectrum.adoc
index b422a94..392cab5 100644
--- a/Documentation/getting-spectrum.adoc
+++ b/Documentation/installation/getting-spectrum.adoc
@@ -1,5 +1,6 @@
= 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
@@ -8,7 +9,7 @@ To get Spectrum, 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.]
-and have https://nixos.org/[Nix] and https://git-scm.com/[git]
+and have https://nixos.org/download.html[Nix] and https://git-scm.com/[git]
installed, it's very easy to do.
TIP: Before you start, consider setting up the
@@ -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]
----
@@ -47,8 +48,7 @@ If you haven't set up the xref:binary-cache.adoc[binary cache], this
will take a very long time. When it's done, a symbolic link 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
-currently missing many important security properties, and there is no
-procedure for updating to new versions of Spectrum -- you have to
-reinstall.
+CAUTION: Do not use Spectrum for anything important or sensitive as it is not
+yet suitable for real-world use. Many important security properties are
+currently missing, and there is no procedure for updating to
+new versions—you have to reinstall the OS.
diff --git a/Documentation/installation/index.adoc b/Documentation/installation/index.adoc
new file mode 100644
index 0000000..d67c88d
--- /dev/null
+++ b/Documentation/installation/index.adoc
@@ -0,0 +1,23 @@
+= Build and Run
+:description: How to download and install Spectrum OS.
+:page-nav_order: 2
+:page-has_children: true
+:page-has_toc: false
+
+// SPDX-FileCopyrightText: 2022 Unikie
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+
+To start working with Spectrum, you need:
+
+* xref:../installation/binary-cache.adoc[Set up the binary cache] to speed up the build process.
+* xref:../installation/getting-spectrum.adoc[Build Spectrum] from the source.
+
+TIP: At this stage, Spectrum works only on x86-64. AArch64 support is in
+development.
+
+== Uninstalling and Updating
+
+Currently, there is no implementation for a software update.
+
+You can replace Spectrum by installing another OS.
diff --git a/Documentation/reference.adoc b/Documentation/reference.adoc
deleted file mode 100644
index 44b359d..0000000
--- a/Documentation/reference.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-= Reference
-:page-has_children: true
-: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/tutorials.adoc b/Documentation/tutorials.adoc
deleted file mode 100644
index cd1fb12..0000000
--- a/Documentation/tutorials.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-= Tutorials
-:page-nav_order: 1
-:page-has_children: 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/user-partition.adoc b/Documentation/user-partition.adoc
deleted file mode 100644
index 73bc0d0..0000000
--- a/Documentation/user-partition.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-= The User Partition
-:page-parent: Explanation
-
-// 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
-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,
-which works in a similar way to the standard Linux `root` parameter.
--
2.34.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v4] Docs: new structure
2022-11-08 14:52 [PATCH v4] Docs: new structure Jenni Nikolaenko
@ 2022-11-08 14:57 ` Jenni Nikolaenko
2022-11-08 18:33 ` Alyssa Ross
1 sibling, 0 replies; 3+ messages in thread
From: Jenni Nikolaenko @ 2022-11-08 14:57 UTC (permalink / raw)
To: devel
My answers are here: https://spectrum-os.org/lists/hyperkitty/list/devel@spectrum-os.org/thread/BNHKCQPOLCLZO4N27BW6RBYAW5HCTKBV/
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v4] Docs: new structure
2022-11-08 14:52 [PATCH v4] Docs: new structure Jenni Nikolaenko
2022-11-08 14:57 ` Jenni Nikolaenko
@ 2022-11-08 18:33 ` Alyssa Ross
1 sibling, 0 replies; 3+ messages in thread
From: Alyssa Ross @ 2022-11-08 18:33 UTC (permalink / raw)
To: Jenni Nikolaenko; +Cc: devel
[-- Attachment #1: Type: text/plain, Size: 953 bytes --]
On Tue, Nov 08, 2022 at 04:52:28PM +0200, Jenni Nikolaenko wrote:
> 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>
> ---
Applied, thank you so much for your effort and persistence!
Something I'm thinking about now as follow-up:
Both of the topics in the new Appendices section are development
topics, so I think it would make sense for them to be in the
Development section. But I'm not sure whether they should go
directly under development, or whether it would be better to have
some sort of subcategory or subcategories so keep the most useful
information the most visible, so it doesn't get lost among niche
information like the UUID reference. But maybe using the nav_order
to keep the most useful stuff at the top would be fine? I'd be
very interested in your thoughts.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-11-08 18:33 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-08 14:52 [PATCH v4] Docs: new structure Jenni Nikolaenko
2022-11-08 14:57 ` Jenni Nikolaenko
2022-11-08 18:33 ` Alyssa Ross
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).