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
5 changes: 3 additions & 2 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ MIR/ @slyon @setharnold @joalif @didrocks @cpaelzer @MylesJP @pushkarnk
# - TAs not required for SRU content approvals
SRU/
# - SRU team owns all SRU docs anywhere in the repo
SRU/ @basak
SRU/ @basak @enr0n @tjaalton @panlinux @julian-klode @raof @awhitcroft

# Technical Board PR approvals
# - TAs not required for Tech Board content approvals
Expand All @@ -39,7 +39,8 @@ community/ @aaronprisk @ilvipero
**/dmb-*.md @cpaelzer @lvoytek @rbasak @utkarsh2102 @athos-ribeiro @bdrung @julian-klode

# TAs' & special teams' ack required for changes to the CODEOWNERS file
/.github/CODEOWNERS @s-makin @rkratky @slyon @setharnold @joalif @didrocks @cpaelzer @MylesJP @pushkarnk @panlinux @paride @ginggs @schopin-pro @mwhudson @utkarsh2102 @tjaalton @seb128 @raof @aaronprisk @ilvipero @basak @teward
/.github/CODEOWNERS @s-makin @rkratky @slyon @setharnold @joalif @didrocks @cpaelzer @MylesJP @pushkarnk @panlinux @paride @ginggs @schopin-pro @mwhudson @utkarsh2102 @tjaalton @seb128 @raof @aaronprisk @ilvipero @basak @teward @enr0n @julian-klode @awhitcroft

# +1 maintenance PR approvals
plus-one-*.md @schopin-pro @s-makin @rkratky

5 changes: 3 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-24.04
apt_packages:
- graphviz
- distro-info
tools:
python: "3.13"
jobs:
Expand All @@ -22,8 +25,6 @@ build:
then
exit 183;
fi
apt_packages:
- distro-info

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
38 changes: 0 additions & 38 deletions docs/SRU/explanation/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/SRU/howto/contact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Contact the SRU team

.. end-canonical-contact-admonition

- If you **don't have upload access** to the archive, ask your sponsor for help in the first instance. For details, see `Sponsorship Process <https://wiki.ubuntu.com/SponsorshipProcess>`__.
- If you **don't have upload access** to the archive, ask your sponsor for help in the first instance. For details, see :ref:`sponsorship`.

- If you **don't have a sponsor**, you can use the `Ubuntu Patch Pilots <https://discourse.ubuntu.com/t/ubuntu-patch-pilots/37705>`__ Program. Ask a patch pilot in the following channels:

Expand Down
19 changes: 16 additions & 3 deletions docs/SRU/howto/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
How-to
======
.. _stable-release-updates:

Stable Release Updates
======================

As a contributor, follow these guides to upload an SRU and to ensure that it works correctly.


Introduction to SRU for contributors
------------------------------------

.. toctree::
:maxdepth: 1

introduction-to-sru


Submit a package update
-----------------------

Expand All @@ -16,6 +28,7 @@ You can submit a standard SRU that fixes a bug or a non-standard update such as
prepare-special
special


Troubleshooting
---------------

Expand All @@ -29,6 +42,7 @@ Follow these guides if an issue occurs during the SRU or after its release.
phasing
regression


Contact
-------

Expand All @@ -38,4 +52,3 @@ You can discuss SRUs on the following public channels.
:maxdepth: 1

contact

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _stable-release-updates:
.. _introduction-to-sru:

Stable Release Updates
======================
Introduction to SRU
===================

To fix newly discovered bugs and make updates after the publication of an :term:`Ubuntu Stable Release`, use the **Stable Release Update (SRU)** process.

Expand Down Expand Up @@ -67,4 +67,3 @@ Updates removal
If a bug fixed by an update doesn't get any testing or verification feedback for 90 days, an automated "call for testing" comment is made on the bug report. If no testing occurs within an additional 15 days, totaling 105 days without any testing, the :term:`Stable Release Managers` removes the package from proposed and close the bug task as **Won't Fix**.

Also, updates are removed from proposed if they introduce a non-trivial regression.

2 changes: 1 addition & 1 deletion docs/SRU/reference/rota.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Team rota
---------

.. include:: /howto/contact.rst
.. include:: /SRU/howto/contact.rst
:start-after: start-canonical-contact-admonition
:end-before: end-canonical-contact-admonition

Expand Down
85 changes: 35 additions & 50 deletions docs/SRU/index.rst → docs/SRU/stable-release-updates.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
:relatedlinks: [Diátaxis](https://diataxis.fr/)
.. _stable-release-updates-sru:

.. _home:

SRU documentation
=================
Stable Release Updates (SRU)
============================

.. A single sentence that says what the product is, succinctly and
memorably.
Expand Down Expand Up @@ -38,74 +36,61 @@ in practice.

---------

Getting started
---------------
Learn how Canonical determines which updates qualify for SRUs, who supervises the update process, who contributes and what responsibilities they have.

The basic SRU process consists of the following steps:

.. include:: explanation/pipeline.rst
:start-line: 4
:end-before: See also

For next steps, see :ref:`How-to → Perform a standard SRU <howto-perform-standard-sru>`.
Which updates we release
------------------------

In this documentation
---------------------
We follow strict rules to ensure that SRUs fix real-world problems and introduce no disruptions.

.. grid:: 2
.. toctree::
:maxdepth: 1

.. grid-item-card:: :doc:`How-to guides <howto/index>`
:columns: 12
:link: howto/index
:link-type: doc
explanation/principles
explanation/requirements

**Step-by-step guides** covering key operations and common tasks

.. grid:: 2
:reverse:
Who releases updates
----------------------

.. grid-item-card:: :doc:`Reference <reference/index>`
:columns: 6
:link: reference/index
:link-type: doc
The SRU team and other stakeholders review and release updates. Community members outside of Canonical can contribute in the process.

**Technical information** - specifications, APIs, architecture
.. toctree::
:maxdepth: 1

.. grid-item-card:: :doc:`Explanation <explanation/index>`
:columns: 6
:link: explanation/index
:link-type: doc
explanation/pipeline
explanation/roles

**Discussion and clarification** of key topics

Processes
---------

Project and community
---------------------
You must follow these rules when you upload a package update. Processes such as automatic tests, phasing and user reports prevent regressions in updates. Certain exceptions to standard processes are possible.

.. toctree::
:maxdepth: 1

explanation/standard-processes
explanation/non-standard-processes
explanation/further-requirements

- `Read our code of
conduct <https://ubuntu.com/community/ethos/code-of-conduct>`__: As a
community, we adhere to the Ubuntu code of conduct.

- `Get
support <https://askubuntu.com/questions/tagged/stable-release-updates>`__:
Ask Ubuntu is a question and answer site for Ubuntu users and
developers.
Getting started
---------------

- `Join our online
chat <https://matrix.to/#/#sru:ubuntu.com>`__: Meet us
in ``#sru:ubuntu.com`` on Matrix.
The basic SRU process consists of the following steps:

- `Report bugs <https://bugs.launchpad.net/sru-docs/+filebug>`__: We
want to know about the problems, so we can fix them.
.. include:: explanation/pipeline.rst
:start-line: 4
:end-before: See also

For next steps, see :ref:`How-to → Perform a standard SRU <howto-perform-standard-sru>`.

- `Contribute documentation <https://launchpad.net/sru-docs>`__: The documentation sources in Launchpad.

.. toctree::
:hidden:
:maxdepth: 2

howto/index
explanation/index
reference/index
internal
5 changes: 2 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -277,11 +277,11 @@
"sphinx_sitemap",
"sphinx_reredirects",
"sphinx_togglebutton",
"sphinx.ext.graphviz",
]

# Excludes files or directories from processing
exclude_patterns = ["maintainers/niche-package-maintenance/rustc/common",
"SRU"]
exclude_patterns = ["maintainers/niche-package-maintenance/rustc/common"]


# Adds custom CSS files, located under 'html_static_path'
Expand Down Expand Up @@ -402,7 +402,6 @@
"https://canonical-starter-pack.readthedocs-hosted.com/latest/",
None,
),
"sru": ("https://canonical-sru-docs.readthedocs-hosted.com/en/latest/", None),
"launchpad": ("https://documentation.ubuntu.com/launchpad/", None),
}

Expand Down
11 changes: 11 additions & 0 deletions docs/contributors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,17 @@ new-package/index
```


## Stable Release Updates

Guidance for contributors on how to submit requests for SRU. See

```{toctree}
:maxdepth: 1

/SRU/howto/index
```


## Accessibility

```{toctree}
Expand Down
2 changes: 1 addition & 1 deletion docs/how-ubuntu-is-made/processes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,6 @@ Special review processes and quality safeguards for adding updates to published
```{toctree}
:maxdepth: 1

stable-release-updates
/SRU/stable-release-updates
/MIR/main-inclusion-review
```
3 changes: 3 additions & 0 deletions docs/redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,6 @@ contributors/patching/salsa-dual-maintenance/ contributors/patching/dual-mainten
contributors/setup/get-package-source/ contributors/setup/get-the-source-of-a-package/
contributors/setup/setup/ contributors/setup/set-up-for-ubuntu-development/
contributors/merging/submit-merge-proposal/ contributors/merging/git-ubuntu-merge-proposal/

SRU/index SRU/stable-release-updates/
how-ubuntu-is-made/processes/stable-release-updates/ SRU/stable-release-updates/