June 2026 - Spectrum Development

[PATCH 0/3] Documentation: render all pages in one style
by Valentin Gagarin 12 Jun '26

12 Jun '26

This is a textually large but mostly mechanical change: - Use the same stylesheet for all pages rendered with Jekyll - Render a sitemap - Render breadcrumbs on each page - Drop Just the Docs - Provide a minimal admonition style I adapted some of the page titles to read better within the sitemap and the breadcrumbs, by removing the "Spectrum " prefix. Valentin Gagarin (3): Documentation: align Jekyll page style to rest of website Documentation: drop Just the Docs Documentation: uniform navigation across all pages Documentation/Gemfile | 1 - Documentation/Gemfile.lock | 12 +--- Documentation/_config.yml | 7 --- Documentation/_includes/breadcrumb.html | 23 ++++++++ Documentation/_includes/footer_custom.html | 8 ++- Documentation/_includes/sitemap.html | 55 ++++++++++++++++++ Documentation/_includes/title.html | 13 ----- Documentation/_layouts/page.html | 28 +++++++++ Documentation/_plugins/site_title_link.rb | 10 ---- Documentation/_sass/custom/custom.scss | 43 -------------- Documentation/bibliography.html | 38 ++---------- Documentation/contributing.html | 38 ++---------- Documentation/design.html | 38 ++---------- Documentation/doc/about/architecture.adoc | 1 - Documentation/doc/about/index.adoc | 1 - Documentation/doc/about/requirements.adoc | 1 - Documentation/doc/contributing/b4.adoc | 2 - .../contributing/building-documentation.adoc | 1 - .../doc/contributing/communication.adoc | 1 - .../doc/contributing/first-patch.adoc | 2 - Documentation/doc/contributing/index.adoc | 1 - Documentation/doc/contributing/replying.adoc | 2 - .../doc/contributing/reviewing-patches.adoc | 2 - .../doc/contributing/testing-patches.adoc | 2 - .../contributing/working-with-patches.adoc | 2 - .../contributing/writing_documentation.adoc | 3 +- ...architecture-decision-record-template.adoc | 2 +- .../decisions/001-host-update-mechanism.adoc | 2 - .../doc/decisions/002-install-options.adoc | 2 - .../doc/decisions/003-partitioning.adoc | 2 - .../004-data-at-rest-encryption.adoc | 2 - .../005-virtual-machine-monitor.adoc | 2 - .../doc/decisions/006-drivers-on-host.adoc | 2 - .../decisions/007-usb-virtual-machines.adoc | 2 - ...008-inter-vm-communication-mechanisms.adoc | 2 - Documentation/doc/decisions/index.adoc | 2 - .../doc/development/build-configuration.adoc | 1 - .../doc/development/built-in-vms.adoc | 1 - Documentation/doc/development/checks.adoc | 1 - Documentation/doc/development/debugging.adoc | 1 - Documentation/doc/development/index.adoc | 1 - .../doc/development/persistent-storage.adoc | 1 - Documentation/doc/development/release.adoc | 1 - Documentation/doc/development/updates.adoc | 1 - .../doc/development/uuid-reference.adoc | 1 - Documentation/doc/index.adoc | 11 +++- .../doc/installation/binary-cache.adoc | 1 - .../doc/installation/getting-spectrum.adoc | 1 - Documentation/doc/installation/index.adoc | 1 - .../using-spectrum/creating-custom-vms.adoc | 1 - Documentation/doc/using-spectrum/index.adoc | 1 - .../doc/using-spectrum/running-vms.adoc | 1 - .../doc/using-spectrum/vm-file-access.adoc | 1 - Documentation/gemset.nix | 33 ----------- Documentation/impressum.html | 35 ++--------- Documentation/index.html | 33 ++--------- Documentation/logo/index.html | 38 ++---------- Documentation/motivation.html | 38 ++---------- Documentation/sitemap.adoc | 8 +++ .../software/cloud-hypervisor/index.html | 39 ++----------- Documentation/software/index.html | 38 ++---------- Documentation/style.css | 58 +++++++++++++++++++ 62 files changed, 234 insertions(+), 468 deletions(-) create mode 100644 Documentation/_includes/breadcrumb.html create mode 100644 Documentation/_includes/sitemap.html delete mode 100644 Documentation/_includes/title.html create mode 100644 Documentation/_layouts/page.html delete mode 100644 Documentation/_plugins/site_title_link.rb delete mode 100644 Documentation/_sass/custom/custom.scss create mode 100644 Documentation/sitemap.adoc -- 2.51.2

2 16

Vhost-guest (was virtio vhost-user) vs virtio-msg
by Demi Marie Obenour 11 Jun '26

11 Jun '26

On 5/28/26 01:47, Manos Pitsidianakis wrote: > On Thu, May 28, 2026 at 8:22 AM Parav Pandit <parav(a)nvidia.com> wrote: >> >> >>> From: Demi Marie Obenour <demiobenour(a)gmail.com> >>> Sent: 28 May 2026 05:23 AM >>> To: virtio-comment(a)lists.linux.dev >>> Subject: MSI-X vector limits and reserving a virtio device ID >>> >>> I'd like to reserve a virtio device ID for virtio vhost-guest, >>> formally virtio vhost-user. Would this be possible? >>> >> Vhost user is an implementation of the device. >> I believe it stays as implementation and not a new device type. > > This exactly. > > Furthermore, we already have a mechanism for "providing" an arbitrary > virtio device; it's called a transport. > > Demi, I suggest you look into virtio-msg transport, which would allow > you to do what you want. I'm aware of virtio-msg, and in fact considered using it. However, I found that virtio-msg doesn't meet my requirements. 1. Virtio-msg needs to run over a transport of its own. None of the proposed transports support KVM guests on x86. FF-A is the only one that would make sense with KVM, but FF-A is specific to Arm. 2. Virtio-msg isn't compatible with existing frontend VMMs. Vhost-guest can be used with any frontend VMM that implements vhost-user. 3. Virtio-msg isn't compatible with existing frontend drivers. While I expect that drivers for Linux will eventually be upstreamed, I doubt that drivers for Windows or *BSD will ever be written. I don't even know if the Windows Driver Framework provides enough to write one. I don't need this myself, but I suspect that this is enough to make virtio-msg unsuitable in many environments. 4. Virtio-msg requires invasive changes to existing userspace device implementations. The project I work on doesn't use QEMU, and the existing frontends are targeted at server use-cases. Using the vhost-user protocol lets me reuse these with little effort. 5. To the best of my knowledge, virtio-msg doesn't support live migration of frontend VMs. Vhost-guest uses the vhost-user protocol, which has supported this for a very long time. I don't need live migration myself, but for many server use-cases, not having live migration is a dealbreaker. 6. I don't know if virtio-msg can achieve comparable performance. It appears to be optimized for reliability and isolation, not processing tens of gigabits of network traffic per second. Vhost-guest is designed with performance in mind. Vhost-guest is designed for storage and networking appliances on servers, whereas virtio-msg is designed for safety-critical embedded systems. These domains have very different requirements, and as a result they arrived at very different solutions. I work on Spectrum (https://spectrum-os.org) which uses Cloud Hypervisor. As the name implies, Cloud Hypervisor is primarily intended for cloud workloads, though it can also be used on clients. I don't think that an implementation of virtio-msg would be accepted, as it benefits none of Cloud Hypervisor's other users. -- Sincerely, Demi Marie Obenour (she/her/hers)

5 4

[PATCH v1] Documentation: render the whole site through Jekyll
by Valentin Gagarin 01 Jun '26

01 Jun '26

With the website merged in, there's no longer a reason to handle the landing pages and the documentation through separate pipelines. Also reinstate the relevant parts of the www README for the static pages for the time being, and update the license informaton accordingly. To keep behavior as it is and the diff minimal, patch the documentation site header to point to the documentation instead of the toplevel. --- Documentation/README | 30 ++++++++++++++++++ Documentation/README.license | 1 + Documentation/_config.yml | 3 +- Documentation/_plugins/site_title_link.rb | 10 ++++++ Documentation/{www => }/bibliography.html | 0 Documentation/{www => }/contributing.html | 0 Documentation/default.nix | 4 ++- Documentation/{www => }/design.html | 0 .../{ => doc}/about/architecture.adoc | 0 Documentation/{ => doc}/about/index.adoc | 0 .../{ => doc}/about/requirements.adoc | 0 Documentation/{ => doc}/contributing/b4.adoc | 0 .../contributing/building-documentation.adoc | 0 .../{ => doc}/contributing/communication.adoc | 0 .../{ => doc}/contributing/first-patch.adoc | 0 .../{ => doc}/contributing/index.adoc | 0 .../{ => doc}/contributing/replying.adoc | 0 .../contributing/reviewing-patches.adoc | 0 .../contributing/testing-patches.adoc | 0 .../contributing/working-with-patches.adoc | 0 .../contributing/writing_documentation.adoc | 0 ...architecture-decision-record-template.adoc | 0 .../decisions/001-host-update-mechanism.adoc | 0 .../decisions/002-install-options.adoc | 0 .../{ => doc}/decisions/003-partitioning.adoc | 0 .../004-data-at-rest-encryption.adoc | 0 .../005-virtual-machine-monitor.adoc | 0 .../decisions/006-drivers-on-host.adoc | 0 .../decisions/007-usb-virtual-machines.adoc | 0 ...008-inter-vm-communication-mechanisms.adoc | 0 Documentation/{ => doc}/decisions/index.adoc | 0 .../development/build-configuration.adoc | 0 .../{ => doc}/development/built-in-vms.adoc | 0 .../{ => doc}/development/checks.adoc | 0 .../{ => doc}/development/debugging.adoc | 0 .../{ => doc}/development/index.adoc | 0 .../development/persistent-storage.adoc | 0 .../{ => doc}/development/release.adoc | 0 .../{ => doc}/development/updates.adoc | 0 .../{ => doc}/development/uuid-reference.adoc | 0 Documentation/{ => doc}/index.adoc | 0 .../{ => doc}/installation/binary-cache.adoc | 0 .../installation/getting-spectrum.adoc | 0 .../{ => doc}/installation/index.adoc | 0 .../using-spectrum/creating-custom-vms.adoc | 0 .../{ => doc}/using-spectrum/index.adoc | 0 .../{ => doc}/using-spectrum/running-vms.adoc | 0 .../using-spectrum/vm-file-access.adoc | 0 Documentation/{www => }/impressum.html | 0 Documentation/{www => }/index.html | 0 Documentation/{www => }/logo/index.html | 0 Documentation/{www => }/logo/logo140.png | Bin .../{www => }/logo/logo140.png.license | 0 Documentation/{www => }/logo/logo200.png | Bin .../{www => }/logo/logo200.png.license | 0 Documentation/{www => }/logo/logo400.png | Bin .../{www => }/logo/logo400.png.license | 0 Documentation/{www => }/logo/logo70.png | Bin .../{www => }/logo/logo70.png.license | 0 Documentation/{www => }/logo/logo_html.svg | 0 Documentation/{www => }/logo/logo_mesh.svg | 0 Documentation/{www => }/motivation.html | 0 .../software/cloud-hypervisor/index.html | 0 Documentation/{www => }/software/index.html | 0 Documentation/{www => }/style.css | 0 Documentation/www/README | 12 ------- release/checks/doc-links.nix | 6 ++-- 67 files changed, 47 insertions(+), 19 deletions(-) create mode 100644 Documentation/_plugins/site_title_link.rb rename Documentation/{www => }/bibliography.html (100%) rename Documentation/{www => }/contributing.html (100%) rename Documentation/{www => }/design.html (100%) rename Documentation/{ => doc}/about/architecture.adoc (100%) rename Documentation/{ => doc}/about/index.adoc (100%) rename Documentation/{ => doc}/about/requirements.adoc (100%) rename Documentation/{ => doc}/contributing/b4.adoc (100%) rename Documentation/{ => doc}/contributing/building-documentation.adoc (100%) rename Documentation/{ => doc}/contributing/communication.adoc (100%) rename Documentation/{ => doc}/contributing/first-patch.adoc (100%) rename Documentation/{ => doc}/contributing/index.adoc (100%) rename Documentation/{ => doc}/contributing/replying.adoc (100%) rename Documentation/{ => doc}/contributing/reviewing-patches.adoc (100%) rename Documentation/{ => doc}/contributing/testing-patches.adoc (100%) rename Documentation/{ => doc}/contributing/working-with-patches.adoc (100%) rename Documentation/{ => doc}/contributing/writing_documentation.adoc (100%) rename Documentation/{ => doc}/decisions/000-lightweight-architecture-decision-record-template.adoc (100%) rename Documentation/{ => doc}/decisions/001-host-update-mechanism.adoc (100%) rename Documentation/{ => doc}/decisions/002-install-options.adoc (100%) rename Documentation/{ => doc}/decisions/003-partitioning.adoc (100%) rename Documentation/{ => doc}/decisions/004-data-at-rest-encryption.adoc (100%) rename Documentation/{ => doc}/decisions/005-virtual-machine-monitor.adoc (100%) rename Documentation/{ => doc}/decisions/006-drivers-on-host.adoc (100%) rename Documentation/{ => doc}/decisions/007-usb-virtual-machines.adoc (100%) rename Documentation/{ => doc}/decisions/008-inter-vm-communication-mechanisms.adoc (100%) rename Documentation/{ => doc}/decisions/index.adoc (100%) rename Documentation/{ => doc}/development/build-configuration.adoc (100%) rename Documentation/{ => doc}/development/built-in-vms.adoc (100%) rename Documentation/{ => doc}/development/checks.adoc (100%) rename Documentation/{ => doc}/development/debugging.adoc (100%) rename Documentation/{ => doc}/development/index.adoc (100%) rename Documentation/{ => doc}/development/persistent-storage.adoc (100%) rename Documentation/{ => doc}/development/release.adoc (100%) rename Documentation/{ => doc}/development/updates.adoc (100%) rename Documentation/{ => doc}/development/uuid-reference.adoc (100%) rename Documentation/{ => doc}/index.adoc (100%) rename Documentation/{ => doc}/installation/binary-cache.adoc (100%) rename Documentation/{ => doc}/installation/getting-spectrum.adoc (100%) rename Documentation/{ => doc}/installation/index.adoc (100%) rename Documentation/{ => doc}/using-spectrum/creating-custom-vms.adoc (100%) rename Documentation/{ => doc}/using-spectrum/index.adoc (100%) rename Documentation/{ => doc}/using-spectrum/running-vms.adoc (100%) rename Documentation/{ => doc}/using-spectrum/vm-file-access.adoc (100%) rename Documentation/{www => }/impressum.html (100%) rename Documentation/{www => }/index.html (100%) rename Documentation/{www => }/logo/index.html (100%) rename Documentation/{www => }/logo/logo140.png (100%) rename Documentation/{www => }/logo/logo140.png.license (100%) rename Documentation/{www => }/logo/logo200.png (100%) rename Documentation/{www => }/logo/logo200.png.license (100%) rename Documentation/{www => }/logo/logo400.png (100%) rename Documentation/{www => }/logo/logo400.png.license (100%) rename Documentation/{www => }/logo/logo70.png (100%) rename Documentation/{www => }/logo/logo70.png.license (100%) rename Documentation/{www => }/logo/logo_html.svg (100%) rename Documentation/{www => }/logo/logo_mesh.svg (100%) rename Documentation/{www => }/motivation.html (100%) rename Documentation/{www => }/software/cloud-hypervisor/index.html (100%) rename Documentation/{www => }/software/index.html (100%) rename Documentation/{www => }/style.css (100%) delete mode 100644 Documentation/www/README diff --git a/Documentation/README b/Documentation/README index 85673f0..8c7af40 100644 --- a/Documentation/README +++ b/Documentation/README @@ -1,2 +1,32 @@ +These files contain the static portion of the website accessible at +<https://spectrum-os.org/>. CGit, Mailman, etc, are run seperately. + +If you would like to contribute to the Spectrum operating system itself, please +refer to the contributing.html file. + If you'd like to contribute to the documentation, see building-documentation.adoc for how to get started. + +Design tweaks, content updates, fixes (both factual and grammatical), +and new content for the Spectrum website are all welcomed. + +Try to keep lines at around 70 characters, HTML out of the way as much +as possible while still being valid (did you know <p> can +self-close?), and CSS to a minimum. We want to optimise for the +website being as nice as possible to navigate in a text editor, to +encourage people to edit and improve the website. + +For any changes that are likely to be copyrightable (i.e. those that +involve any amount of creative input from you), please add an +SPDX-FileCopyrightText header to the file so we can keep track of +copyright holders. Every file should already have at least one +example of these that you can use as a template. If you'd rather not +list your email address in the copyright notice, it's fine to omit +that. + +The content of these web pages may be redistributed under the terms of +either the CC-BY-SA license (version 4.0 or later), or the GNU Free +Documentation License (version 1.2 or later), at your option. + +The source code of these web pages may be redistributed under the +terms of the GNU General Public License (version 3.0 or later). diff --git a/Documentation/README.license b/Documentation/README.license index b50fd9e..857eeba 100644 --- a/Documentation/README.license +++ b/Documentation/README.license @@ -1,2 +1,3 @@ SPDX-FileCopyrightText: Unikie +SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 diff --git a/Documentation/_config.yml b/Documentation/_config.yml index 277992d..df84cb5 100644 --- a/Documentation/_config.yml +++ b/Documentation/_config.yml @@ -2,7 +2,7 @@ # SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> --- title: Spectrum documentation -logo: "https://spectrum-os.org/logo/logo_html.svg" +logo: /logo/logo_html.svg theme: just-the-docs aux_links: Home: @@ -15,7 +15,6 @@ exclude: - '*.license' - '*.nix' - /scripts - - /www - README - result* asciidoctor: diff --git a/Documentation/_plugins/site_title_link.rb b/Documentation/_plugins/site_title_link.rb new file mode 100644 index 0000000..4095701 --- /dev/null +++ b/Documentation/_plugins/site_title_link.rb @@ -0,0 +1,10 @@ +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2026 Valentin Gagarin <valentin(a)gagarin.work> + +# Just the Docs hardcodes the site header link to `/`. +# https://github.com/just-the-docs/just-the-docs/blob/v0.10.1/_includes/compo… +# Make it point to the docs root, not the top-level site. +Jekyll::Hooks.register [:pages, :documents], :post_render do |item| + item.output.sub!('<a href="/" class="site-title', + '<a href="/doc/" class="site-title') +end diff --git a/Documentation/www/bibliography.html b/Documentation/bibliography.html similarity index 100% rename from Documentation/www/bibliography.html rename to Documentation/bibliography.html diff --git a/Documentation/www/contributing.html b/Documentation/contributing.html similarity index 100% rename from Documentation/www/contributing.html rename to Documentation/contributing.html diff --git a/Documentation/default.nix b/Documentation/default.nix index 8453e87..3b9e973 100644 --- a/Documentation/default.nix +++ b/Documentation/default.nix @@ -17,10 +17,12 @@ stdenvNoCC.mkDerivation { buildPhase = '' runHook preBuild - jekyll build --disable-disk-cache -b /doc -d $out + jekyll build --disable-disk-cache -d $out runHook postBuild ''; + # The fixup phase would move `doc` to `share/doc` and we don't want that. + dontFixup = true; dontInstall = true; nativeBuildInputs = [ (callSpectrumPackage ./jekyll.nix {}) ]; diff --git a/Documentation/www/design.html b/Documentation/design.html similarity index 100% rename from Documentation/www/design.html rename to Documentation/design.html diff --git a/Documentation/about/architecture.adoc b/Documentation/doc/about/architecture.adoc similarity index 100% rename from Documentation/about/architecture.adoc rename to Documentation/doc/about/architecture.adoc diff --git a/Documentation/about/index.adoc b/Documentation/doc/about/index.adoc similarity index 100% rename from Documentation/about/index.adoc rename to Documentation/doc/about/index.adoc diff --git a/Documentation/about/requirements.adoc b/Documentation/doc/about/requirements.adoc similarity index 100% rename from Documentation/about/requirements.adoc rename to Documentation/doc/about/requirements.adoc diff --git a/Documentation/contributing/b4.adoc b/Documentation/doc/contributing/b4.adoc similarity index 100% rename from Documentation/contributing/b4.adoc rename to Documentation/doc/contributing/b4.adoc diff --git a/Documentation/contributing/building-documentation.adoc b/Documentation/doc/contributing/building-documentation.adoc similarity index 100% rename from Documentation/contributing/building-documentation.adoc rename to Documentation/doc/contributing/building-documentation.adoc diff --git a/Documentation/contributing/communication.adoc b/Documentation/doc/contributing/communication.adoc similarity index 100% rename from Documentation/contributing/communication.adoc rename to Documentation/doc/contributing/communication.adoc diff --git a/Documentation/contributing/first-patch.adoc b/Documentation/doc/contributing/first-patch.adoc similarity index 100% rename from Documentation/contributing/first-patch.adoc rename to Documentation/doc/contributing/first-patch.adoc diff --git a/Documentation/contributing/index.adoc b/Documentation/doc/contributing/index.adoc similarity index 100% rename from Documentation/contributing/index.adoc rename to Documentation/doc/contributing/index.adoc diff --git a/Documentation/contributing/replying.adoc b/Documentation/doc/contributing/replying.adoc similarity index 100% rename from Documentation/contributing/replying.adoc rename to Documentation/doc/contributing/replying.adoc diff --git a/Documentation/contributing/reviewing-patches.adoc b/Documentation/doc/contributing/reviewing-patches.adoc similarity index 100% rename from Documentation/contributing/reviewing-patches.adoc rename to Documentation/doc/contributing/reviewing-patches.adoc diff --git a/Documentation/contributing/testing-patches.adoc b/Documentation/doc/contributing/testing-patches.adoc similarity index 100% rename from Documentation/contributing/testing-patches.adoc rename to Documentation/doc/contributing/testing-patches.adoc diff --git a/Documentation/contributing/working-with-patches.adoc b/Documentation/doc/contributing/working-with-patches.adoc similarity index 100% rename from Documentation/contributing/working-with-patches.adoc rename to Documentation/doc/contributing/working-with-patches.adoc diff --git a/Documentation/contributing/writing_documentation.adoc b/Documentation/doc/contributing/writing_documentation.adoc similarity index 100% rename from Documentation/contributing/writing_documentation.adoc rename to Documentation/doc/contributing/writing_documentation.adoc diff --git a/Documentation/decisions/000-lightweight-architecture-decision-record-template.adoc b/Documentation/doc/decisions/000-lightweight-architecture-decision-record-template.adoc similarity index 100% rename from Documentation/decisions/000-lightweight-architecture-decision-record-template.adoc rename to Documentation/doc/decisions/000-lightweight-architecture-decision-record-template.adoc diff --git a/Documentation/decisions/001-host-update-mechanism.adoc b/Documentation/doc/decisions/001-host-update-mechanism.adoc similarity index 100% rename from Documentation/decisions/001-host-update-mechanism.adoc rename to Documentation/doc/decisions/001-host-update-mechanism.adoc diff --git a/Documentation/decisions/002-install-options.adoc b/Documentation/doc/decisions/002-install-options.adoc similarity index 100% rename from Documentation/decisions/002-install-options.adoc rename to Documentation/doc/decisions/002-install-options.adoc diff --git a/Documentation/decisions/003-partitioning.adoc b/Documentation/doc/decisions/003-partitioning.adoc similarity index 100% rename from Documentation/decisions/003-partitioning.adoc rename to Documentation/doc/decisions/003-partitioning.adoc diff --git a/Documentation/decisions/004-data-at-rest-encryption.adoc b/Documentation/doc/decisions/004-data-at-rest-encryption.adoc similarity index 100% rename from Documentation/decisions/004-data-at-rest-encryption.adoc rename to Documentation/doc/decisions/004-data-at-rest-encryption.adoc diff --git a/Documentation/decisions/005-virtual-machine-monitor.adoc b/Documentation/doc/decisions/005-virtual-machine-monitor.adoc similarity index 100% rename from Documentation/decisions/005-virtual-machine-monitor.adoc rename to Documentation/doc/decisions/005-virtual-machine-monitor.adoc diff --git a/Documentation/decisions/006-drivers-on-host.adoc b/Documentation/doc/decisions/006-drivers-on-host.adoc similarity index 100% rename from Documentation/decisions/006-drivers-on-host.adoc rename to Documentation/doc/decisions/006-drivers-on-host.adoc diff --git a/Documentation/decisions/007-usb-virtual-machines.adoc b/Documentation/doc/decisions/007-usb-virtual-machines.adoc similarity index 100% rename from Documentation/decisions/007-usb-virtual-machines.adoc rename to Documentation/doc/decisions/007-usb-virtual-machines.adoc diff --git a/Documentation/decisions/008-inter-vm-communication-mechanisms.adoc b/Documentation/doc/decisions/008-inter-vm-communication-mechanisms.adoc similarity index 100% rename from Documentation/decisions/008-inter-vm-communication-mechanisms.adoc rename to Documentation/doc/decisions/008-inter-vm-communication-mechanisms.adoc diff --git a/Documentation/decisions/index.adoc b/Documentation/doc/decisions/index.adoc similarity index 100% rename from Documentation/decisions/index.adoc rename to Documentation/doc/decisions/index.adoc diff --git a/Documentation/development/build-configuration.adoc b/Documentation/doc/development/build-configuration.adoc similarity index 100% rename from Documentation/development/build-configuration.adoc rename to Documentation/doc/development/build-configuration.adoc diff --git a/Documentation/development/built-in-vms.adoc b/Documentation/doc/development/built-in-vms.adoc similarity index 100% rename from Documentation/development/built-in-vms.adoc rename to Documentation/doc/development/built-in-vms.adoc diff --git a/Documentation/development/checks.adoc b/Documentation/doc/development/checks.adoc similarity index 100% rename from Documentation/development/checks.adoc rename to Documentation/doc/development/checks.adoc diff --git a/Documentation/development/debugging.adoc b/Documentation/doc/development/debugging.adoc similarity index 100% rename from Documentation/development/debugging.adoc rename to Documentation/doc/development/debugging.adoc diff --git a/Documentation/development/index.adoc b/Documentation/doc/development/index.adoc similarity index 100% rename from Documentation/development/index.adoc rename to Documentation/doc/development/index.adoc diff --git a/Documentation/development/persistent-storage.adoc b/Documentation/doc/development/persistent-storage.adoc similarity index 100% rename from Documentation/development/persistent-storage.adoc rename to Documentation/doc/development/persistent-storage.adoc diff --git a/Documentation/development/release.adoc b/Documentation/doc/development/release.adoc similarity index 100% rename from Documentation/development/release.adoc rename to Documentation/doc/development/release.adoc diff --git a/Documentation/development/updates.adoc b/Documentation/doc/development/updates.adoc similarity index 100% rename from Documentation/development/updates.adoc rename to Documentation/doc/development/updates.adoc diff --git a/Documentation/development/uuid-reference.adoc b/Documentation/doc/development/uuid-reference.adoc similarity index 100% rename from Documentation/development/uuid-reference.adoc rename to Documentation/doc/development/uuid-reference.adoc diff --git a/Documentation/index.adoc b/Documentation/doc/index.adoc similarity index 100% rename from Documentation/index.adoc rename to Documentation/doc/index.adoc diff --git a/Documentation/installation/binary-cache.adoc b/Documentation/doc/installation/binary-cache.adoc similarity index 100% rename from Documentation/installation/binary-cache.adoc rename to Documentation/doc/installation/binary-cache.adoc diff --git a/Documentation/installation/getting-spectrum.adoc b/Documentation/doc/installation/getting-spectrum.adoc similarity index 100% rename from Documentation/installation/getting-spectrum.adoc rename to Documentation/doc/installation/getting-spectrum.adoc diff --git a/Documentation/installation/index.adoc b/Documentation/doc/installation/index.adoc similarity index 100% rename from Documentation/installation/index.adoc rename to Documentation/doc/installation/index.adoc diff --git a/Documentation/using-spectrum/creating-custom-vms.adoc b/Documentation/doc/using-spectrum/creating-custom-vms.adoc similarity index 100% rename from Documentation/using-spectrum/creating-custom-vms.adoc rename to Documentation/doc/using-spectrum/creating-custom-vms.adoc diff --git a/Documentation/using-spectrum/index.adoc b/Documentation/doc/using-spectrum/index.adoc similarity index 100% rename from Documentation/using-spectrum/index.adoc rename to Documentation/doc/using-spectrum/index.adoc diff --git a/Documentation/using-spectrum/running-vms.adoc b/Documentation/doc/using-spectrum/running-vms.adoc similarity index 100% rename from Documentation/using-spectrum/running-vms.adoc rename to Documentation/doc/using-spectrum/running-vms.adoc diff --git a/Documentation/using-spectrum/vm-file-access.adoc b/Documentation/doc/using-spectrum/vm-file-access.adoc similarity index 100% rename from Documentation/using-spectrum/vm-file-access.adoc rename to Documentation/doc/using-spectrum/vm-file-access.adoc diff --git a/Documentation/www/impressum.html b/Documentation/impressum.html similarity index 100% rename from Documentation/www/impressum.html rename to Documentation/impressum.html diff --git a/Documentation/www/index.html b/Documentation/index.html similarity index 100% rename from Documentation/www/index.html rename to Documentation/index.html diff --git a/Documentation/www/logo/index.html b/Documentation/logo/index.html similarity index 100% rename from Documentation/www/logo/index.html rename to Documentation/logo/index.html diff --git a/Documentation/www/logo/logo140.png b/Documentation/logo/logo140.png similarity index 100% rename from Documentation/www/logo/logo140.png rename to Documentation/logo/logo140.png diff --git a/Documentation/www/logo/logo140.png.license b/Documentation/logo/logo140.png.license similarity index 100% rename from Documentation/www/logo/logo140.png.license rename to Documentation/logo/logo140.png.license diff --git a/Documentation/www/logo/logo200.png b/Documentation/logo/logo200.png similarity index 100% rename from Documentation/www/logo/logo200.png rename to Documentation/logo/logo200.png diff --git a/Documentation/www/logo/logo200.png.license b/Documentation/logo/logo200.png.license similarity index 100% rename from Documentation/www/logo/logo200.png.license rename to Documentation/logo/logo200.png.license diff --git a/Documentation/www/logo/logo400.png b/Documentation/logo/logo400.png similarity index 100% rename from Documentation/www/logo/logo400.png rename to Documentation/logo/logo400.png diff --git a/Documentation/www/logo/logo400.png.license b/Documentation/logo/logo400.png.license similarity index 100% rename from Documentation/www/logo/logo400.png.license rename to Documentation/logo/logo400.png.license diff --git a/Documentation/www/logo/logo70.png b/Documentation/logo/logo70.png similarity index 100% rename from Documentation/www/logo/logo70.png rename to Documentation/logo/logo70.png diff --git a/Documentation/www/logo/logo70.png.license b/Documentation/logo/logo70.png.license similarity index 100% rename from Documentation/www/logo/logo70.png.license rename to Documentation/logo/logo70.png.license diff --git a/Documentation/www/logo/logo_html.svg b/Documentation/logo/logo_html.svg similarity index 100% rename from Documentation/www/logo/logo_html.svg rename to Documentation/logo/logo_html.svg diff --git a/Documentation/www/logo/logo_mesh.svg b/Documentation/logo/logo_mesh.svg similarity index 100% rename from Documentation/www/logo/logo_mesh.svg rename to Documentation/logo/logo_mesh.svg diff --git a/Documentation/www/motivation.html b/Documentation/motivation.html similarity index 100% rename from Documentation/www/motivation.html rename to Documentation/motivation.html diff --git a/Documentation/www/software/cloud-hypervisor/index.html b/Documentation/software/cloud-hypervisor/index.html similarity index 100% rename from Documentation/www/software/cloud-hypervisor/index.html rename to Documentation/software/cloud-hypervisor/index.html diff --git a/Documentation/www/software/index.html b/Documentation/software/index.html similarity index 100% rename from Documentation/www/software/index.html rename to Documentation/software/index.html diff --git a/Documentation/www/style.css b/Documentation/style.css similarity index 100% rename from Documentation/www/style.css rename to Documentation/style.css diff --git a/Documentation/www/README b/Documentation/www/README deleted file mode 100644 index 5723fb8..0000000 --- a/Documentation/www/README +++ /dev/null @@ -1,12 +0,0 @@ -SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> -SPDX-License-Identifier: CC0-1.0 - -These files contain the static portion of the website accessible at -<https://spectrum-os.org/>. CGit, Mailman, etc, are run separately. - -The content of these web pages may be redistributed under the terms of -either the CC-BY-SA license (version 4.0 or later), or the GNU Free -Documentation License (version 1.2 or later), at your option. - -The source code of these web pages may be redistributed under the -terms of the GNU General Public License (version 3.0 or later). diff --git a/release/checks/doc-links.nix b/release/checks/doc-links.nix index 882a0d5..77102d6 100644 --- a/release/checks/doc-links.nix +++ b/release/checks/doc-links.nix @@ -8,10 +8,8 @@ runCommand "spectrum-doc-links" { doc = callSpectrumPackage ../../Documentation {}; nativeBuildInputs = [ bozohttpd wget ]; } '' - mkdir root - ln -s $doc root/doc - httpd -bI 4000 root - wget -r -nv --delete-after --no-parent --retry-connrefused http://localhost:4000/doc/ + httpd -bI 4000 $doc + wget -r -nv --delete-after --no-parent --retry-connrefused http://localhost:4000/ touch $out '' ) (_: {}) -- 2.51.2

3 3