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
6 changes: 6 additions & 0 deletions docs/explanation/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "The explanatory documentation for Chisel. These explanations aid in understanding the core concepts of Chisel."
---

# Explanation

This section of the documentation covers the core concepts of Chisel.
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/mode-of-operation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Explanation of how Chisel works: reading chisel-releases, fetching packages from Ubuntu archives, and extracting selected files into a root file system."
---

(chisel_mo_explanation)=

# How Chisel works
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/slice-design-approaches.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Explanation of the two slice design approaches in Chisel: grouping by content type (bins, libs) or by functionality (minimal, core, standard)."
---

(slice_design_approaches)=

# Slice design approaches
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/slices.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Explanation of package slices in Chisel: subsets of Debian packages with their own files and dependencies, used to build minimal Ubuntu root file systems."
---

(slices_explanation)=

# Slices
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "The practical, goal-oriented documentation for Chisel. These guides provide directions for completing tasks and solving problems with Chisel."
---

(how_to_guides)=

# How-to guides
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/install-chisel.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "How to install Chisel on Linux by downloading the pre-built binary, building from source, or installing the Snap package."
---

(install_chisel)=

# How to install Chisel
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/install-pro-package-slices.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "How to configure Chisel to fetch and install Ubuntu Pro package slices, including archive definitions and credentials setup."
---

(install_pro_packages)=

# Install Ubuntu Pro package slices
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/slice-a-package.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "How to slice an Ubuntu package with Chisel by inspecting its contents, designing slices, and writing and testing a slice definitions file."
---

(slice_package)=

# Slice a package
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/use-chisel-in-dockerfile.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "How to use Chisel in a multi-stage Dockerfile to build a minimal, distroless-like container image from Ubuntu package slices."
---

(use_chisel_dockerfile)=

# Use Chisel in a Dockerfile
Expand Down
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Chisel is a tool for creating minimal Ubuntu root file systems by selecting and installing only the necessary package slices."
---

# Chisel

**Chisel** is a developer tool for extracting highly customized and specialized [package slices](slices_explanation) of Ubuntu packages to create
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/chisel-releases/chisel.yaml.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the chisel.yaml configuration file, covering format versions, archive definitions, maintenance, public keys, and Ubuntu Pro settings."
---

(chisel_yaml_ref)=

# chisel.yaml
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/chisel-releases/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for chisel-releases, the versioned directory of slice definitions files and chisel.yaml that Chisel uses to identify and fetch package slices."
---

(chisel-releases_ref)=

# chisel-releases
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/chisel-releases/slice-definitions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the slice definitions file format for Ubuntu package slices, covering the location, format specifications and examples."
---

(slice_definitions_ref)=

# Slice definitions
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/cmd/cut.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the Chisel cut command, which slices Ubuntu packages and installs selected package slices into a root file system directory."
---

(cut_command_reference)=

# cut command
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/cmd/find.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the Chisel find command, which searches chisel-releases for available package slices matching a name pattern."
---

(find_command_reference)=

# find command
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/cmd/help.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the Chisel help command, which displays usage information and a summary of available subcommands."
---

(help_command_reference)=

# help command
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/cmd/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the Chisel command-line interface, covering the cut, find, info, version, and help subcommands with their options and usage."
---

(command_reference)=

# CLI Commands
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/cmd/info.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the Chisel info command, which displays slice definitions for given package or slice names from a chisel-release in YAML format."
---

(info_command_reference)=

# info command
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/cmd/version.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the Chisel version command, which prints the currently installed Chisel version string to standard output and exits."
---

(version_command_reference)=

# version command
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "The reference documentation for Chisel. These references describe the structure and function of the individual components in Chisel."
---

# Reference

This section provides concise references on available commands, package slices, and security.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/manifest.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for the Chisel manifest: a ZSTD-compressed jsonwall file listing metadata about installed packages, slices, and files in a root file system."
---

(chisel_manifest_ref)=

# Chisel Manifest
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/security.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference for Chisel's cryptographic verification process, including GPG signature checks and checksum validation."
---

(chisel_security_ref)=

# Chisel Cryptographic Documentation
Expand Down
6 changes: 6 additions & 0 deletions docs/tutorial/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Learn how to create a chiseled Ubuntu root file system from scratch, from installing Chisel to slicing Ubuntu packages in 15 minutes."
---

(chisel_helloworld_tutorial)=

# Getting started with Chisel
Expand Down
Loading