diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 091c72d..2f00732 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -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 || "/"; @@ -140,8 +140,8 @@ export default defineConfig({ text: "Documentation", items: [ { - text: "Overview", - link: "/overview/", + text: "Introduction", + link: "/introduction/", }, { text: "Tutorials", diff --git a/docs/index.md b/docs/index.md index 2606868..692d345 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ hero: actions: - theme: brand text: Start Here - link: /overview/ + link: /introduction/ - theme: alt text: First Boot link: /tutorials @@ -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 diff --git a/docs/overview/index.md b/docs/introduction/index.md similarity index 54% rename from docs/overview/index.md rename to docs/introduction/index.md index 14680a1..540828a 100644 --- a/docs/overview/index.md +++ b/docs/introduction/index.md @@ -1,5 +1,5 @@ --- -title: "Overview" +title: "Introduction" description: "How Garden Linux documentation is organized" order: 1 migration_status: "adapt" @@ -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 @@ -38,43 +45,67 @@ 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 @@ -82,5 +113,6 @@ 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