Re: [PATCH v1] Documentation: render the whole site through Jekyll

[Alyssa Ross <hi@alyssa.is>]

[-- Attachment #1: Type: text/plain, Size: 3834 bytes --]

Valentin Gagarin <valentin@gagarin.work> writes:

> 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.

Needs a Signed-off-by.  (You can just reply with it.)

> 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.

This seems to have been taken from a pre-ee934976 ("README: fix
spelling") commit — release/checks/codespell.nix fails with this
applied.

I can naturally fix this up myself when applying.  Aside from that:

Reviewed-by: Alyssa Ross <hi@alyssa.is>
Tested-by: Alyssa Ross <hi@alyssa.is>

I'll prepare the corresponding change to the server config.

> +
> +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.

I assume this will be deduplicated/moved into some more generic

> 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@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:

The Home link, and some others in the Documentation tree, could also be
made non-absolute now I think.  I can do that once this is applied.

> 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@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/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!('<a href="/" class="site-title',
> +                   '<a href="/doc/" class="site-title')
> +end

Clever.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 227 bytes --]