Skip to content

Commit 772959d

Browse files
committed
docs: update landing pages based on exemplar
- consolidate how-tos into single section with main landing page - slight restructure with intros to each section for how-to, reference, and explanations - added redirects from consolidated pages Signed-off-by: Anne Chew <anne.chew@canonical.com>
1 parent 433dd82 commit 772959d

7 files changed

Lines changed: 37 additions & 66 deletions

File tree

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,9 @@
207207

208208
redirects = {
209209
"reference/patch_acceptance_criteria/index.html": "../patch-acceptance-criteria/",
210-
"how-to/develop-customize/": "how-to/develop-customise/",
210+
"how-to/develop-customize/": "how-to/",
211+
"how-to/develop-customise/": "how-to/",
212+
"how-to/source-code/": "how-to/",
211213
"how-to/develop-customize/build-kernel/": "how-to/develop-customise/build-kernel/",
212214
"how-to/develop-customize/build-kernel-snap/": "how-to/develop-customise/build-kernel-snap/",
213215
}

docs/explanation/stable-release-updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ model.
133133

134134
[Ubuntu Kernel Team]: https://kernel.ubuntu.com/
135135
[Ubuntu Wiki - Kernel Updates]: https://wiki.ubuntu.com/KernelTeam/KernelUpdates
136-
[Ubuntu archive has a single proposed pocket]: https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets
136+
[Ubuntu archive has a single proposed pocket]: https://documentation.ubuntu.com/project/how-ubuntu-is-made/concepts/package-archive/#proposed
137137
[Discourse - Ubuntu Kernel 4/2 SRU Cycle Announcement]: https://discourse.ubuntu.com/t/ubuntu-kernel-4-2-sru-cycle-announcement/37478
138138
[Ubuntu Wiki - Stable Kernel Release Cadence]: https://wiki.ubuntu.com/Kernel/StableReleaseCadence
139139
[Kernel team stable dashboard]: https://kernel.ubuntu.com/reports/kernel-stable-board/

docs/how-to/develop-customise/index.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/how-to/index.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,38 @@ myst:
66

77
# How-to guides
88

9-
These guides accompany through the various stages and building and publishing
9+
These guides accompany through the various stages of building and publishing
1010
kernel packages and components.
1111

1212
```{toctree}
1313
:titlesonly:
1414
:maxdepth: 1
1515
:hidden:
1616
17-
Source code access and management </how-to/source-code/index>
18-
Development and customization </how-to/develop-customise/index>
17+
Enable kernel source package repositories </how-to/source-code/enable-source-repositories>
18+
Obtain kernel source for an Ubuntu release using Git </how-to/source-code/obtain-kernel-source-git>
19+
Send patches to the mailing-list </how-to/source-code/send-patches>
20+
Build an Ubuntu Linux kernel </how-to/develop-customise/build-kernel>
21+
Build an Ubuntu Linux kernel snap </how-to/develop-customise/build-kernel-snap>
1922
Test kernels in -proposed </how-to/testing-verification/test-kernel-in-proposed>
2023
Contribute to kernel docs </how-to/contribute>
2124
```
2225

2326
## Source code access and management
2427

25-
Get access to kernel source code if you need to modify the kernel for specific
26-
requirements, optimize the performance for selected hardware, inspect the source
27-
tree to build custom kernel modules, and more.
28+
You can get access to kernel source code via `apt` or directly from the kernel Git repositories.
29+
You can also check the formatting requirements, review process, and best practices for submitting kernel patches to the Ubuntu kernel team mailing list.
2830

29-
- [Obtain kernel source for an Ubuntu release using Git](/how-to/source-code/obtain-kernel-source-git)
31+
- {doc}`Enable kernel source package repositories </how-to/source-code/enable-source-repositories>`
32+
- {doc}`Obtain kernel source for an Ubuntu release using Git </how-to/source-code/obtain-kernel-source-git>`
33+
- {doc}`Send patches to the mailing-list </how-to/source-code/send-patches>`
3034

3135
## Development and customization
3236

33-
The steps to build a kernel is similar but may have slightly difference
34-
configuration requirements on different platforms and/or architectures.
37+
The steps to build a kernel is similar but may have slightly difference configuration requirements on depending on the build package (snap, debs), platform and/or architectures.
3538

36-
- [Build an Ubuntu Linux kernel](/how-to/develop-customise/build-kernel)
37-
- [Build an Ubuntu Linux kernel snap](/how-to/develop-customise/build-kernel-snap)
39+
- {doc}`Build an Ubuntu Linux kernel </how-to/develop-customise/build-kernel>`
40+
- {doc}`Build an Ubuntu Linux kernel snap </how-to/develop-customise/build-kernel-snap>`
3841

3942
## Testing and verification
4043

docs/how-to/source-code/enable-source-repositories.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,3 @@ Once you have updated {file}`sources.list` or {file}`ubuntu.sources`, update the
4646
```{code-block} shell
4747
sudo apt update
4848
```
49-

docs/how-to/source-code/index.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/reference/index.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,47 @@ myst:
99
Reference material about Ubuntu kernel development processes, terminology, and
1010
more.
1111

12-
<!--
13-
.. toctree::
14-
:maxdepth: 1
15-
:caption: Ubuntu on Xilinx:
12+
## Kernel patch & contribution guidelines
1613

17-
xilinx/index
18-
-->
14+
It's important to follow the Ubuntu kernel patch guidelines so your contributions are accepted into the Ubuntu kernel tree without delays or rejection.
15+
These pages show how to properly format and submit your patches.
16+
17+
```{toctree}
18+
:maxdepth: 1
19+
20+
stable-patch-format
21+
patch-acceptance-criteria
22+
```
23+
24+
## Kernel variants and snaps
25+
26+
Different kernel variants and branches serve different purposes - long-term support, new hardware enablement, or experimental features.
27+
Understanding them helps you choose the right kernel for testing, development, or deployment.
1928

2029
```{toctree}
2130
:maxdepth: 1
22-
:caption: Kernel variants and snaps
2331
2432
ubuntu-kernels
2533
hwe-kernels
2634
oem-kernels
2735
snap-lifecycle
2836
```
2937

30-
```{toctree}
31-
:maxdepth: 1
32-
:caption: Kernel patch guidelines
38+
## Privileges
3339

34-
stable-patch-format
35-
patch-acceptance-criteria
36-
```
40+
Understand the criteria and process to apply for Ubuntu kernel and DKMS package upload rights.
3741

3842
```{toctree}
3943
:maxdepth: 1
40-
:caption: Privileges
4144
4245
kernel-upload-rights
4346
dkms-upload-rights
4447
```
4548

49+
## General
50+
4651
```{toctree}
4752
:maxdepth: 1
48-
:caption: General
4953
5054
glossary
5155
```

0 commit comments

Comments
 (0)