-
Notifications
You must be signed in to change notification settings - Fork 10
docs: Updating homepage to new model for 26.04 #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
b66d886
updating introduction
asanvaq 7c5bd63
added how this docs are organized section
asanvaq 89ff344
updated Project and community section
asanvaq 04f60a3
updated in this docs section
asanvaq 6ee95f6
format change
asanvaq 027e306
link update
asanvaq 7321fff
bold section titles
asanvaq 24a7d6b
adding section break lines
asanvaq 9530aec
Merge branch 'main' into updating-homepage
asanvaq 9ebdab7
Removing support link
asanvaq e8a39f3
Merge branch 'updating-homepage' of github.com:asanvaq/chisel-docs in…
asanvaq 790b834
Removing reference of containers in intro sentence
asanvaq 875d969
Improving security wording
asanvaq eef8cd0
Adding chisel-releases to proj. and community section
asanvaq ef20066
Rewording in this documentation section
asanvaq 1120d90
Rewording introductory section
asanvaq 28b0d4f
Spelling correcction and Project and community rewording
asanvaq ca7db96
Rewording of using chisel
asanvaq 71e0e1f
using relative refs
asanvaq 5c487c1
Update of community statement
asanvaq bc2134e
Removing security statement
asanvaq 5b994d3
Updating the "in this documentation" section
asanvaq 8cd441a
Moving diataxis statement to the bottom
asanvaq 34d7462
Updated terminology to users
asanvaq d9555d4
Merge branch 'main' into updating-homepage
asanvaq File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,71 @@ | ||
| # Chisel | ||
|
|
||
| **Chisel** is a tool for carving and cutting Ubuntu packages. | ||
| **Chisel** is a developer tool for extracting highly customized and specialized ({{package_slices}}) of Ubuntu packages to create | ||
| compact, secure software. | ||
|
|
||
| It is built on the idea of {{package_slices}} - minimal, complementary, and | ||
| loosely coupled sets of files, based on the package's metadata and content. | ||
| Slices are basically logical subsets of the Ubuntu packages, with their own | ||
| content and set of dependencies to other internal and external slices. | ||
|
|
||
| Chisel is able to extract a highly customised and specialised _Slice_ of the | ||
| Ubuntu distribution, which one could see as a block of stone from which we can | ||
| carve and extract the small and relevant parts we need to run our applications. | ||
|
|
||
| It operates similarly to a package manager, but for package slices, thus being | ||
| particularly useful for supporting developers in the creation of smaller but | ||
| equally functional container images. | ||
| Users need to be able to create software suited to their specific needs with a reduced attack | ||
| surface and a small storage footprint. With Chisel, users build a minimal root filesystem by | ||
asanvaq marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| selecting and installing only the necessary slices from the full Ubuntu package set. | ||
|
|
||
| --------- | ||
|
|
||
| ## In this documentation | ||
|
|
||
| ````{grid} 1 1 2 2 | ||
| * **Tutorial**: [Hands-on introduction to Chisel in 15 minutes](tutorial/getting-started) | ||
|
|
||
| * **Common patterns**: [Install Chisel](how-to/install-chisel) • | ||
| [Slice a package](how-to/slice-a-package/) • | ||
| [Use Chisel in a Dockerfile](how-to/use-chisel-in-dockerfile) • | ||
| [Explore the Chisel CLI](reference/cmd/index) | ||
|
|
||
| * **Slices**: [Learn more about slices](explanation/slices) • | ||
| [Chisel releases](reference/chisel-releases/index) • | ||
| [chisel.yaml](reference/chisel-releases/chisel.yaml) • | ||
| [Slice definitions](reference/chisel-releases/slice-definitions) • | ||
| [Install Ubuntu Pro package slices](how-to/install-pro-package-slices) | ||
|
|
||
| ```{grid-item-card} [Tutorial](tutorial/getting-started) | ||
| --------- | ||
|
|
||
| **Get started** - become familiar with Chisel by slicing Ubuntu packages to create | ||
| a minimal root file system. | ||
| ``` | ||
| ## How this documentation is organized | ||
|
|
||
| ```{grid-item-card} [How-to guides](how-to/index) | ||
| - The [Tutorial](tutorial/getting-started) takes you step-by-step | ||
| through the creation of your first chiseled Ubuntu root file system, from installation to the slicing of Ubuntu | ||
| packages. | ||
| - [How-to guides](how-to/index) assume you have basic familiarity with | ||
| Chisel. They cover tasks such as installation, slicing and usage of Chisel. | ||
| - [Reference](reference/index) provides a guide to CLI commands, | ||
| chisel-releases and security details. | ||
| - [Explanation](explanation/index) includes topic overviews, background | ||
| and context and detailed discussion. | ||
|
|
||
| **Step-by-step guides** - learn key operations and common tasks. | ||
| ``` | ||
| --------- | ||
|
|
||
| ```` | ||
| ## Project and community | ||
|
|
||
| ````{grid} 1 1 2 2 | ||
| :reverse: | ||
| 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/). | ||
|
|
||
| ```{grid-item-card} [Reference](reference/index) | ||
| ### Get involved | ||
|
|
||
| **Technical information** - understand the CLI commands, slice definitions files | ||
| and Chisel manifests. | ||
| ``` | ||
| * <a href="https://matrix.to/#/#chisel:ubuntu.com">Online chat</a> | ||
asanvaq marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * [Contribute](https://github.com/canonical/chisel) | ||
|
|
||
| ### Releases | ||
|
|
||
| ```{grid-item-card} [Explanations](explanation/index) | ||
| * [Release notes](https://github.com/canonical/chisel/releases) | ||
| * [chisel-releases](https://github.com/canonical/chisel-releases) | ||
|
|
||
| ### Governance and policies | ||
|
|
||
| **Discussion and clarification** - explore Chisel's mode of operation and learn | ||
| about fundamental topics such as package slices. | ||
| ``` | ||
| * [Code of conduct](https://ubuntu.com/community/docs/ethos/code-of-conduct) | ||
| * [Security policy](https://github.com/canonical/chisel/blob/main/SECURITY.md) | ||
|
|
||
| ### Commercial support | ||
|
|
||
| ```` | ||
| Thinking about using Chisel for your next project? <a href="https://canonical.com/#get-in-touch#">Get in touch!</a> | ||
|
|
||
| --------- | ||
|
|
||
| ## Project and community | ||
|
|
||
| Chisel is free software and released under {{AGPL3}}. | ||
|
|
||
| The Chisel project is sponsored by {{Canonical}}. | ||
|
|
||
| - [Code of conduct](https://ubuntu.com/community/ethos/code-of-conduct) | ||
| - [Contribute](https://github.com/canonical/chisel) | ||
| - [Security policy](https://github.com/canonical/chisel/blob/main/SECURITY.md) | ||
|
|
||
| This documentation uses the [Diátaxis documentation structure](https://diataxis.fr/). | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for being willing to try this out. This looks good enough for now. But I'd like to find a better place for it still. Just continue discussing the following on the side:
|
||
|
|
||
| ```{toctree} | ||
| :hidden: | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I won't block the PR on this, cause it's quite nuanced, but just food for thought: in the line above, Chisel is depicted as a "developer tool". The conotation is different, which doesn't make the use of "Users" wrong here (IMO), but worth noting, just in case you have a different interpretation