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
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/coda.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: CODA issue template
about: Applies the CODA issue structure.
title: 'CODA: short description'
labels: 'coda'
---

# Background

<!-- Expand on the title and provide clear context that helps users understand the product and the problem. -->

# Task

<!-- Include the expected steps for the completion of the issue, including the repository where the PR must be opened in and mention the requirement of signing the [Canonical contributor license agreement](https://ubuntu.com/legal/contributors). -->

# Prerequisites

<!-- This section is optional. Explicitly state if specific domain knowledge or tools are required, or if the issue is beginner-friendly. -->

# What you will learn

<!-- Briefly list what the contributor will learn from working on this issue. -->

# Outcome

<!-- Describe the expected result needed to close the issue. -->

# Resources

<!-- List URLs or references that help the contributor research and complete the task. -->

# Mentor

<!-- Add who the mentor of the issue is.

If the mentor is a TA, use: `The mentor for this issue is [GH username]. They are the Technical Author for [Product name].`

If the mentor is not a TA, modify the second sentence accordingly.

If there is no mentor for the issue, use: `This issue does not currently have a mentor. If you are interested in working on it, please leave a comment and we will assign one as soon as possible. Please check our [guidelines for contributors](https://github.com/canonical/open-documentation-academy/blob/main/CONTRIBUTING.md) in the meantime.`
Include contact information, for example: -->

Please feel free to reach out to the mentor on [Matrix](<INSERT_YOUR_MATRIX_DM_ADDRESS_HERE>) if you have further questions.
20 changes: 6 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,16 @@ Users need to be able to create software suited to their specific needs with a r
surface and a small storage footprint. With Chisel, users build a minimal root filesystem by
selecting and installing only the necessary slices from the full Ubuntu package set.

---------

## In this documentation

* **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) • [Slice design approaches](explanation/slice-design-approaches.md) •
[Install Ubuntu Pro package slices](how-to/install-pro-package-slices)
* **Getting started**: [Hands-on introduction to Chisel in 15 minutes](tutorial/getting-started) • [General installation guide](how-to/install-chisel)
* **Slices overview:** [Overview](explanation/slices) • [Chisel releases](reference/chisel-releases/index)
* **Deploying slices:** [Using Chisel in a Dockerfile](how-to/use-chisel-in-dockerfile) • [Install Ubuntu Pro package slices](how-to/install-pro-package-slices) • [Manifest](reference/manifest)
* **Creating slices:** [Slice definitions](reference/chisel-releases/slice-definitions) • [chisel.yaml](reference/chisel-releases/chisel.yaml) • [Slice design approaches](explanation/slice-design-approaches) • [Slice a package](how-to/slice-a-package)
* **Chisel CLI:** [Command reference](reference/cmd/index)
* **Security:** [Cryptographic information](reference/security)

---------

## How this documentation is organized

Expand Down
Loading