From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from atuin.qyliss.net (localhost [IPv6:::1]) by atuin.qyliss.net (Postfix) with ESMTP id 784CEAC13; Thu, 28 May 2026 09:05:33 +0000 (UTC) Received: by atuin.qyliss.net (Postfix, from userid 993) id EF639AC10; Thu, 28 May 2026 09:05:29 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on atuin.qyliss.net X-Spam-Level: ** X-Spam-Status: No, score=2.4 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,DMARC_MISSING,FROM_SUSPICIOUS_NTLD, FROM_SUSPICIOUS_NTLD_FP,SPF_HELO_NONE,T_PDS_OTHER_BAD_TLD autolearn=no autolearn_force=no version=4.0.1 Received: from mail-108-mta169.mxroute.com (mail-108-mta169.mxroute.com [136.175.108.169]) by atuin.qyliss.net (Postfix) with ESMTPS id 0671BAB94 for ; Thu, 28 May 2026 09:05:27 +0000 (UTC) Received: from filter006.mxroute.com ([136.175.111.3] filter006.mxroute.com) (Authenticated sender: mN4UYu2MZsgR) by mail-108-mta169.mxroute.com (ZoneMTA) with ESMTPSA id 19e6dd4d38200067f7.001 for (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384); Thu, 28 May 2026 09:05:24 +0000 X-Zone-Loop: 658d4c6d06a3efc18f034af66f27b48cc429ffdc2290 X-Originating-IP: [136.175.111.3] DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gagarin.work; s=x; h=Content-Transfer-Encoding:MIME-Version:Message-ID:Date :Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=h4upTcKkvvFofC+GLWbEjtVEszWBGnF0baWeTZwDH+c=; b=QmY19j13VRZZT+111b6mAhsB+A p0JAiwRYqXAXBaSEvcmR6Ru2j6MJPC6fQ7U5ZowQEgfl8Fovi0SKVjuOUYkNqE/VviV4/liQipfve XV+h8IfcNUKiHg9j1b++fH3VmadlUMBHBvKSLFSPvUcVuxT89oeAXr0jK7sMm0eo4Wnx8PKWgabfT wTx1CgtFW7BGcEZutDwJc2KtHTbahHRi/exWKwI9a9BcXzFUkY00XOtMnj5VBUf7y0QuTf9uhGDOP DgfWehVZ7uiOyR0pwKr9JBt5qUOWdlt7kdSZrx+eJv+6I2I/C1pN/HH7b5RBK5z1bjQHR09QI+7hD F+EHLVAA==; From: Valentin Gagarin To: devel@spectrum-os.org Subject: [PATCH v1] Documentation: render the whole site through Jekyll Date: Thu, 28 May 2026 11:05:13 +0200 Message-ID: <20260528090513.105612-1-valentin@gagarin.work> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Authenticated-Id: valentin@gagarin.work Message-ID-Hash: X3RT6RV7MESL2TQBLFDVV54SHQSV6TMG X-Message-ID-Hash: X3RT6RV7MESL2TQBLFDVV54SHQSV6TMG X-MailFrom: valentin@gagarin.work X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-devel.spectrum-os.org-0; header-match-devel.spectrum-os.org-1; header-match-devel.spectrum-os.org-2; header-match-devel.spectrum-os.org-3; header-match-devel.spectrum-os.org-4; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Valentin Gagarin X-Mailman-Version: 3.3.9 Precedence: list List-Id: Patches and low-level development discussion Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: 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 +. 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

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 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 --- 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 + +# Just the Docs hardcodes the site header link to `/`. +# https://github.com/just-the-docs/just-the-docs/blob/v0.10.1/_includes/components/sidebar.html#L14 +# Make it point to the docs root, not the top-level site. +Jekyll::Hooks.register [:pages, :documents], :post_render do |item| + item.output.sub!('