Skip to content

Commit

Permalink
doc/submitter_guide: replace block diagram with png
Browse files Browse the repository at this point in the history
The "block-beta" diagram used was introduced in mermaid v10.8, and we're
not there yet in our documentation deployment.

The PNG added by this commit has meta data that allows it to be edited
as a diagram using tools like draw.io, also known as diagrams.net.

Signed-off-by: Tales da Aparecida <[email protected]>
  • Loading branch information
Tales da Aparecida authored and spbnick committed Oct 8, 2024
1 parent 811a4ba commit f0f1c76
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 55 deletions.
Binary file added doc/mapping-test-status-and-responsibility.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 6 additions & 55 deletions doc/submitter_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,61 +318,12 @@ or is still executing, and so we have no status data yet.
Another way to visualize the status values and the three layered testing stack,
is to put them into an execution outcome chart:

```mermaid
block-beta
columns 5
B1("SKIP\ntest not applicable")
space
C1("DONE\nno test result required")
space
D1("PASS\ncode fulfilled requirements")
space:5
A["schedule test"]
space
B["run test"]
space
C["evaluate result"]
space:5
B2("MISS\ntest could not be run\n") space
C2("ERROR\ntest could not be completed") space
D2("FAIL\ncode failed requirements")
B3["responsibility: CI maintainer"]
space
C3["responsibility: test maintainer"]
space
D3["responsibility: kernel developer"]
A -.-> B
A --> B1
A --> B2
B -.-> C
B --> C1
B --> C2
C --> D1
C --> D2
style A fill:#F5F5F5,stroke:#666666,stroke-width:1px,color:#000
style B fill:#F5F5F5,stroke:#666666,stroke-width:1px,color:#000
style C fill:#F5F5F5,stroke:#666666,stroke-width:1px,color:#000
style B1 fill:#D9EAD3,stroke:#82B366,stroke-width:1px,color:#000
style C1 fill:#D9EAD3,stroke:#82B366,stroke-width:1px,color:#000
style D1 fill:#D9EAD3,stroke:#82B366,stroke-width:1px,color:#000
style B2 fill:#FFF2CC,stroke:#D6B656,stroke-width:1px,color:#000
style C2 fill:#FFE6CC,stroke:#D79B00,stroke-width:1px,color:#000
style D2 fill:#f4cccc,stroke:#B85450,stroke-width:1px,color:#000
style B3 fill:transparent,stroke:transparent,color:#6C8EBF
style C3 fill:transparent,stroke:transparent,color:#6C8EBF
style D3 fill:transparent,stroke:transparent,color:#6C8EBF
```
![The image is a flowchart showing test result statuses: "schedule test" leads
to "SKIP" (test not applicable), "MISS" (test not run, CI maintainer
responsible), "run test" leads to "DONE" (no result needed), "ERROR" (test
not completed, test maintainer responsible), then "evaluate result" leads to
"PASS" (requirements met) or "FAIL" (requirements failed, kernel developer
responsible).](mapping-test-status-and-responsibility.png)

Example: `"FAIL"`

Expand Down

0 comments on commit f0f1c76

Please sign in to comment.