|
1 | 1 | # Chisel |
2 | 2 |
|
3 | | -**Chisel** is a tool for carving and cutting Ubuntu packages. |
| 3 | +**Chisel** is a developer tool for extracting highly customized and specialized ({{package_slices}}) of Ubuntu packages to create |
| 4 | +compact, secure software. |
4 | 5 |
|
5 | | -It is built on the idea of {{package_slices}} - minimal, complementary, and |
6 | | -loosely coupled sets of files, based on the package's metadata and content. |
7 | | -Slices are basically logical subsets of the Ubuntu packages, with their own |
8 | | -content and set of dependencies to other internal and external slices. |
9 | | - |
10 | | -Chisel is able to extract a highly customised and specialised _Slice_ of the |
11 | | -Ubuntu distribution, which one could see as a block of stone from which we can |
12 | | -carve and extract the small and relevant parts we need to run our applications. |
13 | | - |
14 | | -It operates similarly to a package manager, but for package slices, thus being |
15 | | -particularly useful for supporting developers in the creation of smaller but |
16 | | -equally functional container images. |
| 6 | +Users need to be able to create software suited to their specific needs with a reduced attack |
| 7 | +surface and a small storage footprint. With Chisel, users build a minimal root filesystem by |
| 8 | +selecting and installing only the necessary slices from the full Ubuntu package set. |
17 | 9 |
|
18 | 10 | --------- |
19 | 11 |
|
20 | 12 | ## In this documentation |
21 | 13 |
|
22 | | -````{grid} 1 1 2 2 |
| 14 | +* **Tutorial**: [Hands-on introduction to Chisel in 15 minutes](tutorial/getting-started) |
| 15 | + |
| 16 | +* **Common patterns**: [Install Chisel](how-to/install-chisel) • |
| 17 | +[Slice a package](how-to/slice-a-package/) • |
| 18 | +[Use Chisel in a Dockerfile](how-to/use-chisel-in-dockerfile) • |
| 19 | +[Explore the Chisel CLI](reference/cmd/index) |
| 20 | + |
| 21 | +* **Slices**: [Learn more about slices](explanation/slices) • |
| 22 | +[Chisel releases](reference/chisel-releases/index) • |
| 23 | +[chisel.yaml](reference/chisel-releases/chisel.yaml) • |
| 24 | +[Slice definitions](reference/chisel-releases/slice-definitions) • |
| 25 | +[Install Ubuntu Pro package slices](how-to/install-pro-package-slices) |
23 | 26 |
|
24 | | -```{grid-item-card} [Tutorial](tutorial/getting-started) |
| 27 | +--------- |
25 | 28 |
|
26 | | -**Get started** - become familiar with Chisel by slicing Ubuntu packages to create |
27 | | -a minimal root file system. |
28 | | -``` |
| 29 | +## How this documentation is organized |
29 | 30 |
|
30 | | -```{grid-item-card} [How-to guides](how-to/index) |
| 31 | +- The [Tutorial](tutorial/getting-started) takes you step-by-step |
| 32 | +through the creation of your first chiseled Ubuntu root file system, from installation to the slicing of Ubuntu |
| 33 | +packages. |
| 34 | +- [How-to guides](how-to/index) assume you have basic familiarity with |
| 35 | +Chisel. They cover tasks such as installation, slicing and usage of Chisel. |
| 36 | +- [Reference](reference/index) provides a guide to CLI commands, |
| 37 | +chisel-releases and security details. |
| 38 | +- [Explanation](explanation/index) includes topic overviews, background |
| 39 | +and context and detailed discussion. |
31 | 40 |
|
32 | | -**Step-by-step guides** - learn key operations and common tasks. |
33 | | -``` |
| 41 | +--------- |
34 | 42 |
|
35 | | -```` |
| 43 | +## Project and community |
36 | 44 |
|
37 | | -````{grid} 1 1 2 2 |
38 | | -:reverse: |
| 45 | +Chisel is a member of the Ubuntu family. It’s an open source project that warmly welcomes [community contributions](https://documentation.ubuntu.com/project/contributors/). |
39 | 46 |
|
40 | | -```{grid-item-card} [Reference](reference/index) |
| 47 | +### Get involved |
41 | 48 |
|
42 | | -**Technical information** - understand the CLI commands, slice definitions files |
43 | | -and Chisel manifests. |
44 | | -``` |
| 49 | +* <a href="https://matrix.to/#/#chisel:ubuntu.com">Online chat</a> |
| 50 | +* [Contribute](https://github.com/canonical/chisel) |
| 51 | + |
| 52 | +### Releases |
45 | 53 |
|
46 | | -```{grid-item-card} [Explanations](explanation/index) |
| 54 | +* [Release notes](https://github.com/canonical/chisel/releases) |
| 55 | +* [chisel-releases](https://github.com/canonical/chisel-releases) |
| 56 | + |
| 57 | +### Governance and policies |
47 | 58 |
|
48 | | -**Discussion and clarification** - explore Chisel's mode of operation and learn |
49 | | -about fundamental topics such as package slices. |
50 | | -``` |
| 59 | +* [Code of conduct](https://ubuntu.com/community/docs/ethos/code-of-conduct) |
| 60 | +* [Security policy](https://github.com/canonical/chisel/blob/main/SECURITY.md) |
| 61 | + |
| 62 | +### Commercial support |
51 | 63 |
|
52 | | -```` |
| 64 | +Thinking about using Chisel for your next project? <a href="https://canonical.com/#get-in-touch#">Get in touch!</a> |
53 | 65 |
|
54 | 66 | --------- |
55 | 67 |
|
56 | | -## Project and community |
57 | | - |
58 | | -Chisel is free software and released under {{AGPL3}}. |
59 | | - |
60 | | -The Chisel project is sponsored by {{Canonical}}. |
61 | | - |
62 | | -- [Code of conduct](https://ubuntu.com/community/ethos/code-of-conduct) |
63 | | -- [Contribute](https://github.com/canonical/chisel) |
64 | | -- [Security policy](https://github.com/canonical/chisel/blob/main/SECURITY.md) |
65 | | - |
| 68 | +This documentation uses the [Diátaxis documentation structure](https://diataxis.fr/). |
66 | 69 |
|
67 | 70 | ```{toctree} |
68 | 71 | :hidden: |
|
0 commit comments