From: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
To: devel@spectrum-os.org
Cc: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
Subject: [PATCH] Documentation: move Appendices to Development, fixed links
Date: Mon, 21 Nov 2022 15:18:18 +0200 [thread overview]
Message-ID: <20221121131817.15162-1-evgeniia.nikolaenko@unikie.com> (raw)
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>
---
Documentation/about/architecture.adoc | 6 +++---
Documentation/appendices/index.adoc | 13 -------------
.../{appendices => development}/user-partition.adoc | 6 +++---
.../{appendices => development}/uuid-reference.adoc | 11 +++++------
Documentation/index.adoc | 8 ++++----
Documentation/using-spectrum/creating-vms.adoc | 2 +-
6 files changed, 16 insertions(+), 30 deletions(-)
delete mode 100644 Documentation/appendices/index.adoc
rename Documentation/{appendices => development}/user-partition.adoc (87%)
rename Documentation/{appendices => development}/uuid-reference.adoc (85%)
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
similarity index 87%
rename from Documentation/appendices/user-partition.adoc
rename to 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
similarity index 85%
rename from Documentation/appendices/uuid-reference.adoc
rename to 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/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:
--
2.34.1
next reply other threads:[~2022-11-21 13:19 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-21 13:18 Jenni Nikolaenko [this message]
2022-11-23 10:29 ` Alyssa Ross
2022-11-23 10:34 ` Alyssa Ross
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221121131817.15162-1-evgeniia.nikolaenko@unikie.com \
--to=evgeniia.nikolaenko@unikie.com \
--cc=devel@spectrum-os.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).