From 8507c374a967e74923388d8156ae35019305fe0e Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Wed, 22 Apr 2026 16:29:13 +0200 Subject: [PATCH] docs: add use cases documentation (includes links to flavor matrix) Signed-off-by: Eike Waldt On-behalf-of: SAP --- docs/introduction/index.md | 9 ++++----- repos-config.json | 4 ++-- src/aggregation/flavor_matrix.py | 9 +++++++-- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/introduction/index.md b/docs/introduction/index.md index 540828a..1290ab8 100644 --- a/docs/introduction/index.md +++ b/docs/introduction/index.md @@ -20,12 +20,10 @@ use-cases & scenarios. Instead, it is built to serve as: -- **Container runtime** — The preferred Kubernetes worker node for 90% of the - cloud applications deployed with Gardener -- **Container base images** — Our solution for packaging applications according +- **Container runtime for [Gardener](/explanation/use-cases#gardener-kubernetes-nodes) or [vanilla Kubernetes](/explanation/use-cases#vanilla-kubernetes-nodes)** — The preferred Kubernetes worker node for 90% of the cloud applications deployed with Gardener +- **[Container base images](/explanation/use-cases#container-base-images)** — Our solution for packaging applications according to the OCI specification -- **Virtual machine hypervisor host** — OS used to deploy hypervisor nodes to - run Kubernetes nodes +- **[Virtualization host](/explanation/use-cases#virtualization-host)** — OS used to deploy hypervisor nodes to run Kubernetes nodes ## Documentation Overview @@ -38,6 +36,7 @@ structure and helps you find the right section. | Your Situation | Where to Go | | ----------------------------- | ------------------------------------------------------- | | New to Garden Linux | Start with [Tutorials](/tutorials/) | +| Use Cases | Get to know [Use Cases](/explanation/use-cases) | | Deploy on a specific platform | Go to [Platform-Specific Guides](/how-to/installation/) | | Understand concepts | Read [Explanation](/explanation/) | | Look up specifications | Search [Reference](/reference/) | diff --git a/repos-config.json b/repos-config.json index 1e976fa..af82a7f 100644 --- a/repos-config.json +++ b/repos-config.json @@ -6,7 +6,7 @@ "docs_path": "docs", "target_path": "projects/gardenlinux", "ref": "docs-ng", - "commit": "fed8c3a16f78e2de04c3aa3b69c97d7704fc19c0", + "commit": "a27f522ddddc5c2f61dbec6e5bc831a713fe076c", "root_files": [ "CONTRIBUTING.md", "SECURITY.md", @@ -60,7 +60,7 @@ "docs_path": "docs", "target_path": "projects/package-linux", "ref": "docs-ng", - "commit": "413b12c2a253f576983b2bc165b98b42044d8ffc", + "commit": "efd3f4ec64b01d5b7b76fd0e51ace99d4b9fc582", "media_directories": [ ".media", "assets", diff --git a/src/aggregation/flavor_matrix.py b/src/aggregation/flavor_matrix.py index 45d678a..187e0d0 100644 --- a/src/aggregation/flavor_matrix.py +++ b/src/aggregation/flavor_matrix.py @@ -111,8 +111,12 @@ def link(feature: str) -> str: for row in sorted(rows, key=lambda r: (r["flavor"], r["arch"])): explicit_links = ", ".join(link(f) for f in row["explicit"]) recursive_links = ", ".join(link(f) for f in row["recursive"]) + # Build anchor ID from the full flavor name (includes architecture) + anchor_id = f"{row['flavor']}-{row['arch']}" + # Display the flavor name without arch suffix (flavor_base) + display_name = f"`{row['flavor']}`" table_rows.append( - f"| {row['flavor']} | {row['arch']} | {explicit_links} | {recursive_links} |" + f"| {display_name} | {row['arch']} | {explicit_links} | {recursive_links} |" ) table = header + "\n" + "\n".join(table_rows) @@ -133,8 +137,9 @@ def link(feature: str) -> str: output_dir = docs_dir / "reference" output_dir.mkdir(parents=True, exist_ok=True) output_file = output_dir / "flavor-matrix.md" + output_file.write_text(content) - print(f" Created: {output_file}") + print(f" Updated: {output_file}") print("Flavor matrix generation complete.") return True