From 12e1bc2952d1b74b766b76bfe77b449b1df8de7b Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Wed, 15 Apr 2026 13:54:00 +0200 Subject: [PATCH 1/2] docs: aggregate builder and lib correctly --- repos-config.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/repos-config.json b/repos-config.json index d9ccd2d..c9fbf9d 100644 --- a/repos-config.json +++ b/repos-config.json @@ -33,7 +33,7 @@ "docs_path": "docs", "target_path": "projects/builder", "ref": "docs-ng", - "commit": "086e74ff032c5f2a05989aef4f20ba69f94bdbf9", + "commit": "6691070742e1550dff42e00b7834df5fd4e3f832", "media_directories": [ ".media", "assets", @@ -46,7 +46,7 @@ "docs_path": "docs", "target_path": "projects/python-gardenlinux-lib", "ref": "docs-ng", - "commit": "9142fccc3d83ab51759db7d328fa19166bc1df63", + "commit": "be7fd063d1b440f490d9a1e3054179b35a7abc23", "structure": "sphinx", "media_directories": [ ".media", From 3d5c39c1f89c3301427f9c50e7bb09bf7fa54341 Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Wed, 15 Apr 2026 15:25:04 +0200 Subject: [PATCH 2/2] docs: adapt for Grundstock Signed-off-by: Eike Waldt On-behalf-of: SAP --- Makefile | 18 +++++++++--------- docs/index.md | 7 ++++++- docs/overview/index.md | 25 ++++++++++++++----------- docs/reference/glossary.md | 24 ++++++++++-------------- repos-config.json | 8 ++++---- 5 files changed, 43 insertions(+), 39 deletions(-) diff --git a/Makefile b/Makefile index 74e4c4d..6aa3faf 100644 --- a/Makefile +++ b/Makefile @@ -37,13 +37,13 @@ install: pip install git+https://github.com/gardenlinux/python-gardenlinux-lib.git@0.10.20 pip install -r requirements.txt -dev: install +dev: pnpm run docs:dev build: install clean aggregate pnpm run docs:build -preview: install +preview: pnpm run docs:preview # Testing @@ -66,28 +66,28 @@ spelling: @echo "Running spelling checks..." @pnpm run docs:spelling -linkcheck: install +linkcheck: @echo "Running link checks..." @pnpm run docs:linkcheck -woke: install +woke: @echo "Running inclusive language checks..." @pnpm run docs:woke # Documentation Aggregation -aggregate-local: install +aggregate-local: @echo "Aggregating from local repositories (relative paths)..." python3 src/aggregate.py --config repos-config.local.json -aggregate: install +aggregate: @echo "Aggregating documentation from locked source repositories..." python3 src/aggregate.py -aggregate-update: install +aggregate-update: @echo "Aggregating documentation from latest source repositories..." python3 src/aggregate.py --update-locks -aggregate-repo: install +aggregate-repo: @if [ -z "$(REPO)" ]; then \ echo "Error: REPO variable not set"; \ echo "Usage: make aggregate-repo REPO=gardenlinux"; \ @@ -96,7 +96,7 @@ aggregate-repo: install @echo "Aggregating documentation for locked repository: $(REPO)" python3 src/aggregate.py --repo $(REPO) -aggregate-update-repo: install +aggregate-update-repo: @if [ -z "$(REPO)" ]; then \ echo "Error: REPO variable not set"; \ echo "Usage: make aggregate-update-repo REPO=gardenlinux"; \ diff --git a/docs/index.md b/docs/index.md index dd9b2e1..2606868 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ hero: link: /tutorials - theme: alt text: Releases - link: /reference/releases/ + link: /reference/releases/maintained-releases image: src: /gardenlinux-logo.svg alt: Garden Linux Logo @@ -50,4 +50,9 @@ features: - title: Releases details: Overview which Garden Linux Releases are available link: /reference/releases/ + +migration_status: "adapt" +migration_issue: https://github.com/gardenlinux/gardenlinux/issues/4622 +migration_stakeholder: "@tmang0ld, @yeoldegrove, @ByteOtter" +migration_approved: false --- diff --git a/docs/overview/index.md b/docs/overview/index.md index 6c3cae5..14680a1 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -2,6 +2,10 @@ title: "Overview" description: "How Garden Linux documentation is organized" order: 1 +migration_status: "adapt" +migration_issue: https://github.com/gardenlinux/gardenlinux/issues/4622 +migration_stakeholder: "@tmang0ld, @yeoldegrove, @ByteOtter" +migration_approved: false --- # Garden Linux @@ -24,14 +28,13 @@ Garden Linux documentation uses the [Diátaxis framework](https://diataxis.fr/) ## Where to Start -| Your Situation | Where to Go | -| ----------------------------- | ------------------------------------------------------------ | -| New to Garden Linux | Start with [Tutorials](/tutorials/) | -| Deploy on a specific platform | Go to [Platform-Specific Guides](/how-to/platform-specific/) | -| Customize Garden Linux | Check [Customization Guides](/how-to/customization/) | -| Understand concepts | Read [Explanation](/explanation/) | -| Look up specifications | Search [Reference](/reference/) | -| Contribute to the project | See [Contributing](/contributing/) | +| Your Situation | Where to Go | +| ----------------------------- | ------------------------------------------------------- | +| New to Garden Linux | Start with [Tutorials](/tutorials/) | +| Deploy on a specific platform | Go to [Platform-Specific Guides](/how-to/installation/) | +| Understand concepts | Read [Explanation](/explanation/) | +| Look up specifications | Search [Reference](/reference/) | +| Contribute to the project | See [Contributing](/contributing/) | ## Tutorials @@ -47,7 +50,7 @@ Task-oriented directions for solving specific problems. These guides assume some **Start here**: [How-to Guides](/how-to/) -Topics include [getting images](/how-to/getting-images), [choosing flavors](/how-to/choosing-flavors), [initial configuration](/how-to/initial-configuration), [building images](/how-to/building-images), [testing images](/how-to/testing-images), [platform-specific deployment](/how-to/platform-specific/), [security hardening](/how-to/security/), and [customization](/how-to/customization/). +Topics include [getting images](/how-to/getting-images), [choosing flavors](/how-to/choosing-flavors), [building images](/how-to/building-images), [platform-specific deployment](/how-to/installation/). ## Explanation @@ -55,7 +58,7 @@ Understanding-oriented articles that clarify concepts, provide background, and e **Start here**: [Explanation](/explanation/) -Topics include [use cases](/explanation/use-cases), [flavors and features](/explanation/flavors-and-features), [image types](/explanation/image-types), [architecture](/explanation/architecture), [security posture](/explanation/security-posture), [release cadence](/explanation/release-cadence), and [design decisions](/explanation/design-decisions). +Topics include [use cases](/explanation/use-cases), [flavors and features](/explanation/flavors-and-features), [architecture](/explanation/architecture), [security posture](/explanation/security-posture), and [design decisions](/explanation/design-decisions). ## Reference @@ -63,7 +66,7 @@ Information-oriented technical descriptions, specifications, and lookup tables f **Start here**: [Reference](/reference/) -Includes the [flavor matrix](/reference/flavor-matrix), [glossary](/reference/glossary), [platform compatibility](/reference/platform-compatibility), [image formats](/reference/image-formats), [kernel](/reference/kernel), [release information](/reference/releases/), Architecture Decision Records (ADRs) in the [ADR catalog](/reference/adr/), and [supporting tools documentation](/reference/supporting_tools/) (builder, Python Garden Linux library). +Includes the [flavor matrix](/reference/flavor-matrix), [glossary](/reference/glossary), [kernel](/reference/kernel), [release information](/reference/releases/), Architecture Decision Records (ADRs) in the [ADR catalog](/reference/adr/), and [supporting tools documentation](/reference/supporting_tools/) (builder, Python Garden Linux library). ## Contributing diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index 13ee21a..4c39841 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -23,11 +23,11 @@ The processor architecture for which a Garden Linux image is built. Supported ar ### 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/platform-specific/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/platform-specific/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,7 +35,7 @@ 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/platform-specific/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 @@ -43,7 +43,7 @@ The [gardenlinux/builder](https://github.com/gardenlinux/builder) component that ### Build Flavor String -The hyphenated string used with the `./build` command that specifies the platform, features, and optionally the architecture for a Garden Linux image. Format: `${platform}-${feature1}-${feature2}-${arch}`. Examples: `kvm-python_dev`, `aws-gardener_prod-amd64`. See [Building Flavors guide](../how-to/customization/building-flavors.md) for detailed instructions. +The hyphenated string used with the `./build` command that specifies the platform, features, and optionally the architecture for a Garden Linux image. Format: `${platform}-${feature1}-${feature2}-${arch}`. Examples: `kvm-python_dev`, `aws-gardener_prod-amd64`. --- @@ -55,11 +55,11 @@ A framework providing security configuration benchmarks. Garden Linux offers opt ### Cloud Image -A Garden Linux image optimized for cloud platforms (AWS, Azure, GCP, etc.) with cloud-init support and platform-specific configurations. See [Image Types documentation](../explanation/image-types.md) and [Image Formats reference](./image-formats.md) for more details. +A Garden Linux image optimized for cloud platforms (AWS, Azure, GCP, etc.) with cloud-init support and platform-specific configurations. ### Container Image -A Garden Linux image packaged for use with container runtimes. Available through GitHub Packages at `ghcr.io/gardenlinux/gardenlinux`. See [Image Types documentation](../explanation/image-types.md) for more details. +A Garden Linux image packaged for use with container runtimes. Available through GitHub Packages at `ghcr.io/gardenlinux/gardenlinux`. --- @@ -123,11 +123,11 @@ A Debian GNU/Linux derivative designed to provide small, auditable Linux images ### Gardener -[Gardener](https://gardener.cloud/) is a Kubernetes-based platform for managing clusters across multiple cloud providers. Garden Linux is the recommended operating system for Gardener worker nodes through the [`gardener`](https://github.com/gardenlinux/gardenlinux/blob/main/features/gardener/README.md) feature. See [Gardener platform guide](../how-to/platform-specific/gardener.md) for integration details. +[Gardener](https://gardener.cloud/) is a Kubernetes-based platform for managing clusters across multiple cloud providers. Garden Linux is the recommended operating system for Gardener worker nodes through the [`gardener`](https://github.com/gardenlinux/gardenlinux/blob/main/features/gardener/README.md) feature. ### 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/platform-specific/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 @@ -149,10 +149,6 @@ Garden Linux uses Go for various tools and components. See [ADR-0004](./adr/0004 ## I -### Image Type - -The format and target deployment method for a Garden Linux image, such as cloud images, container images, virtual machine images, or bare-metal images. See [Image Types documentation](../explanation/image-types.md) and [Image Formats reference](./image-formats.md) for detailed information. - ### Immutable Refers to the optional immutable image feature where the root filesystem is read-only to prevent modifications and ensure system integrity. @@ -215,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/platform-specific/oci.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/oci.md) for usage details. ### OpenSSL @@ -267,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/security/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/repos-config.json b/repos-config.json index c9fbf9d..d1e62f2 100644 --- a/repos-config.json +++ b/repos-config.json @@ -6,7 +6,7 @@ "docs_path": "docs", "target_path": "projects/gardenlinux", "ref": "docs-ng", - "commit": "235ee3265e3d7363146769f07b1fab14586eb2aa", + "commit": "7615fe00399f8bb8a6d5b7c36d6a8023747420fa", "root_files": [ "CONTRIBUTING.md", "SECURITY.md", @@ -33,7 +33,7 @@ "docs_path": "docs", "target_path": "projects/builder", "ref": "docs-ng", - "commit": "6691070742e1550dff42e00b7834df5fd4e3f832", + "commit": "ff29b1c4a5abddf855e6b4b7e14bf985a790779e", "media_directories": [ ".media", "assets", @@ -60,7 +60,7 @@ "docs_path": "docs", "target_path": "projects/package-linux", "ref": "docs-ng", - "commit": "841139441357a222ea10349f6d09a875ce9732d1", + "commit": "413b12c2a253f576983b2bc165b98b42044d8ffc", "media_directories": [ ".media", "assets", @@ -73,7 +73,7 @@ "docs_path": "docs", "target_path": "projects/glrd", "ref": "docs-ng", - "commit": "c444721b728c0be0de2c19a0bc328928a0091d65", + "commit": "b855783938aad5cf3238fef9b5dc12190e0b7207", "media_directories": [ ".media", "assets",