From 1c7af33223cbc03ec14a8000339de98f48761363 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Tue, 21 Oct 2025 20:21:46 +0200 Subject: [PATCH 1/2] Add SRU docs to navigation structure * SRU explanation & reference articles added to How Ubuntu is made -> Process overviews * SRU howto articles added to Contributors -> Stable Release Updates (SRU) --- docs/SRU/explanation/index.rst | 38 --------- docs/SRU/howto/contact.rst | 2 +- docs/SRU/howto/index.rst | 19 ++++- .../howto/introduction-to-sru.rst} | 7 +- docs/SRU/reference/rota.rst | 2 +- .../{index.rst => stable-release-updates.rst} | 85 ++++++++----------- docs/conf.py | 5 +- docs/contributors/index.md | 11 +++ docs/how-ubuntu-is-made/processes/index.md | 2 +- docs/redirects.txt | 3 + 10 files changed, 73 insertions(+), 101 deletions(-) delete mode 100644 docs/SRU/explanation/index.rst rename docs/{how-ubuntu-is-made/processes/stable-release-updates.rst => SRU/howto/introduction-to-sru.rst} (98%) rename docs/SRU/{index.rst => stable-release-updates.rst} (52%) diff --git a/docs/SRU/explanation/index.rst b/docs/SRU/explanation/index.rst deleted file mode 100644 index c7f5acf0..00000000 --- a/docs/SRU/explanation/index.rst +++ /dev/null @@ -1,38 +0,0 @@ -Explanation -=========== - -Learn how Canonical determines which updates qualify for SRUs, who supervises the update process, who contributes and what responsibilities they have. - -Which updates we release ------------------------- - -We follow strict rules to ensure that SRUs fix real-world problems and introduce no disruptions. - -.. toctree:: - :maxdepth: 1 - - principles - requirements - -Who releases updates ----------------------- - -The SRU team and other stakeholders review and release updates. Community members outside of Canonical can contribute in the process. - -.. toctree:: - :maxdepth: 1 - - pipeline - roles - -Processes ---------- - -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 - - standard-processes - non-standard-processes - further-requirements diff --git a/docs/SRU/howto/contact.rst b/docs/SRU/howto/contact.rst index 037af028..546ef020 100644 --- a/docs/SRU/howto/contact.rst +++ b/docs/SRU/howto/contact.rst @@ -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 `__. +- 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 `__ Program. Ask a patch pilot in the following channels: diff --git a/docs/SRU/howto/index.rst b/docs/SRU/howto/index.rst index f2752059..feced4e8 100644 --- a/docs/SRU/howto/index.rst +++ b/docs/SRU/howto/index.rst @@ -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 ----------------------- @@ -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 --------------- @@ -29,6 +42,7 @@ Follow these guides if an issue occurs during the SRU or after its release. phasing regression + Contact ------- @@ -38,4 +52,3 @@ You can discuss SRUs on the following public channels. :maxdepth: 1 contact - diff --git a/docs/how-ubuntu-is-made/processes/stable-release-updates.rst b/docs/SRU/howto/introduction-to-sru.rst similarity index 98% rename from docs/how-ubuntu-is-made/processes/stable-release-updates.rst rename to docs/SRU/howto/introduction-to-sru.rst index 78452fe9..83315ab5 100644 --- a/docs/how-ubuntu-is-made/processes/stable-release-updates.rst +++ b/docs/SRU/howto/introduction-to-sru.rst @@ -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. @@ -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. - diff --git a/docs/SRU/reference/rota.rst b/docs/SRU/reference/rota.rst index 905cd012..fb73bf28 100644 --- a/docs/SRU/reference/rota.rst +++ b/docs/SRU/reference/rota.rst @@ -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 diff --git a/docs/SRU/index.rst b/docs/SRU/stable-release-updates.rst similarity index 52% rename from docs/SRU/index.rst rename to docs/SRU/stable-release-updates.rst index 1a3475ca..c78c0104 100644 --- a/docs/SRU/index.rst +++ b/docs/SRU/stable-release-updates.rst @@ -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. @@ -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 `. +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 ` - :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 ` - :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 ` - :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 `__: As a - community, we adhere to the Ubuntu code of conduct. -- `Get - support `__: - Ask Ubuntu is a question and answer site for Ubuntu users and - developers. +Getting started +--------------- -- `Join our online - chat `__: Meet us - in ``#sru:ubuntu.com`` on Matrix. +The basic SRU process consists of the following steps: -- `Report bugs `__: 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 `. -- `Contribute documentation `__: The documentation sources in Launchpad. .. toctree:: :hidden: :maxdepth: 2 - howto/index - explanation/index reference/index internal diff --git a/docs/conf.py b/docs/conf.py index f757d935..0c4852e3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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' @@ -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), } diff --git a/docs/contributors/index.md b/docs/contributors/index.md index ab280151..577f9dd7 100644 --- a/docs/contributors/index.md +++ b/docs/contributors/index.md @@ -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} diff --git a/docs/how-ubuntu-is-made/processes/index.md b/docs/how-ubuntu-is-made/processes/index.md index cbb541f5..09d8885b 100644 --- a/docs/how-ubuntu-is-made/processes/index.md +++ b/docs/how-ubuntu-is-made/processes/index.md @@ -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 ``` diff --git a/docs/redirects.txt b/docs/redirects.txt index 0b97cd50..2ab6072c 100644 --- a/docs/redirects.txt +++ b/docs/redirects.txt @@ -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/ From 1cdda0c08b312910c20cc9e4187f336a7f830384 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Wed, 22 Oct 2025 20:11:13 +0200 Subject: [PATCH 2/2] Add active SRU team members to CODEOWNERS --- .github/CODEOWNERS | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 443666d8..feefae4c 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -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 @@ -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 +