summary refs log tree commit diff
diff options
context:
space:
mode:
authorJenni Nikolaenko <evgeniia.nikolaenko@unikie.com>2022-11-21 15:18:18 +0200
committerAlyssa Ross <alyssa.ross@unikie.com>2022-11-22 15:11:21 +0000
commit8ae8ca1e02bf151d98382496c4af78822630bb42 (patch)
tree16a22dafb30dfc927d87eb46253c478089cf8aa2
parent6c0c95661b43075d8e66171d5ff4cd682aded8ca (diff)
downloadspectrum-8ae8ca1e02bf151d98382496c4af78822630bb42.tar
spectrum-8ae8ca1e02bf151d98382496c4af78822630bb42.tar.gz
spectrum-8ae8ca1e02bf151d98382496c4af78822630bb42.tar.bz2
spectrum-8ae8ca1e02bf151d98382496c4af78822630bb42.tar.lz
spectrum-8ae8ca1e02bf151d98382496c4af78822630bb42.tar.xz
spectrum-8ae8ca1e02bf151d98382496c4af78822630bb42.tar.zst
spectrum-8ae8ca1e02bf151d98382496c4af78822630bb42.zip
Documentation: move Appendices to Development, fixed links
Both sections "User Partition" and "UUID Reference" are more
development topics, so by Alyssa's advice they should go
directly under the Development chapter. The section Appendices
was removed.

In addition, I replaced broken links.

Signed-off-by: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
Message-Id: <20221121131817.15162-1-evgeniia.nikolaenko@unikie.com>
Reviewed-by: Alyssa Ross <alyssa.ross@unikie.com>
Tested-by: Alyssa Ross <alyssa.ross@unikie.com>
Signed-off-by: Alyssa Ross <alyssa.ross@unikie.com>
-rw-r--r--Documentation/about/architecture.adoc6
-rw-r--r--Documentation/appendices/index.adoc13
-rw-r--r--Documentation/development/user-partition.adoc (renamed from Documentation/appendices/user-partition.adoc)6
-rw-r--r--Documentation/development/uuid-reference.adoc (renamed from Documentation/appendices/uuid-reference.adoc)11
-rw-r--r--Documentation/index.adoc8
-rwxr-xr-xDocumentation/scripts/undocumented-uuids.sh2
-rw-r--r--Documentation/using-spectrum/creating-vms.adoc2
7 files changed, 17 insertions, 31 deletions
diff --git a/Documentation/about/architecture.adoc b/Documentation/about/architecture.adoc
index b311e77..38e0a22 100644
--- a/Documentation/about/architecture.adoc
+++ b/Documentation/about/architecture.adoc
@@ -15,8 +15,8 @@ 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:../getting-started/creating-vms.adoc[Creating VMs] and
-xref:../getting-started/running-vms.adoc[Running
+Refer to xref:../using-spectrum/creating-vms.adoc[Creating VMs] and
+xref:../using-spectrum/running-vms.adoc[Running
 VMs] for more information about using VMs in Spectrum.
 
 == Architecture Decision Records (ADRs)
@@ -28,7 +28,7 @@ https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions[ADRs].
 == Spectrum Host System
 
 Compartmentalization is implemented using
-https://cloud-hypervisor.org/[cloud-hypervisor] virtual machines.
+https://cloudhypervisor.org/[cloud-hypervisor] virtual machines.
 cloud-hypervisor uses Linux's
 https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine[Kernel-based Virtual
 Machine] (KVM) to provide lightweight, hardware-accelerated VMs.
diff --git a/Documentation/appendices/index.adoc b/Documentation/appendices/index.adoc
deleted file mode 100644
index ebacda7..0000000
--- a/Documentation/appendices/index.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
-= 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/development/user-partition.adoc
index 4121340..d8fd956 100644
--- a/Documentation/appendices/user-partition.adoc
+++ b/Documentation/development/user-partition.adoc
@@ -1,6 +1,6 @@
-= Appendix A. User Partition
-:page-parent: Appendices
-:page-nav_order: 1
+= User Partition
+:page-parent: Development
+:page-nav_order: 5
 
 // 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/appendices/uuid-reference.adoc b/Documentation/development/uuid-reference.adoc
index 5099ec3..81300ee 100644
--- a/Documentation/appendices/uuid-reference.adoc
+++ b/Documentation/development/uuid-reference.adoc
@@ -1,7 +1,6 @@
-= Appendix B. UUID Reference
-:page-parent: Appendices
-:toclevels: 1
-:page-nav_order: 2
+= UUID Reference
+:page-parent: Development
+:page-nav_order: 6
 
 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
 // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
@@ -25,13 +24,13 @@ Specification].
 === `4f68bce3-e8cd-4db1-96e7-fbcaf984b709`
 
 "Root Partition (amd64/x86_64)" from the
-https://systemd.io/DISCOVERABLE_PARTITIONS/[Discoverable Partitions
+https://uapi-group.org/specifications/specs/discoverable_partitions_specification/[Discoverable Partitions
 Specification].
 
 === `2c7357ed-ebd2-46d9-aec1-23d437ec2bf5`
 
 "Root Verity Partition (amd64/x86_64)" from the
-https://systemd.io/DISCOVERABLE_PARTITIONS/[Discoverable Partitions
+https://uapi-group.org/specifications/specs/discoverable_partitions_specification/[Discoverable Partitions
 Specification].
 
 === `9293e1ff-cee4-4658-88be-898ec863944f`
diff --git a/Documentation/index.adoc b/Documentation/index.adoc
index e0a45c7..51a6e7d 100644
--- a/Documentation/index.adoc
+++ b/Documentation/index.adoc
@@ -15,7 +15,7 @@ lower barrier to entry and is easy to use and maintain.
 To learn about what Spectrum 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]
+If you want to try Spectrum, see xref:installation/index.adoc[Build and Run]
  to setup a development environment.
 
 
@@ -25,8 +25,8 @@ 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
+ 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].
+If you are thinking of contributing to the Spectrum docs, see
+ xref:development/building-documentation.adoc[Building Documentation].
diff --git a/Documentation/scripts/undocumented-uuids.sh b/Documentation/scripts/undocumented-uuids.sh
index c75bfd2..aa192e6 100755
--- a/Documentation/scripts/undocumented-uuids.sh
+++ b/Documentation/scripts/undocumented-uuids.sh
@@ -6,7 +6,7 @@
 cd "$(dirname "$0")/../.."
 
 PATTERN='\b[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}\b'
-UUID_REFERENCE_PATH=Documentation/appendices/uuid-reference.adoc
+UUID_REFERENCE_PATH=Documentation/development/uuid-reference.adoc
 
 documented_uuids=$(mktemp)
 trap 'rm -f -- "$documented_uuids"' EXIT
diff --git a/Documentation/using-spectrum/creating-vms.adoc b/Documentation/using-spectrum/creating-vms.adoc
index 6847249..2c57562 100644
--- a/Documentation/using-spectrum/creating-vms.adoc
+++ b/Documentation/using-spectrum/creating-vms.adoc
@@ -8,7 +8,7 @@
 == Configuration
 
 Each VM is configured using a directory under svc/data/ on the
-xref:user-partition.adoc[user partition].  The name of the directory
+xref:../development/user-partition.adoc[user partition].  The name of the directory
 determines the name of the VM.
 
 The directory can contain the following files: