From df135309e606b2263cd8c2cba243db0004eaa28c Mon Sep 17 00:00:00 2001 From: Anne Chew Date: Mon, 26 Jan 2026 22:49:21 +0800 Subject: [PATCH 1/2] docs: update meta description Signed-off-by: Anne Chew --- docs/explanation/index.md | 6 ++++++ docs/explanation/post-release-updates.md | 6 ++++++ docs/explanation/stable-release-updates.md | 6 ++++++ docs/explanation/ubuntu-linux-kernel-sources.md | 6 ++++++ docs/how-to/develop-customise/build-kernel-snap.md | 6 ++++++ docs/how-to/develop-customise/build-kernel.md | 6 ++++++ docs/how-to/develop-customise/index.md | 6 ++++++ docs/how-to/index.md | 6 ++++++ docs/how-to/source-code/enable-source-repositories.md | 7 ++++++- docs/how-to/source-code/index.md | 6 ++++++ docs/how-to/source-code/obtain-kernel-source-git.md | 6 ++++++ docs/how-to/source-code/send-patches.rst | 3 +++ .../how-to/testing-verification/test-kernel-in-proposed.md | 6 ++++++ docs/index.md | 6 ++++++ docs/reference/dkms-upload-rights.rst | 3 +++ docs/reference/glossary.md | 6 ++++++ docs/reference/hwe-kernels.rst | 3 +++ docs/reference/index.md | 6 ++++++ docs/reference/kernel-upload-rights.rst | 3 +++ docs/reference/oem-kernels.rst | 3 +++ docs/reference/patch-acceptance-criteria.rst | 3 +++ docs/reference/stable-patch-format.rst | 3 +++ docs/reference/ubuntu-kernels.md | 7 +++++++ 23 files changed, 118 insertions(+), 1 deletion(-) diff --git a/docs/explanation/index.md b/docs/explanation/index.md index 51efba0..fdffc63 100644 --- a/docs/explanation/index.md +++ b/docs/explanation/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Ubuntu kernel development processes, security policies, and stable release updates. Explore explanations of kernel sources and workflows." +--- + # Explanation The explanatory guides in this section talk about different aspects of the diff --git a/docs/explanation/post-release-updates.md b/docs/explanation/post-release-updates.md index b590b5e..a9eeecd 100644 --- a/docs/explanation/post-release-updates.md +++ b/docs/explanation/post-release-updates.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Learn Ubuntu kernel security and update policies for post-release trees. Understand SRU criteria, patch submission process, and archive updates." +--- + # Kernel security and update policy for post-release trees This document describes the process and criteria for post-release kernel updates. diff --git a/docs/explanation/stable-release-updates.md b/docs/explanation/stable-release-updates.md index 5c1ab92..a0ab80f 100644 --- a/docs/explanation/stable-release-updates.md +++ b/docs/explanation/stable-release-updates.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Understand Ubuntu kernel stable release updates (SRU). Learn about the 4/2 cycle cadence, patch submission, review process, and kernel streams." +--- + # About kernel stable release updates (SRU) Every supported kernel for an Ubuntu release is part of a Stable Release Updates diff --git a/docs/explanation/ubuntu-linux-kernel-sources.md b/docs/explanation/ubuntu-linux-kernel-sources.md index c7c4c83..57ee1e6 100644 --- a/docs/explanation/ubuntu-linux-kernel-sources.md +++ b/docs/explanation/ubuntu-linux-kernel-sources.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Overview of Ubuntu Linux kernel source repository structure, how to find Launchpad Git URLs, branches, and protocols for accessing source code." +--- + # About Ubuntu Linux kernel sources Ubuntu Linux kernel source packages are essential for users and developers who diff --git a/docs/how-to/develop-customise/build-kernel-snap.md b/docs/how-to/develop-customise/build-kernel-snap.md index 6dd825c..5918d73 100644 --- a/docs/how-to/develop-customise/build-kernel-snap.md +++ b/docs/how-to/develop-customise/build-kernel-snap.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Learn to build Ubuntu Linux kernel snaps. Follow detailed instructions for creating snap packages from kernel source code for local testing and development." +--- + # How to build an Ubuntu Linux kernel snap If you are running an Ubuntu Core system and want to use boot into a custom diff --git a/docs/how-to/develop-customise/build-kernel.md b/docs/how-to/develop-customise/build-kernel.md index f5a2fbc..9496d63 100644 --- a/docs/how-to/develop-customise/build-kernel.md +++ b/docs/how-to/develop-customise/build-kernel.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Step-by-step guide to build an Ubuntu Linux kernel from source. Learn prerequisites, configuration, customization, and installation procedures." +--- + # How to build an Ubuntu Linux kernel If you have patches you need to apply to the Ubuntu Linux kernel, or you want to diff --git a/docs/how-to/develop-customise/index.md b/docs/how-to/develop-customise/index.md index 64e5f3f..a3961d6 100644 --- a/docs/how-to/develop-customise/index.md +++ b/docs/how-to/develop-customise/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Build and customize Ubuntu kernels. Follow guides for building kernel packages and snaps across different platforms and architectures." +--- + # Development and customization These guides cover how to build kernel packages, kernel snaps, and kernel diff --git a/docs/how-to/index.md b/docs/how-to/index.md index 2d39257..0f9094f 100644 --- a/docs/how-to/index.md +++ b/docs/how-to/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Guides for Ubuntu kernel development. Learn how to obtain source code, build kernels, test in -proposed versions, and contribute to the documentation." +--- + # How-to guides These guides accompany through the various stages and building and publishing diff --git a/docs/how-to/source-code/enable-source-repositories.md b/docs/how-to/source-code/enable-source-repositories.md index 4c8981e..c972cee 100644 --- a/docs/how-to/source-code/enable-source-repositories.md +++ b/docs/how-to/source-code/enable-source-repositories.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Enable Ubuntu kernel source package repositories. Learn to configure sources.list or ubuntu.sources for kernel development and building." +--- + # How to enable kernel source package repositories If you want to build or modify an Ubuntu kernel package from source, you will first need the kernel source code. @@ -31,7 +37,6 @@ file. If not, add or uncomment these lines for your Ubuntu release. deb-src http://archive.ubuntu.com/ubuntu jammy main deb-src http://archive.ubuntu.com/ubuntu jammy-updates main ``` -```` ````` ## Update package list diff --git a/docs/how-to/source-code/index.md b/docs/how-to/source-code/index.md index 559977f..4089cb5 100644 --- a/docs/how-to/source-code/index.md +++ b/docs/how-to/source-code/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Find out where to obtain kernel sources via Git, enable repositories, and send patches to the mailing list." +--- + # Source code access and management These guides cover processes related to obtaining kernel source trees and diff --git a/docs/how-to/source-code/obtain-kernel-source-git.md b/docs/how-to/source-code/obtain-kernel-source-git.md index 292a48f..4f747ea 100644 --- a/docs/how-to/source-code/obtain-kernel-source-git.md +++ b/docs/how-to/source-code/obtain-kernel-source-git.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Obtain Ubuntu kernel source code using Git. Follow step-by-step instructions for cloning kernel repositories for any Ubuntu release." +--- + # How to obtain kernel source for an Ubuntu release using Git The kernel source code for each Ubuntu release is maintained in its own diff --git a/docs/how-to/source-code/send-patches.rst b/docs/how-to/source-code/send-patches.rst index 030827e..5375274 100644 --- a/docs/how-to/source-code/send-patches.rst +++ b/docs/how-to/source-code/send-patches.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: Submit kernel patches to the Ubuntu kernel team mailing list. Learn formatting requirements, review process, and best practices for patches. + .. _how-to-send-patches: How to send patches to the mailing-list diff --git a/docs/how-to/testing-verification/test-kernel-in-proposed.md b/docs/how-to/testing-verification/test-kernel-in-proposed.md index 4e8748f..b023a4a 100644 --- a/docs/how-to/testing-verification/test-kernel-in-proposed.md +++ b/docs/how-to/testing-verification/test-kernel-in-proposed.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Learn to enable -proposed pocket, install test kernels, and verify stability of kernels before release." +--- + # How to test kernels in -proposed Ubuntu kernels are uploaded to the -proposed pocket for testing before being diff --git a/docs/index.md b/docs/index.md index fddebbc..4a5ff3a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Official Ubuntu kernel documentation. Learn to build, customize, and contribute to Ubuntu kernels. Understand the cadence for stable release updates and HWE kernels." +--- + # Ubuntu Kernel documentation The Ubuntu Linux kernel is the core software enabling applications on Ubuntu to diff --git a/docs/reference/dkms-upload-rights.rst b/docs/reference/dkms-upload-rights.rst index ec46e3a..fab17f3 100644 --- a/docs/reference/dkms-upload-rights.rst +++ b/docs/reference/dkms-upload-rights.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: DKMS (Dynamic Kernel Module Support) upload rights for Ubuntu. Understand permissions, responsibilities, and application procedures. + DKMS upload rights ################## diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index c18e2a5..aec660d 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Ubuntu kernel terminology glossary. Find definitions for SRU, DKMS, HWE, edge kernels, and other kernel development terms. Quick reference guide." +--- + # Kernel glossary This page is a running list of terminology that is frequently used when talking diff --git a/docs/reference/hwe-kernels.rst b/docs/reference/hwe-kernels.rst index d1fda49..d7bfc79 100644 --- a/docs/reference/hwe-kernels.rst +++ b/docs/reference/hwe-kernels.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: Hardware Enablement (HWE) kernels for Ubuntu LTS releases. Learn about support lifecycles, installation procedures, and edge kernel variants. + HWE kernels =========== diff --git a/docs/reference/index.md b/docs/reference/index.md index 10d8b7f..d98f508 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference guides for Ubuntu kernel development processes. Explore kernel variants, patch formats, acceptance criteria, upload rights, and terminology." +--- + # Reference Reference material about Ubuntu kernel development processes, terminology, and diff --git a/docs/reference/kernel-upload-rights.rst b/docs/reference/kernel-upload-rights.rst index fe725bb..2091c45 100644 --- a/docs/reference/kernel-upload-rights.rst +++ b/docs/reference/kernel-upload-rights.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: Ubuntu kernel upload rights and permissions. Learn about access levels, responsibilities, and how to obtain upload privileges for kernels. + .. _kernel-upload-rights: Kernel upload rights diff --git a/docs/reference/oem-kernels.rst b/docs/reference/oem-kernels.rst index 8925912..0a9a804 100644 --- a/docs/reference/oem-kernels.rst +++ b/docs/reference/oem-kernels.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: OEM kernels for Ubuntu hardware partners. Understand specialized kernels for pre-installed systems, staging processes, and release timelines. + OEM kernels =========== diff --git a/docs/reference/patch-acceptance-criteria.rst b/docs/reference/patch-acceptance-criteria.rst index d5236be..58f5cb9 100644 --- a/docs/reference/patch-acceptance-criteria.rst +++ b/docs/reference/patch-acceptance-criteria.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: Understand Ubuntu kernel patch acceptance criteria. Learn what patches are accepted for stable releases and the evaluation process used. + .. highlight:: email .. _ubuntu-patches-acceptance-criteria: diff --git a/docs/reference/stable-patch-format.rst b/docs/reference/stable-patch-format.rst index eda3020..51c88eb 100644 --- a/docs/reference/stable-patch-format.rst +++ b/docs/reference/stable-patch-format.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: Ubuntu kernel stable patch format requirements. Learn proper structure, SRU justification, commit messages, and submission guidelines. + Stable patch format =================== diff --git a/docs/reference/ubuntu-kernels.md b/docs/reference/ubuntu-kernels.md index eccd6f3..c2eb0f9 100644 --- a/docs/reference/ubuntu-kernels.md +++ b/docs/reference/ubuntu-kernels.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Understand Ubuntu kernel variants including development, optimized, OEM, and HWE kernels. Learn about git branching strategies and lifecycles." +--- + (ref-ubuntu-kernel-variants-branches)= # Ubuntu kernel variants and branches @@ -134,6 +140,7 @@ The `master-next` or `main-next` branches serve as the staging area for the **ne The `master` or `main` branches represent the current state of the kernel source as it exists in the `-updates` pocket of the Ubuntu archive. It contains the linear history of all the stable releases published for that kernel. + % LINKS [Ubuntu kernels from Canonical]: https://ubuntu.com/kernel From 5b104178cfab554f76014c5d44fd9e9185e72bc2 Mon Sep 17 00:00:00 2001 From: Anne Chew Date: Mon, 26 Jan 2026 23:24:34 +0800 Subject: [PATCH 2/2] ci: fix lint-md target exclusion path Signed-off-by: Anne Chew --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index 8728806..43c2d34 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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