Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { defineConfig } from "vitepress";
import { generateDocumentationSidebar } from "./sidebar.js";
import { readdir, readFile } from "fs/promises";
import { join } from "path";
import matter from "gray-matter";
import { join } from "path";
import { defineConfig } from "vitepress";
import { generateDocumentationSidebar } from "./sidebar.js";

// Get base URL from environment variable (for GitHub Pages deployment)
const base = process.env.BASE_URL || "/";
Expand Down Expand Up @@ -140,8 +140,8 @@ export default defineConfig({
text: "Documentation",
items: [
{
text: "Overview",
link: "/overview/",
text: "Introduction",
link: "/introduction/",
},
{
text: "Tutorials",
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ hero:
actions:
- theme: brand
text: Start Here
link: /overview/
link: /introduction/
- theme: alt
text: First Boot
link: /tutorials
Expand All @@ -24,7 +24,7 @@ features:
### # use cases
### - title: Container Runtime
### details: The preferred Kubernetes worker node for 90% of cloud applications deployed with Gardener
### link: /overview/
### link: /introduction/
### - title: Container Base Images
### details: Package applications according to the OCI specification
### link: /how-to/container-base-image
Expand Down
68 changes: 50 additions & 18 deletions docs/overview/index.md → docs/introduction/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Overview"
title: "Introduction"
description: "How Garden Linux documentation is organized"
order: 1
migration_status: "adapt"
Expand All @@ -12,19 +12,26 @@ migration_approved: false

## Mission Statement

Garden Linux (GL) is a Debian Linux derivative built with three main goals: fully open source, ease-of-use & purpose-optimized!
Garden Linux (GL) is a Debian Linux derivative built with three main goals:
fully open source, ease-of-use & purpose-optimized!

It is **not** a general-purpose Operating System targeting all possible use-cases & scenarios.
It is **not** a general-purpose Operating System targeting all possible
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 to the OCI specification
- **Virtual machine hypervisor host** — OS used to deploy hypervisor nodes to run Kubernetes nodes
- **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
to the OCI specification
- **Virtual machine hypervisor host** — OS used to deploy hypervisor nodes to
run Kubernetes nodes

## Documentation Overview

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.
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.

## Where to Start

Expand All @@ -38,49 +45,74 @@ Garden Linux documentation uses the [Diátaxis framework](https://diataxis.fr/)

## Tutorials

Learning-oriented guides that walk you through complete workflows. Tutorials assume no prior experience, provide complete commands, and take 15--30 minutes to complete.
Learning-oriented guides that walk you through complete workflows. Tutorials
assume no prior experience, provide complete commands, and take 15--30 minutes
to complete.

**Start here**: [Tutorials](/tutorials/)

Tutorials cover local environments (Kernel-based Virtual Machine (KVM), Lima), cloud platforms (Amazon Web Services (AWS), Microsoft Azure, Google Cloud Platform (GCP), OpenStack), containers (Open Container Initiative (OCI) Image Format), and bare-metal deployments.
Tutorials cover local environments (Kernel-based Virtual Machine (KVM), Lima),
cloud platforms (Amazon Web Services (AWS), Microsoft Azure, Google Cloud
Platform (GCP), OpenStack), containers (Open Container Initiative (OCI) Image
Format), and bare-metal deployments.

## How-to Guides

Task-oriented directions for solving specific problems. These guides assume some familiarity with Garden Linux and focus on practical solutions.
Task-oriented directions for solving specific problems. These guides assume some
familiarity with Garden Linux and focus on practical solutions.

**Start here**: [How-to Guides](/how-to/)

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/).
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

Understanding-oriented articles that clarify concepts, provide background, and explain how Garden Linux works.
Understanding-oriented articles that clarify concepts, provide background, and
explain how Garden Linux works.

**Start here**: [Explanation](/explanation/)

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).
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

Information-oriented technical descriptions, specifications, and lookup tables for precise technical details.
Information-oriented technical descriptions, specifications, and lookup tables
for precise technical details.

**Start here**: [Reference](/reference/)

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).
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

Guidelines for contributing to Garden Linux, whether you are fixing a bug, adding a feature, or improving documentation.
Guidelines for contributing to Garden Linux, whether you are fixing a bug,
adding a feature, or improving documentation.

**Start here**: [Contributing](/contributing/)

Covers the documentation guide, development [workflow](/contributing/workflow), [security](/contributing/security) practices, and [testing](/contributing/testing/) (developing tests, running tests, test coverage).
Covers the documentation guide, development [workflow](/contributing/workflow),
[security](/contributing/security) practices, and
[testing](/contributing/testing/) (developing tests, running tests, test
coverage).

## Getting Help

If you cannot find what you need:

1. Use the search feature in the top navigation
1. Check the [Troubleshooting](/how-to/troubleshooting/) guide
1. Visit the [Garden Linux GitHub repository](https://github.com/gardenlinux/gardenlinux)
1. Visit the
[Garden Linux GitHub repository](https://github.com/gardenlinux/gardenlinux)
1. Open an issue or discussion on GitHub
Loading