Skip to content

Commit c771605

Browse files
committed
docs: add packaging, repo, release documentation
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
1 parent 101e3f3 commit c771605

4 files changed

Lines changed: 50 additions & 8 deletions

File tree

‎docs/introduction/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ explain how Garden Linux works.
7575
**Start here**: [Explanation](/explanation/)
7676

7777
Topics include [use cases](/explanation/use-cases),
78-
[flavors and features](/explanation/flavors-and-features),
78+
[Flavors](/explanation/flavors),
7979
[architecture](/explanation/architecture),
8080
[security posture](/explanation/security-posture), and
81-
[design decisions](/explanation/design-decisions).
81+
[design decisions](/explanation/architectural-decisions).
8282

8383
## Reference
8484

‎docs/reference/glossary.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ A platform target for Garden Linux images designed to run directly on physical h
3939

4040
### Builder
4141

42-
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 and features. 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.
42+
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.
4343

4444
### Build Flavor String
4545

@@ -95,7 +95,7 @@ Refers to the [`_ephemeral`](https://github.com/gardenlinux/gardenlinux/blob/mai
9595

9696
### Feature
9797

98-
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 and Features documentation](../explanation/flavors-and-features.md) for an overview, and [ADR-0032](./adr/0032-static-feature-test-coverage-analysis.md) for details on feature test coverage analysis.
98+
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.
9999

100100
### FedRAMP
101101

@@ -111,15 +111,15 @@ A lightweight virtual machine monitor (VMM) for running microVMs. Garden Linux h
111111

112112
### Flavor
113113

114-
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 and Features documentation](../explanation/flavors-and-features.md), [Choosing Flavors guide](../how-to/choosing-flavors.md), and [Flavor Matrix reference](./flavor-matrix.md) for more details.
114+
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.
115115

116116
---
117117

118118
## G
119119

120120
### Garden Linux
121121

122-
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 [Design Decisions](../explanation/design-decisions.md), [Use Cases](../explanation/use-cases.md), and [Security Posture](../explanation/security-posture.md) for more information.
122+
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.
123123

124124
### Gardener
125125

‎repos-config.json‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"docs_path": "docs",
77
"target_path": "projects/gardenlinux",
88
"ref": "docs-ng",
9-
"commit": "a6251a94a3e75d13f3a22ce826a2760b69165b94",
9+
"commit": "7544e2f732ccd8fd5aa66a202925df575eca6247",
1010
"root_files": [
1111
"CONTRIBUTING.md",
1212
"SECURITY.md",
@@ -60,7 +60,33 @@
6060
"docs_path": "docs",
6161
"target_path": "projects/package-linux",
6262
"ref": "docs-ng",
63-
"commit": "057e2cef82be30255ed68281ffd0452cfc1cb76c",
63+
"commit": "9570d0f81eae4e1e500dd3f36ea845a2dce14357",
64+
"media_directories": [
65+
".media",
66+
"assets",
67+
"_static"
68+
]
69+
},
70+
{
71+
"name": "package-build",
72+
"url": "https://github.com/gardenlinux/package-build",
73+
"docs_path": "docs",
74+
"target_path": "projects/package-build",
75+
"ref": "docs-ng",
76+
"commit": "b4bce8b1dbb48cfedefdd866f3bc28d1c395c060",
77+
"media_directories": [
78+
".media",
79+
"assets",
80+
"_static"
81+
]
82+
},
83+
{
84+
"name": "repo",
85+
"url": "https://github.com/gardenlinux/repo",
86+
"docs_path": "docs",
87+
"target_path": "projects/repo",
88+
"ref": "docs-ng",
89+
"commit": "68666e0847c82895072e0d7673884a6490b7fe35",
6490
"media_directories": [
6591
".media",
6692
"assets",

‎repos-config.local.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,22 @@
4646
"structure": "flat",
4747
"media_directories": [".media", "assets", "_static"]
4848
},
49+
{
50+
"name": "package-build",
51+
"url": "file://../package-build",
52+
"docs_path": "docs",
53+
"target_path": "projects/package-build",
54+
"structure": "flat",
55+
"media_directories": [".media", "assets", "_static"]
56+
},
57+
{
58+
"name": "repo",
59+
"url": "file://../repo",
60+
"docs_path": "docs",
61+
"target_path": "projects/repo",
62+
"structure": "flat",
63+
"media_directories": [".media", "assets", "_static"]
64+
},
4965
{
5066
"name": "glrd",
5167
"url": "file://../glrd",

0 commit comments

Comments
 (0)