From 2a7c3ef66a786c56cff7d4b4b837cad0cb77baba Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Thu, 30 Apr 2026 16:53:59 +0200 Subject: [PATCH 1/2] docs: move testing docs to Diataxis Signed-off-by: Eike Waldt On-behalf-of: SAP --- repos-config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/repos-config.json b/repos-config.json index bd05336..0643cdf 100644 --- a/repos-config.json +++ b/repos-config.json @@ -6,7 +6,7 @@ "docs_path": "docs", "target_path": "projects/gardenlinux", "ref": "docs-ng", - "commit": "7544e2f732ccd8fd5aa66a202925df575eca6247", + "commit": "3c254a52a6a0f4037f28b2a1b5a24fc3813a9507", "root_files": [ "CONTRIBUTING.md", "SECURITY.md", From 1270c8cbe03767a4f3393d58faf0906a18bfd560 Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Tue, 5 May 2026 14:27:47 +0200 Subject: [PATCH 2/2] docs: use absolute vitepress links Signed-off-by: Eike Waldt On-behalf-of: SAP --- .../documentation/vitepress-features.md | 2 +- docs/introduction/index.md | 2 +- docs/reference/glossary.md | 22 +++++++++---------- docs/tutorials/index.md | 6 ++--- repos-config.json | 4 ++-- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/contributing/documentation/vitepress-features.md b/docs/contributing/documentation/vitepress-features.md index 279f3e1..4c16f74 100644 --- a/docs/contributing/documentation/vitepress-features.md +++ b/docs/contributing/documentation/vitepress-features.md @@ -178,7 +178,7 @@ gantt ``` **Real-world example:** -See the [Maintained Releases](../../reference/releases/maintained-releases.md) page for a complete Gantt chart showing release maintenance phases. +See the [Maintained Releases](/reference/releases/maintained-releases) page for a complete Gantt chart showing release maintenance phases. ## Container Syntax (Callouts) diff --git a/docs/introduction/index.md b/docs/introduction/index.md index c35a528..352a9ce 100644 --- a/docs/introduction/index.md +++ b/docs/introduction/index.md @@ -103,7 +103,7 @@ adding a feature, or improving documentation. Covers the documentation guide, development [workflow](/contributing/workflow), [security](/contributing/security) practices, and -[testing](/contributing/testing/) (developing tests, running tests, test +[testing](/contributing/testing) (developing tests, running tests, test coverage). ## Getting Help diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index 1c2a575..66df5d9 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -19,15 +19,15 @@ A document that captures an important architectural decision made about the Gard ### Architecture -The processor architecture for which a Garden Linux image is built. Supported architectures include `amd64` (x86-64) and `arm64` (ARM 64-bit). The architecture can be specified as the last component of a build flavor string, e.g., `kvm-python-amd64`. See [Architecture documentation](../explanation/architecture.md) for details on Garden Linux system design. +The processor architecture for which a Garden Linux image is built. Supported architectures include `amd64` (x86-64) and `arm64` (ARM 64-bit). The architecture can be specified as the last component of a build flavor string, e.g., `kvm-python-amd64`. See [Architecture documentation](/explanation/architecture.md) for details on Garden Linux system design. ### AWS -Amazon Web Services. One of the major cloud platforms supported by Garden Linux. Garden Linux provides AWS-specific images through the [`aws`](https://github.com/gardenlinux/gardenlinux/blob/main/features/aws/README.md) platform feature with cloud-init integration and AWS-specific kernel modules. See [AWS platform guide](../how-to/installation/cloud/aws.md) and [AWS first boot tutorial](../tutorials/cloud/first-boot-aws.md) for usage details. +Amazon Web Services. One of the major cloud platforms supported by Garden Linux. Garden Linux provides AWS-specific images through the [`aws`](https://github.com/gardenlinux/gardenlinux/blob/main/features/aws/README.md) platform feature with cloud-init integration and AWS-specific kernel modules. See [AWS platform guide](/how-to/installation/cloud/aws.md) and [AWS first boot tutorial](../tutorials/cloud/first-boot-aws.md) for usage details. ### Azure -Microsoft Azure. A major cloud platform supported by Garden Linux through the [`azure`](https://github.com/gardenlinux/gardenlinux/blob/main/features/azure/README.md) platform feature with platform-specific image configurations and optimizations. See [Azure platform guide](../how-to/installation/cloud/azure.md) and [Azure first boot tutorial](../tutorials/cloud/first-boot-azure.md) for usage details. +Microsoft Azure. A major cloud platform supported by Garden Linux through the [`azure`](https://github.com/gardenlinux/gardenlinux/blob/main/features/azure/README.md) platform feature with platform-specific image configurations and optimizations. See [Azure platform guide](/how-to/installation/cloud/azure.md) and [Azure first boot tutorial](../tutorials/cloud/first-boot-azure.md) for usage details. --- @@ -35,11 +35,11 @@ Microsoft Azure. A major cloud platform supported by Garden Linux through the [` ### Bare Metal -A platform target for Garden Linux images designed to run directly on physical hardware without a hypervisor through the [`baremetal`](https://github.com/gardenlinux/gardenlinux/blob/main/features/baremetal/README.md) platform feature. Also referred to as [`metal`](https://github.com/gardenlinux/gardenlinux/blob/main/features/metal/README.md) in build configurations. See [Bare Metal platform guide](../how-to/installation/on-premises/bare-metal.md) and [Bare Metal first boot tutorial](../tutorials/on-premises/first-boot-bare-metal.md) for usage details. +A platform target for Garden Linux images designed to run directly on physical hardware without a hypervisor through the [`baremetal`](https://github.com/gardenlinux/gardenlinux/blob/main/features/baremetal/README.md) platform feature. Also referred to as [`metal`](https://github.com/gardenlinux/gardenlinux/blob/main/features/metal/README.md) in build configurations. See [Bare Metal platform guide](/how-to/installation/on-premises/bare-metal.md) and [Bare Metal first boot tutorial](../tutorials/on-premises/first-boot-bare-metal.md) for usage details. ### Builder -The [gardenlinux/builder](https://github.com/gardenlinux/builder) component that creates customized Linux distributions. The builder is a separate project maintained by the Garden Linux team and is used to build Garden Linux images with specific Flavors. See [Building Images documentation](../how-to/building-images.md) for practical guidance, [ADR-0020](./adr/0020-enforce-single-platform-by-default-in-builder.md) for details on platform enforcement in the builder, and [ADR-0031](./adr/0031-builder-glci-interface.md) for the builder-GLCI interface design. +The [gardenlinux/builder](https://github.com/gardenlinux/builder) component that creates customized Linux distributions. The builder is a separate project maintained by the Garden Linux team and is used to build Garden Linux images with specific Flavors. See [Building Images documentation](/how-to/building-images.md) for practical guidance, [ADR-0020](./adr/0020-enforce-single-platform-by-default-in-builder.md) for details on platform enforcement in the builder, and [ADR-0031](./adr/0031-builder-glci-interface.md) for the builder-GLCI interface design. ### Build Flavor String @@ -95,7 +95,7 @@ Refers to the [`_ephemeral`](https://github.com/gardenlinux/gardenlinux/blob/mai ### Feature -A modular component that adds specific functionality to a Garden Linux image. Features are defined in the `features/` directory. Features prefixed with an underscore (`_`) are internal/private (e.g., [`_secureboot`](https://github.com/gardenlinux/gardenlinux/blob/main/features/_secureboot/README.md), [`_dev`](https://github.com/gardenlinux/gardenlinux/blob/main/features/_dev/README.md)), while features without a prefix are public (e.g., [`cis`](https://github.com/gardenlinux/gardenlinux/blob/main/features/cis/README.md), [`gardener`](https://github.com/gardenlinux/gardenlinux/blob/main/features/gardener/README.md), [`python`](https://github.com/gardenlinux/gardenlinux/blob/main/features/python/README.md)). See [Flavors documentation](../explanation/flavors.md) for an overview, and [ADR-0032](./adr/0032-static-feature-test-coverage-analysis.md) for details on feature test coverage analysis. +A modular component that adds specific functionality to a Garden Linux image. Features are defined in the `features/` directory. Features prefixed with an underscore (`_`) are internal/private (e.g., [`_secureboot`](https://github.com/gardenlinux/gardenlinux/blob/main/features/_secureboot/README.md), [`_dev`](https://github.com/gardenlinux/gardenlinux/blob/main/features/_dev/README.md)), while features without a prefix are public (e.g., [`cis`](https://github.com/gardenlinux/gardenlinux/blob/main/features/cis/README.md), [`gardener`](https://github.com/gardenlinux/gardenlinux/blob/main/features/gardener/README.md), [`python`](https://github.com/gardenlinux/gardenlinux/blob/main/features/python/README.md)). See [Flavors documentation](/explanation/flavors.md) for an overview, and [ADR-0032](./adr/0032-static-feature-test-coverage-analysis.md) for details on feature test coverage analysis. ### FedRAMP @@ -111,7 +111,7 @@ A lightweight virtual machine monitor (VMM) for running microVMs. Garden Linux h ### Flavor -A specific combination of a platform and one or more features that defines a complete Garden Linux image configuration. Flavors are expressed as hyphen-separated strings, e.g., `kvm-python_dev` or `aws-gardener_prod-amd64`. The platform must come first, and the architecture (if specified) must come last. See [Flavors documentation](../explanation/flavors.md), [Choosing Flavors guide](../how-to/choosing-flavors.md), and [Flavor Matrix reference](./flavor-matrix.md) for more details. +A specific combination of a platform and one or more features that defines a complete Garden Linux image configuration. Flavors are expressed as hyphen-separated strings, e.g., `kvm-python_dev` or `aws-gardener_prod-amd64`. The platform must come first, and the architecture (if specified) must come last. See [Flavors documentation](/explanation/flavors.md), [Choosing Flavors guide](/how-to/choosing-flavors.md), and [Flavor Matrix reference](./flavor-matrix.md) for more details. --- @@ -119,7 +119,7 @@ A specific combination of a platform and one or more features that defines a com ### Garden Linux -A Debian GNU/Linux derivative designed to provide small, auditable Linux images for cloud providers and bare-metal machines. Garden Linux is optimized for Gardener nodes and provides extensive customization through features. See [Architectural Decisions](../explanation/architectural-decisions.md), [Use Cases](../explanation/use-cases.md), and [Security Posture](../explanation/security-posture.md) for more information. +A Debian GNU/Linux derivative designed to provide small, auditable Linux images for cloud providers and bare-metal machines. Garden Linux is optimized for Gardener nodes and provides extensive customization through features. See [Architectural Decisions](/explanation/architectural-decisions.md), [Use Cases](/explanation/use-cases.md), and [Security Posture](/explanation/security-posture.md) for more information. ### Gardener @@ -127,7 +127,7 @@ A Debian GNU/Linux derivative designed to provide small, auditable Linux images ### GCP -Google Cloud Platform. A major cloud platform supported by Garden Linux through the [`gcp`](https://github.com/gardenlinux/gardenlinux/blob/main/features/gcp/README.md) platform feature with platform-specific configurations. See [GCP platform guide](../how-to/installation/cloud/gcp.md) and [GCP first boot tutorial](../tutorials/cloud/first-boot-gcp.md) for usage details. +Google Cloud Platform. A major cloud platform supported by Garden Linux through the [`gcp`](https://github.com/gardenlinux/gardenlinux/blob/main/features/gcp/README.md) platform feature with platform-specific configurations. See [GCP platform guide](/how-to/installation/cloud/gcp.md) and [GCP first boot tutorial](../tutorials/cloud/first-boot-gcp.md) for usage details. ### GitHub Actions @@ -211,7 +211,7 @@ Automated builds of Garden Linux that occur on a regular schedule from the lates ### OCI (OCI Image Format) -OCI Image Format. A container image specification defined by the Open Container Initiative. Garden Linux provides OCI-formatted container images. See [First Boot as OCI image](../tutorials/container/first-boot-oci.md) and the [OCI platform guide](../how-to/installation/container/index.md) for usage details. +OCI Image Format. A container image specification defined by the Open Container Initiative. Garden Linux provides OCI-formatted container images. See [First Boot as OCI image](../tutorials/container/first-boot-oci.md) and the [OCI platform guide](/how-to/installation/container/index.md) for usage details. ### OpenSSL @@ -263,7 +263,7 @@ Running Podman without requiring root privileges. Garden Linux builds use rootle ### Secure Boot -A security feature that ensures only trusted software can boot on a system by verifying digital signatures. Garden Linux supports Secure Boot through the [`_secureboot`](https://github.com/gardenlinux/gardenlinux/blob/main/features/_secureboot/README.md) feature. See [ADR-0005](./adr/0005-secure-boot-keys-glci.md) for details on Secure Boot keys in GLCI, and the [Secure Boot documentation](../how-to/secure-boot.md) for usage details. +A security feature that ensures only trusted software can boot on a system by verifying digital signatures. Garden Linux supports Secure Boot through the [`_secureboot`](https://github.com/gardenlinux/gardenlinux/blob/main/features/_secureboot/README.md) feature. See [ADR-0005](./adr/0005-secure-boot-keys-glci.md) for details on Secure Boot keys in GLCI, and the [Secure Boot documentation](/how-to/secure-boot.md) for usage details. ### SELinux diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 13944fa..14c7144 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -33,7 +33,7 @@ Following the [Diátaxis framework](https://diataxis.fr/), tutorials focus on pr Once you've completed your first tutorial, you can: -- Explore [how-to guides](../how-to/index.md) for task-oriented instructions -- Read [explanations](../explanation/index.md) to understand Garden Linux concepts and architecture -- Review [reference documentation](../reference/index.md) for technical specifications +- Explore [how-to guides](/how-to/index.md) for task-oriented instructions +- Read [explanations](/explanation/index.md) to understand Garden Linux concepts and architecture +- Review [reference documentation](/reference/index.md) for technical specifications - Learn about [contributing](../contributing/index.md) to Garden Linux diff --git a/repos-config.json b/repos-config.json index 0643cdf..e725c8d 100644 --- a/repos-config.json +++ b/repos-config.json @@ -6,7 +6,7 @@ "docs_path": "docs", "target_path": "projects/gardenlinux", "ref": "docs-ng", - "commit": "3c254a52a6a0f4037f28b2a1b5a24fc3813a9507", + "commit": "063253164fffb481c5d1400f92c5455218f27897", "root_files": [ "CONTRIBUTING.md", "SECURITY.md", @@ -33,7 +33,7 @@ "docs_path": "docs", "target_path": "projects/builder", "ref": "docs-ng", - "commit": "fb9760c0f762c2209fdf23c88c251351d255d2a5", + "commit": "9a9a7e0ed3b0507e360c37dc2acd5d4d9ce36020", "media_directories": [ ".media", "assets",