Skip to content

Commit 7376e62

Browse files
committed
feat: rework mission statement
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
1 parent 15c6b72 commit 7376e62

3 files changed

Lines changed: 59 additions & 17 deletions

File tree

‎docs/index.md‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ layout: home
44

55
hero:
66
name: "Garden Linux"
7-
text: "the best Linux for Gardener nodes"
8-
tagline: "small, auditable Linux images for cloud and bare-metal workloads"
7+
text: "Purpose-built Linux for cloud-native workloads"
8+
tagline: "Debian-based, fully open source, and optimized for Kubernetes and containers"
99
actions:
1010
- theme: brand
11-
text: First Boot Tutorial
12-
link: /tutorials/
13-
- theme: alt
14-
text: Browse Documentation
11+
text: Start Here
1512
link: /overview/
13+
- theme: alt
14+
text: First Boot
15+
link: /tutorials
1616
- theme: alt
1717
text: Releases
1818
link: /reference/releases/
@@ -21,6 +21,17 @@ hero:
2121
alt: Garden Linux Logo
2222

2323
features:
24+
### # use cases
25+
### - title: Container Runtime
26+
### details: The preferred Kubernetes worker node for 90% of cloud applications deployed with Gardener
27+
### link: /overview/
28+
### - title: Container Base Images
29+
### details: Package applications according to the OCI specification
30+
### link: /how-to/container-base-image
31+
### - title: Virtual Machine Host
32+
### details: OS for deploying hypervisor nodes to run Kubernetes nodes
33+
### link: /tutorials/
34+
# documentation
2435
- title: Tutorials
2536
details: Step-by-step walkthroughs to get you started with Garden Linux
2637
link: /tutorials/
@@ -37,9 +48,6 @@ features:
3748
details: Guides for contributing to Garden Linux documentation and development
3849
link: /contributing/
3950
- title: Releases
40-
details: Overiew which Graden Linux Releases are available
51+
details: Overview which Garden Linux Releases are available
4152
link: /reference/releases/
42-
# - title: Legacy Documentation
43-
# details: Aggregated documentation from source repositories (being migrated)
44-
# link: /projects/gardenlinux/introduction/index
4553
---

‎docs/overview/index.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,21 @@ description: "How Garden Linux documentation is organized"
44
order: 1
55
---
66

7-
# Documentation Overview
7+
# Garden Linux
8+
9+
## Mission Statement
10+
11+
Garden Linux (GL) is a Debian Linux derivative built with three main goals: fully open source, ease-of-use & purpose-optimized!
12+
13+
It is **not** a general-purpose Operating System targeting all possible use-cases & scenarios.
14+
15+
Instead, it is built to serve as:
16+
17+
- **Container runtime** — The preferred Kubernetes worker node for 90% of the cloud applications deployed with Gardener
18+
- **Container base images** — Our solution for packaging applications according to the OCI specification
19+
- **Virtual machine hypervisor host** — OS used to deploy hypervisor nodes to run Kubernetes nodes
20+
21+
## Documentation Overview
822

923
Garden Linux documentation uses the [Diátaxis framework](https://diataxis.fr/) to organize content by what you need, not by your role. This page explains the structure and helps you find the right section.
1024

‎repos-config.json‎

Lines changed: 26 additions & 6 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": "4c1d90299cef6cd9db3e800cdd9668949dc8ebec",
9+
"commit": "235ee3265e3d7363146769f07b1fab14586eb2aa",
1010
"root_files": [
1111
"CONTRIBUTING.md",
1212
"SECURITY.md",
@@ -21,7 +21,11 @@
2121
"reference": "reference",
2222
"contributing": "contributing"
2323
},
24-
"media_directories": [".media", "assets", "_static"]
24+
"media_directories": [
25+
".media",
26+
"assets",
27+
"_static"
28+
]
2529
},
2630
{
2731
"name": "builder",
@@ -30,7 +34,11 @@
3034
"target_path": "projects/builder",
3135
"ref": "docs-ng",
3236
"commit": "086e74ff032c5f2a05989aef4f20ba69f94bdbf9",
33-
"media_directories": [".media", "assets", "_static"]
37+
"media_directories": [
38+
".media",
39+
"assets",
40+
"_static"
41+
]
3442
},
3543
{
3644
"name": "python-gardenlinux-lib",
@@ -40,7 +48,11 @@
4048
"ref": "docs-ng",
4149
"commit": "9142fccc3d83ab51759db7d328fa19166bc1df63",
4250
"structure": "sphinx",
43-
"media_directories": [".media", "assets", "_static"]
51+
"media_directories": [
52+
".media",
53+
"assets",
54+
"_static"
55+
]
4456
},
4557
{
4658
"name": "package-linux",
@@ -49,7 +61,11 @@
4961
"target_path": "projects/package-linux",
5062
"ref": "docs-ng",
5163
"commit": "841139441357a222ea10349f6d09a875ce9732d1",
52-
"media_directories": [".media", "assets", "_static"]
64+
"media_directories": [
65+
".media",
66+
"assets",
67+
"_static"
68+
]
5369
},
5470
{
5571
"name": "glrd",
@@ -58,7 +74,11 @@
5874
"target_path": "projects/glrd",
5975
"ref": "docs-ng",
6076
"commit": "c444721b728c0be0de2c19a0bc328928a0091d65",
61-
"media_directories": [".media", "assets", "_static"]
77+
"media_directories": [
78+
".media",
79+
"assets",
80+
"_static"
81+
]
6282
}
6383
]
6484
}

0 commit comments

Comments
 (0)