Skip to content
Open
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
18 changes: 10 additions & 8 deletions docs/.sphinx/_static/custom_styles.css
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
.codeblock-wrap pre { white-space:pre-wrap; }
.codeblock-wrap pre {
white-space: pre-wrap;
}

pre.mermaid svg {
width: 70% !important;
height: auto !important;
width: 100% !important;
height: auto !important;
}

/* Append "(in this article)" dynamically for links within any series admonition that point to the current page */
.admonition-highlight-this-page a.reference.internal[href^="#"]:after {
content: " (in this article)";
font-style: italic;
font-weight: normal;
color: #777; /* Greyed out, independent of link visited state */
margin-left: 4px;
content: " (in this article)";
font-style: italic;
font-weight: normal;
color: #777; /* Greyed out, independent of link visited state */
margin-left: 4px;
}
36 changes: 21 additions & 15 deletions docs/MIR/mir-process-states.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,13 @@ an MIR bug's current state.

```{mermaid}
%% mermaid flowcharts documentation: https://mermaid.js.org/syntax/flowchart.html
%%{ init: { "flowchart": { "curve": "monotoneY", "htmlLabels": true } } }%%
%%{ init: { 'flowchart': {
'curve': 'monotoneY',
'htmlLabels': true },
'themeVariables': {
'fontSize': '1em',
'fontFamily': 'Ubuntu'} } }%%

flowchart TD
%% Styles
classDef Invisible stroke-width:0,fill:#00000000
Expand All @@ -37,27 +43,27 @@ flowchart TD
BugCreated>"Bug created"]

%% Transitions
Start-->|"<div style='background:#8BC34A'><i>a)</i> create MIR bug</div>"| BugCreated
BugCreated-->|"<div style='background:#8BC34A'><i>b)</i> subscribe <code>~ubuntu-mir</code></div>"|ToReview
Start-->|"<div><i>a)</i> create MIR bug</div>"| BugCreated
BugCreated-->|"<div><i>b)</i> subscribe <code>~ubuntu-mir</code></div>"|ToReview

ToReview -->|"<div style='background:#4ECDC4'><i>c)</i> triaged by MIR team</div>"| AssignedToMirTeamMember
ToReview -->|"<div><i>c)</i> triaged by MIR team</div>"| AssignedToMirTeamMember

AssignedToMirTeamMember -->|"<div style='background:#4ECDC4'><i>d</i>) MIR team ACK</div>"| InProgress
AssignedToMirTeamMember -->|"<div style='background:#4ECDC4'><i>e</i>) MIR team ACK,<br>Security needed</div>"| AssignedToSecurityTeamMember
AssignedToMirTeamMember -->|"<div style='background:#4ECDC4'><i>f</i>) MIR team NACK</div>"| WontFix
AssignedToMirTeamMember -->|"<div style='background:#4ECDC4'><i>g</i>) needs questions/actions</div>"| Incomplete
AssignedToMirTeamMember -->|"<div><i>d</i>) MIR team ACK</div>"| InProgress
AssignedToMirTeamMember -->|"<div><i>e</i>) MIR team ACK,<br>Security needed</div>"| AssignedToSecurityTeamMember
AssignedToMirTeamMember -->|"<div><i>f</i>) MIR team NACK</div>"| WontFix
AssignedToMirTeamMember -->|"<div><i>g</i>) needs questions/actions</div>"| Incomplete

AssignedToSecurityTeamMember -->|"<div style='background:#DBB3B1'><i>h</i>) Security ACK</div>"| InProgress
AssignedToSecurityTeamMember -->|"<div style='background:#DBB3B1'><i>i</i>) Security NACK</div>"| WontFix
AssignedToSecurityTeamMember -->|"<div style='background:#DBB3B1'><i>j</i>) needs questions/actions</div>"| Incomplete
AssignedToSecurityTeamMember -->|"<div><i>h</i>) Security ACK</div>"| InProgress
AssignedToSecurityTeamMember -->|"<div><i>i</i>) Security NACK</div>"| WontFix
AssignedToSecurityTeamMember -->|"<div><i>j</i>) needs questions/actions</div>"| Incomplete

Incomplete -->|"<div style='background:#8BC34A'><i>k</i>) questions/actions resolved</div>"| ToReview
WontFix -->|"<div style='background:#8BC34A'><i>l</i>) situation changes</div>"| ToReview
InProgress -->|"<div style='background:#8BC34A'><i>m)</i> package(s) pulled into main</div>"| FixCommitted
Incomplete -->|"<div><i>k</i>) questions/actions resolved</div>"| ToReview
WontFix -->|"<div><i>l</i>) situation changes</div>"| ToReview
InProgress -->|"<div><i>m)</i> package(s) pulled into main</div>"| FixCommitted

FixCommitted -->|"<i>n)</i> Archive Admin</br>promotes package(s)"| FixReleased

Incomplete -->|"<div style='background:#4ECDC4'><i>o)</i> no response</div>"| Invalid
Incomplete -->|"<div><i>o)</i> no response</div>"| Invalid
```

| Index | State | Assignee / Subscriber | State-Explanation |
Expand Down
4 changes: 2 additions & 2 deletions docs/SRU/explanation/pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ Overview of the SRU pipeline
The following diagram illustrates this pipeline:

.. mermaid::
:align: center

%%{init: {'themeVariables': {
'fontSize': '20px',
'fontSize': '0.8em',
'fontFamily': 'Ubuntu'}}}%%

flowchart TD
prepare_package["Prepare the bug fix, and the SRU template"]
unapproved["Upload the package to the unapproved queue"]
Expand Down
4 changes: 2 additions & 2 deletions docs/how-ubuntu-is-made/concepts/package-archive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ On Ubuntu installations, the Ubuntu package archive is configured as the default
The general flow is that the archive splits into :ref:`Ubuntu series <archive-series>`. Each series is split up into :ref:`pockets <archive-pockets>`, and then each pocket contains four :ref:`components <archive-components>`. This diagram shows a look through a single path:

.. mermaid::
:align: center

%%{init: {'themeVariables': {
'fontSize': '25px',
'fontSize': '1em',
'fontFamily': 'Ubuntu'}}}%%

flowchart TD;
A[Ubuntu package archive] --> B([Splits into Ubuntu **series**]);

Expand Down
20 changes: 8 additions & 12 deletions docs/how-ubuntu-is-made/processes/lifecycle-1-report-triage.txt
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '1.5em',
'fontFamily': 'Ubuntu'}}}%%

flowchart LR
File["<a href=https://documentation.ubuntu.com/project/contributors/qa-and-testing/report-a-bug/>File bug on Launchpad</a><br/>with reproduction steps<br/>and system details"] --> Triage
Triage{"<a href=https://documentation.ubuntu.com/project/contributors/bug-triage/>Triage</a>:<br/>enough information?<br/>right package?<br/>assignee?"}
PrepareFix(["<a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/lifecycle-of-a-change/#preparing-and-testing-the-fix>Prepare change</a>"])
Triage -.-> |"needs more info"| File
File["<a href='/contributors/qa-and-testing/report-a-bug/'>File bug on Launchpad</a><br/>with reproduction steps and system details"] --> Triage
Triage{"<a href='/contributors/bug-triage/'>Triage</a>:<br/>enough information?<br/>right package?<br/>assignee?"}
PrepareFix(["<a href='#preparing-and-testing-the-change'>Prepare change</a>"])
Triage -.-> |"needs<br/>more info"| File
Triage --> |"actionable"| PrepareFix

classDef ubuntuStyle fill:#FFDAB9,stroke:#E95420,stroke-width:2px
class File ubuntuStyle

classDef gateStyle fill:#D0E8FF,stroke:#3366CC,stroke-width:2px
class Triage gateStyle

classDef terminalStyle fill:#E0E0E0,stroke:#666666,stroke-width:2px
class PrepareFix terminalStyle
:::
17 changes: 8 additions & 9 deletions docs/how-ubuntu-is-made/processes/lifecycle-2-prepare-test.txt
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '1.8em',
'fontFamily': 'Ubuntu'}}}%%

flowchart LR
Fix["Prepare change:<br/><a href=https://documentation.ubuntu.com/project/contributors/bug-fix/fix-a-bug-in-a-package/>patch</a> · <a href=https://documentation.ubuntu.com/project/contributors/merging/>merge</a> · <a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/merges-and-syncs/>sync</a>"]
Fix["Prepare change:<br/><a href='/contributors/bug-fix/fix-a-bug-in-a-package/'>patch</a> · <a href='/contributors/merging/'>merge</a> · <a href='/how-ubuntu-is-made/processes/merges-and-syncs/'>sync</a>"]
Fix --> Build
Build["<a href=https://documentation.ubuntu.com/project/contributors/bug-fix/build-packages-in-a-ppa/>PPA build</a> on Launchpad<br/>(all architectures)"]
Build["<a href='/contributors/bug-fix/build-packages-in-a-ppa/'>PPA build</a> on Launchpad<br/>(all architectures)"]
Build -.-> |"build fails"| Fix
Build --> |"build OK"| Test
Test["Run <a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/automatic-package-testing-autopkgtest/>autopkgtests</a><br/>against <a href=https://documentation.ubuntu.com/project/contributors/bug-fix/build-packages-in-a-ppa/>PPA</a> packages"]
Test["Run <a href='/how-ubuntu-is-made/processes/automatic-package-testing-autopkgtest/'>autopkgtests</a><br/>against <a href='/contributors/bug-fix/build-packages-in-a-ppa/'>PPA</a> packages"]
Test -.-> |"test regressions"| Fix
ProposeChange(["<a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/lifecycle-of-a-change/#proposing-and-reviewing>Propose change</a>"])
ProposeChange(["<a href='#proposing-and-reviewing'>Propose change</a>"])
Test --> |"ready"| ProposeChange

classDef ubuntuStyle fill:#FFDAB9,stroke:#E95420,stroke-width:2px
class Fix,Build,Test ubuntuStyle

classDef terminalStyle fill:#E0E0E0,stroke:#666666,stroke-width:2px
class ProposeChange terminalStyle
:::
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '1em',
'fontFamily': 'Ubuntu'}}}%%

flowchart LR
MP["<a href=https://documentation.ubuntu.com/project/contributors/patching/submit-a-merge-proposal/>Submit Merge Proposal</a><br/>on Launchpad"] --> Review
Review{"<a href=https://documentation.ubuntu.com/project/contributors/advanced/review-a-merge-proposal/>Code review</a>"}
MP["<a href='/contributors/patching/submit-a-merge-proposal/'>Submit Merge Proposal</a><br/>on Launchpad"] --> Review
Review{"<a href='/contributors/advanced/review-a-merge-proposal/'>Code review</a>"}
Review -.-> |"changes requested"| Revise["Revise change</a>"]
Revise --> Review
Upload(["<a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/lifecycle-of-a-change/#sponsorship-and-upload>Upload</a>"])
Upload(["<a href='#sponsorship-and-uploads'>Upload</a>"])
Review --> |"approved"| Upload

classDef ubuntuStyle fill:#FFDAB9,stroke:#E95420,stroke-width:2px
class MP,Revise ubuntuStyle

classDef gateStyle fill:#D0E8FF,stroke:#3366CC,stroke-width:2px
class Review gateStyle

classDef terminalStyle fill:#E0E0E0,stroke:#666666,stroke-width:2px
class Upload terminalStyle
:::

Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '1.5em',
'fontFamily': 'Ubuntu'}}}%%

flowchart LR
Rights{"<a href=https://documentation.ubuntu.com/project/who-makes-ubuntu/developers/#path-to-upload-rights>Upload rights</a><br/>for this package?"}
Rights --> |"no: <a href=https://documentation.ubuntu.com/project/contributors/uploading/find-a-sponsor/>Find sponsor</a>"| Sponsor
Sponsor["sponsor <a href=https://documentation.ubuntu.com/project/contributors/advanced/review-a-merge-proposal/>re-reviews</a>"]
Rights{"<a href='/who-makes-ubuntu/developers/#path-to-upload-rights'>Upload rights</a><br/>for this package?"}
Rights --> |"no: <a href='/contributors/uploading/find-a-sponsor/'>Find sponsor</a>"| Sponsor
Sponsor["sponsor <a href='/contributors/advanced/review-a-merge-proposal/'>re-reviews</a>"]
Sponsor --> |"sponsor approves"| Upload
Rights --> |"yes"| Upload
Upload(["<a href=https://documentation.ubuntu.com/project/contributors/uploading/>Upload to Ubuntu Archive</a>"])

classDef ubuntuStyle fill:#FFDAB9,stroke:#E95420,stroke-width:2px
class Sponsor ubuntuStyle

classDef gateStyle fill:#D0E8FF,stroke:#3366CC,stroke-width:2px
class Rights gateStyle
Upload(["<a href='/contributors/uploading/'>Upload to Ubuntu Archive</a>"])

classDef terminalStyle fill:#E0E0E0,stroke:#666666,stroke-width:2px
class Upload terminalStyle
:::
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '0.4em',
'fontFamily': 'Ubuntu'}}}%%

flowchart TD
Build{Builds}
Fix["Please fix & re-upload"]
Autopkg{"<a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/automatic-package-testing-autopkgtest/>Autopkgtests</a>"}
InvestigateAPKGT["<a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/proposed-migration/autopkgtest-regressions/>Investigate regressions</a>"]
ArchiveChecks{"<a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/proposed-migration/issues-preventing-migration/>Archive consistency</a><br/>(<a href=https://ubuntu-archive-team.ubuntu.com/proposed-migration/update_excuses.html>Britney</a>)"}
Autopkg{"<a href='/how-ubuntu-is-made/processes/automatic-package-testing-autopkgtest/'>Autopkgtests</a>"}
InvestigateAPKGT["<a href='/how-ubuntu-is-made/processes/proposed-migration/autopkgtest-regressions/'>Investigate regressions</a>"]
ArchiveChecks{"<a href='/how-ubuntu-is-made/processes/proposed-migration/issues-preventing-migration/'>Archive consistency</a><br/>(<a href='https://ubuntu-archive-team.ubuntu.com/proposed-migration/update_excuses.html'>Britney</a>)"}
Done(["Migrates"])
Build -.-> |"<a href=https://documentation.ubuntu.com/project/how-ubuntu-is-made/processes/proposed-migration/failure-to-build-from-source-ftbfs/>FTBFS"</a>| Fix

Build -.-> |"<a href='/how-ubuntu-is-made/processes/proposed-migration/failure-to-build-from-source-ftbfs/'>FTBFS"</a>| Fix
Build --> |"all builds OK"| Autopkg

Autopkg -.-> |"regressions"| InvestigateAPKGT
Autopkg --> |"all pass"| ArchiveChecks

InvestigateAPKGT -.-> |"Real problem"| Fix
InvestigateAPKGT --> |"Transient issues, now resolved"| ArchiveChecks

ArchiveChecks -.-> |"blocked by dependencies"| Fix
ArchiveChecks --> |"all checks OK"| Done

classDef ubuntuStyle fill:#FFDAB9,stroke:#E95420,stroke-width:2px
class Fix,InvestigateAPKGT ubuntuStyle

classDef gateStyle fill:#D0E8FF,stroke:#3366CC,stroke-width:2px
class Build,Autopkg,ArchiveChecks gateStyle

classDef terminalStyle fill:#E0E0E0,stroke:#666666,stroke-width:2px
class Done terminalStyle
:::
6 changes: 4 additions & 2 deletions docs/how-ubuntu-is-made/processes/lifecycle-of-a-change.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '2em',
'fontFamily': 'Ubuntu'}}}%%

flowchart LR
BugReport["<a href='#lc-bug-report-and-triage'>Bug Report<br/>&amp; Triage</a>"]
PrepareTest["<a href='#lc-prepare-fix'>Prepare<br/>&amp; Test</a>"]
Expand All @@ -14,7 +18,5 @@ flowchart LR
Upload -.-> |"active release"| SRU
SRU --> Migration

classDef ubuntuStyle fill:#FFDAB9,stroke:#E95420,stroke-width:2px
class BugReport,PrepareTest,Review,Migration,Upload,SRU ubuntuStyle
:::

Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,10 @@ Sometimes a package builds successfully locally (and even in a PPA), but fails i
[pkgbinarymangler](https://launchpad.net/ubuntu/+source/pkgbinarymangler) is one of those upload-only steps. It is disabled for all PPA builds (except for `OEM PPA`) and also absent from most local build environments unless `pkgbinarymangler` is explicitly installed.

```{mermaid}
%%{init: {'themeVariables': {
'fontSize': '1em',
'fontFamily': 'Ubuntu'}}}%%

flowchart TD
A["dh_builddeb<br>(manages lockfile)"] --> B["Lockfile<br>(queue)"]
B -->|"wait(head==package1)"| C["dpkg-deb.pkgbinarymangler<br>Binary Package 1"]
Expand Down Expand Up @@ -197,4 +201,4 @@ To reproduce this issue locally, install `pkgbinarymangler` in your build enviro

```none
$ sudo apt install -y pkgbinarymangler
```
```
4 changes: 4 additions & 0 deletions docs/who-makes-ubuntu/councils/dmb-manage-packagesets.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Think of it as a relation between Launchpad personas and a list of packages.

```{mermaid}
%% mermaid flowcharts documentation: https://mermaid.js.org/syntax/flowchart.html
%%{init: {'themeVariables': {
'fontSize': '0.6em',
'fontFamily': 'Ubuntu'}}}%%

flowchart TD
%% Entities
Developers["Developer"]
Expand Down
14 changes: 8 additions & 6 deletions docs/who-makes-ubuntu/developers/diagrams/advanced.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '1em',
'fontFamily': 'Ubuntu'}}}%%

block-beta
columns 3

block:left
AdvancedStudies("Advanced studies")
columns 1
space:3
StudyFFe{{"<a href=https://documentation.ubuntu.com/project/release-team/freeze-exceptions/>Study FFe</a>"}}
PlusOne{{"<a href=https://documentation.ubuntu.com/project/contributors/advanced/plus-one-maintenance/>Study +1</a>"}}
StudyFFe{{"<a href=/release-team/freeze-exceptions/>Study FFe</a>"}}
PlusOne{{"<a href=/contributors/advanced/plus-one-maintenance/>Study +1</a>"}}
end

block:middle
Expand All @@ -23,9 +27,9 @@ block-beta
block:right
columns 2
space
PPU["<a href='https://documentation.ubuntu.com/project/who-makes-ubuntu/developers/dmb-joining-ppu/'>PPU*</a>"]
PPU["<a href='/who-makes-ubuntu/developers/dmb-joining-ppu/'>PPU*</a>"]
space
PackageSet["<a href='https://documentation.ubuntu.com/project/who-makes-ubuntu/developers/dmb-joining-packageset/'>Packageset</a>"]
PackageSet["<a href='/who-makes-ubuntu/developers/dmb-joining-packageset/'>Packageset</a>"]
space:8
end

Expand All @@ -34,8 +38,6 @@ block-beta
StudyFFe --> DoAnFFe
PlusOne --> PlusOneShadowing

classDef Studies fill: #FFDAB9, stroke:#F4A460;
class AdvancedStudies,AdvancedTasks Studies
classDef invisible fill:transparent,stroke:transparent;
class left,middle,right invisible
:::
Expand Down
8 changes: 5 additions & 3 deletions docs/who-makes-ubuntu/developers/diagrams/basics.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
:::{mermaid}
%%{init: {'themeVariables': {
'fontSize': '1em',
'fontFamily': 'Ubuntu'}}}%%

block-beta
columns 2
block:left
Expand All @@ -12,15 +16,13 @@ columns 2
block:right
InitialTasks("Initial tasks")
columns 1
BugTriage["<a href='https://documentation.ubuntu.com/project/contributors/bug-triage/'>Bug triage</a>"]
BugTriage["<a href='/contributors/bug-triage/'>Bug triage</a>"]
BiteSizedBugs["Bite-sized bugs"]
TrivialPackgeMerges["Trivial package merges"]
end

InitialStudies --> InitialTasks

classDef Studies fill: #FFDAB9, stroke:#F4A460;
class InitialStudies,InitialTasks Studies
classDef invisible fill:transparent,stroke:transparent;
class left,right invisible
:::
Loading
Loading