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
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ pa11y: pa11y-install html
find $(BUILDDIR) -name *.html -print0 | xargs -n 1 -0 $(PA11Y)

lint-md: pymarkdownlnt-install
@. $(VENV); pymarkdownlnt --config $(SPHINXDIR)/.pymarkdown.json scan --recurse --exclude=./$(SPHINXDIR)/** $(SOURCEDIR)
@. $(VENV); pymarkdownlnt --config $(SPHINXDIR)/.pymarkdown.json scan --recurse --exclude=$(SPHINXDIR) $(SOURCEDIR)

vale-install: install
@. $(VENV); test -f $(VALE_CONFIG) || python3 $(SPHINXDIR)/get_vale_conf.py
Expand Down
46 changes: 17 additions & 29 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,43 +19,31 @@ This documentation serves developers, partners, and others working with Ubuntu
kernels, offering guidance on kernel workflows, tools, SRU timelines, and
processes for customization and maintenance.

---------

## In this documentation

````{grid} 1 1 2 2

```{grid-item-card} [Tutorials](index)

**Start here**: a hands-on introduction to Ubuntu Linux kernel development for
new users
```
% DOMAINS OF CONCERN

```{grid-item-card} [How-to guides](/how-to/index)
```{list-table}
:widths: 25 75
:header-rows: 0

**Step-by-step guides** covering common tasks involved in kernel development.
* - **Contributing to Ubuntu kernels**
- {doc}`/reference/patch-acceptance-criteria` • {doc}`/reference/stable-patch-format` • {doc}`/how-to/source-code/send-patches`
* - **Kernel development**
- {doc}`/how-to/source-code/enable-source-repositories` • {doc}`/how-to/source-code/obtain-kernel-source-git` • {doc}`/how-to/develop-customise/build-kernel` • {doc}`/how-to/develop-customise/build-kernel-snap` • {doc}`/how-to/testing-verification/test-kernel-in-proposed` • {doc}`/explanation/ubuntu-linux-kernel-sources`
* - **Kernel variants**
- {doc}`/explanation/stable-release-updates` • {doc}`/explanation/post-release-updates` • {doc}`/reference/hwe-kernels` • {doc}`/reference/oem-kernels` • {doc}`/reference/ubuntu-kernels/`
* - **Upload rights**
- {doc}`/reference/kernel-upload-rights` • {doc}`/reference/dkms-upload-rights`
```

````

````{grid} 1 1 2 2
:reverse:

```{grid-item-card} [Reference](/reference/index)

**Reference information** about submitting patches and their criteria, and
other processes related to Ubuntu kernels.
```

```{grid-item-card} [Explanation](/explanation/index)

**Discussion and clarification** about different aspects of the Ubuntu kernel
and kernel development process at Canonical.
```
## How this documentation is organized

````
This documentation uses the [Diátaxis documentation structure](https://diataxis.fr/).

---------
* {doc}`/how-to/index` assumes you have basic familiarity with kernel development and provide generic instructions for common tasks involved in kernel development.
* {doc}`/reference/index` provides detailed information about submitting patches and their criteria, and other processes related to Ubuntu kernels.
* {doc}`explanation/index` discusses the different aspects of the Ubuntu kernel and kernel development process at Canonical.

## Project and community

Expand Down
Loading