Skip to content

Commit d3a9db5

Browse files
committed
Fix merge conflicts
2 parents ac0bfad + b24bbb8 commit d3a9db5

38 files changed

+2291
-879
lines changed

.github/CODEOWNERS

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ MIR/ @slyon @setharnold @joalif @didrocks @cpaelzer @MylesJP @pushkarnk
1414
# - TAs not required for SRU content approvals
1515
SRU/
1616
# - SRU team owns all SRU docs anywhere in the repo
17-
SRU/ @basak
17+
SRU/ @basak @enr0n @tjaalton @panlinux @julian-klode @raof @awhitcroft
1818

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

4141
# TAs' & special teams' ack required for changes to the CODEOWNERS file
42-
/.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
42+
/.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
4343

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

.readthedocs.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ version: 2
88
# Set the version of Python and other tools you might need
99
build:
1010
os: ubuntu-24.04
11+
apt_packages:
12+
- graphviz
13+
- distro-info
1114
tools:
1215
python: "3.13"
1316
jobs:
@@ -22,8 +25,6 @@ build:
2225
then
2326
exit 183;
2427
fi
25-
apt_packages:
26-
- distro-info
2728
2829
# Build documentation in the docs/ directory with Sphinx
2930
sphinx:

docs/.custom_wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ unapplied
8686
unapply
8787
unpatched
8888
unshareable
89+
unstaged
8990
update_excuses
9091
uploader
9192
uploaders

docs/SRU/explanation/index.rst

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

docs/SRU/howto/contact.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Contact the SRU team
1616

1717
.. end-canonical-contact-admonition
1818
19-
- 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>`__.
19+
- If you **don't have upload access** to the archive, ask your sponsor for help in the first instance. For details, see :ref:`sponsorship`.
2020

2121
- 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:
2222

docs/SRU/howto/index.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
How-to
2-
======
1+
.. _stable-release-updates:
2+
3+
Stable Release Updates
4+
======================
35

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

8+
9+
Introduction to SRU for contributors
10+
------------------------------------
11+
12+
.. toctree::
13+
:maxdepth: 1
14+
15+
introduction-to-sru
16+
17+
618
Submit a package update
719
-----------------------
820

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

31+
1932
Troubleshooting
2033
---------------
2134

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

45+
3246
Contact
3347
-------
3448

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

4054
contact
41-

docs/how-ubuntu-is-made/processes/stable-release-updates.rst renamed to docs/SRU/howto/introduction-to-sru.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _stable-release-updates:
1+
.. _introduction-to-sru:
22

3-
Stable Release Updates
4-
======================
3+
Introduction to SRU
4+
===================
55

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

@@ -67,4 +67,3 @@ Updates removal
6767
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**.
6868

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

docs/SRU/reference/package-specific.rst

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -685,16 +685,25 @@ be taken to not leave the kernel with a mismatched firmware package.
685685

686686
However, it is a very large package (over 500MiB in size), and making it
687687
instantly available in the -security pocket to all Ubuntu users in the world
688-
causes a lot of strain on the archive network and servers.
688+
via unattended-upgrades causes a lot of strain on the archive network
689+
and servers. The kernel team is working on that, but until then we need to
690+
mitigate the impact to all users.
689691

690-
Therefore, once the verification is done and linux-firmware is ready to be
691-
released, it should first be released to the updates pocket. Then, after
692-
phasing has completed, it must be copied to the -security pocket by either
693-
an archive admin, or a security team member.
692+
Therefore, for now, once the verification is done and linux-firmware is ready
693+
to be (SRU) released we have to stagger the release to spread the load.
694+
695+
* First it should be released to the updates pocket - allowing mirrors to sync
696+
it and anyone running explicit updates to pick it up.
697+
698+
* Then after phasing has completed, it must be copied to the -security pocket
699+
by either an archive admin, or a security team member. That copy should also
700+
be spread out over releases. The suggested delay in-between is 4 days,
701+
which combined with the "avoid Friday" rule suggests Mon,Thu,Mon,... until
702+
all are fully released.
694703

695704
Note that this release process described above only applies to SRUs. Actual
696705
security updates to this package are not handled through the SRU process
697-
and remain unchanged.
706+
but will also need to follow the staged release until properly mitigated.
698707

699708
wireless-regdb
700709
~~~~~~~~~~~~~~

docs/SRU/reference/rota.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Team rota
44
---------
55

6-
.. include:: /howto/contact.rst
6+
.. include:: /SRU/howto/contact.rst
77
:start-after: start-canonical-contact-admonition
88
:end-before: end-canonical-contact-admonition
99

Lines changed: 35 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
:relatedlinks: [Diátaxis](https://diataxis.fr/)
1+
.. _stable-release-updates-sru:
22

3-
.. _home:
4-
5-
SRU documentation
6-
=================
3+
Stable Release Updates (SRU)
4+
============================
75

86
.. A single sentence that says what the product is, succinctly and
97
memorably.
@@ -38,74 +36,61 @@ in practice.
3836

3937
---------
4038

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

44-
The basic SRU process consists of the following steps:
4541

46-
.. include:: explanation/pipeline.rst
47-
:start-line: 4
48-
:end-before: See also
49-
50-
For next steps, see :ref:`How-to → Perform a standard SRU <howto-perform-standard-sru>`.
42+
Which updates we release
43+
------------------------
5144

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

55-
.. grid:: 2
47+
.. toctree::
48+
:maxdepth: 1
5649

57-
.. grid-item-card:: :doc:`How-to guides <howto/index>`
58-
:columns: 12
59-
:link: howto/index
60-
:link-type: doc
50+
explanation/principles
51+
explanation/requirements
6152

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

64-
.. grid:: 2
65-
:reverse:
54+
Who releases updates
55+
----------------------
6656

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

72-
**Technical information** - specifications, APIs, architecture
59+
.. toctree::
60+
:maxdepth: 1
7361

74-
.. grid-item-card:: :doc:`Explanation <explanation/index>`
75-
:columns: 6
76-
:link: explanation/index
77-
:link-type: doc
62+
explanation/pipeline
63+
explanation/roles
7864

79-
**Discussion and clarification** of key topics
8065

66+
Processes
8167
---------
8268

83-
Project and community
84-
---------------------
69+
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.
70+
71+
.. toctree::
72+
:maxdepth: 1
73+
74+
explanation/standard-processes
75+
explanation/non-standard-processes
76+
explanation/further-requirements
8577

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

90-
- `Get
91-
support <https://askubuntu.com/questions/tagged/stable-release-updates>`__:
92-
Ask Ubuntu is a question and answer site for Ubuntu users and
93-
developers.
79+
Getting started
80+
---------------
9481

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

99-
- `Report bugs <https://bugs.launchpad.net/sru-docs/+filebug>`__: We
100-
want to know about the problems, so we can fix them.
84+
.. include:: explanation/pipeline.rst
85+
:start-line: 4
86+
:end-before: See also
87+
88+
For next steps, see :ref:`How-to → Perform a standard SRU <howto-perform-standard-sru>`.
10189

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

10491
.. toctree::
10592
:hidden:
10693
:maxdepth: 2
10794

108-
howto/index
109-
explanation/index
11095
reference/index
11196
internal

0 commit comments

Comments
 (0)