From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on atuin.qyliss.net X-Spam-Level: X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.6 Received: from atuin.qyliss.net (localhost [IPv6:::1]) by atuin.qyliss.net (Postfix) with ESMTP id B3CEE29DF1; Mon, 21 Nov 2022 13:19:07 +0000 (UTC) Received: by atuin.qyliss.net (Postfix, from userid 496) id 9869929DB2; Mon, 21 Nov 2022 13:19:03 +0000 (UTC) Received: from mail-lf1-x134.google.com (mail-lf1-x134.google.com [IPv6:2a00:1450:4864:20::134]) by atuin.qyliss.net (Postfix) with ESMTPS id 32C8C29DA5 for ; Mon, 21 Nov 2022 13:19:00 +0000 (UTC) Received: by mail-lf1-x134.google.com with SMTP id bp15so18750929lfb.13 for ; Mon, 21 Nov 2022 05:19:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=unikie.com; s=google; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=+3UGZZ2tBr01I6vQVvkGBd9w0Hjov6tjaR3c12/WVks=; b=S/pL5+iRIKgDKQtA4e4XE1Nq9RN7S06Np0dV4lZyPyQxMhyI7z0M65wi6AQVq/VDTb AvVnLBdKaHwJWiY36ekysFFRo/Yn85VcZ5QSNkAs9RXuRLJVR1qaXNQGf1M1+ehoQn7X qOCnmg+5xx/36tVwvejT5jTMTDNjD8gLRqqdDpgDoffqkzemd2eCpgzERokav2SYfo/r Lo1P+7xyDlXWLkb5DRigG0NtAcUP6v7qgjqopozSTb96wq1YD6Md9Yzh1iABErMlDi1j X/+aq/aGMu4O01mWved3rNM7H+j8vxAxLscXTvuPDRzyZvSb+F+wZN5TolBgqhB4Q6po 93Ig== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=+3UGZZ2tBr01I6vQVvkGBd9w0Hjov6tjaR3c12/WVks=; b=yPFafu6IXbyAT4ctV+BFB3PTOS5Frr9IGVxwrw133fbiRzY25GBpk8+RfbAzDUbGn5 ZjEs2uLRuc4fQ+Mmu5dqsIFqDZwPUR9MDX8+aE07wfrJk5iqgfj+f8mRkscyn14RsdHN ZPZiwW/n05PWqt44LuTi8N0KDysJxWH/XYhIXmBKqE7oq5m7mDdLROV4u71Aq0bEkIZU joH3Mu/DuIJzPlP8olmbWNDtQowmkMNE5hTlLqmrRMlOrHff8FE32Aj8tQcwc57B9R0H jdVE4dPIU7lqEBei6SkuBifiZ8o1tsP/hiZSo/xzx6ozqNnw+BEnC54VEDoInXJjXYci Oa2Q== X-Gm-Message-State: ANoB5pn+d/w+SrMQVSikG0cAgqqqq2W16LuAF09xVfnaGJ9a5xYjB5R0 nA63lU/Y1uRXTfAvNQW7Uv2SiAn2d+CnZA== X-Google-Smtp-Source: AA0mqf6iUxLwj0q67ab37MxjSV/t8AKAffiYUBdBTBo77qg/cAD5v8y6K4YkDQimNOki/+WhHAEDTg== X-Received: by 2002:ac2:5ec8:0:b0:4ac:52cf:559b with SMTP id d8-20020ac25ec8000000b004ac52cf559bmr2194123lfq.476.1669036733964; Mon, 21 Nov 2022 05:18:53 -0800 (PST) Received: from evgeniia-ThinkPad-T490.. (87-95-168-155.bb.dnainternet.fi. [87.95.168.155]) by smtp.gmail.com with ESMTPSA id q3-20020ac246e3000000b004b19f766b07sm2048351lfo.91.2022.11.21.05.18.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 21 Nov 2022 05:18:53 -0800 (PST) From: Jenni Nikolaenko To: devel@spectrum-os.org Subject: [PATCH] Documentation: move Appendices to Development, fixed links Date: Mon, 21 Nov 2022 15:18:18 +0200 Message-Id: <20221121131817.15162-1-evgeniia.nikolaenko@unikie.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Message-ID-Hash: ZD33UKEXYONP52SXWPURT2KCCS26JS3H X-Message-ID-Hash: ZD33UKEXYONP52SXWPURT2KCCS26JS3H X-MailFrom: evgeniia.nikolaenko@unikie.com X-Mailman-Rule-Hits: header-match-devel.spectrum-os.org-0 X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1 CC: Jenni Nikolaenko X-Mailman-Version: 3.3.5 Precedence: list List-Id: Patches and low-level development discussion Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: 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 --- 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 // 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 // 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