diff --git a/docs/Diagram-Guidelines.md b/docs/Diagram-Guidelines.md index 7267ef9f65..a31669784e 100644 --- a/docs/Diagram-Guidelines.md +++ b/docs/Diagram-Guidelines.md @@ -4,7 +4,7 @@ For complex diagrams, use the `.drawio.svg` format. -Files with the `.drawio.svg` extension are SVG files with embedded [draw.io](https://www.diagrams.net/) source code. Using that format lends itself to a developer-friendly workflow: it is valid SVG, plays well with `git diff` and can be edited in lock-step using various online and offline flavours of draw.​io. If you use VS Code, you can use an [extension](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) for draw.​io integration. +Files with the `.drawio.svg` extension are SVG files with embedded [draw.io](https://www.diagrams.net/) source code. Using that format lends itself to a developer-friendly workflow: it is valid SVG, plays well with `git diff` and can be edited in lock-step using various online and offline flavours of draw.io. If you use VS Code, you can use an [extension](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) for draw.io integration. Files in the `.drawio.svg` format can be processed offline. @@ -12,7 +12,7 @@ Files in the `.drawio.svg` format can be processed offline. To embed a `.drawio.svg` file into Markdown, use the same syntax as for any image. Example: `![My diagram](my-diagram.drawio.svg)` -Mind that GitHub doesn’t allow styling in Markdown documents. Where styling is allowed (e. g. in the exported brew.sh version of the documentation), always set a background colour of `white` for the diagram. That’s the colour draw.​io assumes, and keeps the diagram easy to read in dark mode without further customization. You can use the CSS selector `img[src$=".drawio.svg"]` for styling. +Mind that GitHub doesn’t allow styling in Markdown documents. Where styling is allowed (e.g. in the exported brew.sh version of the documentation), always set a background colour of `white` for the diagram. That’s the colour draw.io assumes, and keeps the diagram easy to read in dark mode without further customization. You can use the CSS selector `img[src$=".drawio.svg"]` for styling. ## Example diff --git a/docs/assets/img/docs/managing-pull-requests.drawio.svg b/docs/assets/img/docs/managing-pull-requests.drawio.svg index 508802d73c..66197c84d4 100644 --- a/docs/assets/img/docs/managing-pull-requests.drawio.svg +++ b/docs/assets/img/docs/managing-pull-requests.drawio.svg @@ -1,14 +1,14 @@ - + - + - - + + -
+
Yes @@ -16,17 +16,17 @@
- + Yes - - + + -
+
No, it’s @@ -36,7 +36,7 @@
- + No, it’s... @@ -62,41 +62,43 @@ - - - + + + -
+

- brew pr-pull + hub checkout

- - brew pr-pull + + hub checkout - + -
+
Modify and push +
+ to PR branch
- - Modify and push + + Modify and push... @@ -121,12 +123,12 @@ - - + + -
+
No, @@ -138,17 +140,17 @@
- + No,... - - + + -
+
Yes @@ -156,16 +158,16 @@
- + Yes - + -
+
Does it @@ -182,17 +184,17 @@
- + Does it... - - + + -
+
Yes @@ -200,17 +202,17 @@
- + Yes - - + + -
+
No/not yet @@ -222,16 +224,16 @@
- + No/not yet... - + -
+
CI passed? @@ -239,17 +241,17 @@
- + CI passed? - - + + -
+
Yes @@ -257,17 +259,17 @@
- + Yes - - + + -
+
No @@ -275,16 +277,16 @@
- + No - + -
+
Version or @@ -296,17 +298,17 @@
- + Version or... - - + + -
+
No, it’s @@ -318,17 +320,17 @@
- + No, it’s... - - + + -
+
Yes @@ -336,16 +338,16 @@
- + Yes - + -
+
Existing @@ -355,17 +357,17 @@
- + Existing... - - + + -
+
Yes @@ -373,52 +375,38 @@
- + Yes + + -
+
- Yes -
-
-
- - - Yes - - - - - - - - -
-
-
- No, it’s + No, +
+ it’s
urgent
- - No, it’s... + + No,... - + -
+
Can it wait? @@ -426,33 +414,43 @@
- + Can it wait? - + -
+
- Accept and wait for test-bot +
+ Approve ✅ PR and wait  + + for BrewTestBot + +
+
+ + to merge + +
- - Accept and wait... + + Approve ✅ PR and... - + -
+

@@ -464,25 +462,312 @@

- + brew... - + -
+
- Push the button + Push the +
+ “Rebase and merge” button
- - Push the button + + Push the... + + + + + + + + +
+
+
+ Yes +
+
+
+ + + Yes + + + + + + + + +
+
+
+ No/ +
+ don’t +
+ care +
+
+
+ + + No/... + + + + + + + +
+
+
+ Prefer to +
+ run CI after- +
+ wards? +
+
+
+ + + Prefer to... + + + + + + + + +
+
+
+ Yes +
+
+
+ + + Yes + + + + + + + +
+
+
+ Does it +
+ say  + + bottle +
+ :unneeded + +
+ ? +
+
+
+ + + Does it... + + + + + + + + +
+
+
+ No, +
+ it needs +
+ bottles +
+
+
+ + + No,... + + + + + + + + +
+
+
+ Yes +
+
+
+ + + Yes + + + + + + + +
+
+
+ Rebuild +
+ bottles after- +
+ wards? +
+
+
+ + + Rebuild... + + + + + + + + +
+
+
+ No, they’re +
+ not affected +
+
+
+ + + No, they’re... + + + + + + + + +
+
+
+ Yes +
+
+
+ + + Yes + + + + + + + + +
+
+
+ No, merge +
+ immediately +
+
+
+ + + No, merge... + + + + + + + +
+
+
+ Want to +
+ push to the PR +
+ branch? +
+
+
+ + + Want to... + + + + + + + + + +
+
+
+

+ brew pr-pull +

+
+
+
+ + + brew pr-pull + + + + + + + +
+
+
+ Modify and push +
+ to master +
+
+
+ + + Modify and push...