Modernize Process States Overview

[dviererbe]

I found out that GitHub supports mermaid (basically a code-to-diagram framework). I also overhauled the text content/arrangement in the section a little bit.

[dviererbe]

note: it is fine, that the spell checker fails. #20 fixes the errors.

[cpaelzer]

This is a great start, I've left a few suggestions as well as questions to make even more use of the new ability to be less space limited now.

[cpaelzer]

An important aspect of the old graph was that each valid state (anything not in the graph is invalid) has a tuple of Assignment+State. This is somewhat lost now. A few examples:

This is great, but currently I miss a bit of continuity.
At the top the state set for new/confirmed is a yellowish box.
Down there all the state set actions for "Won't Fix", "In Progress" are purple boxes.
But at the top purple boxes are not state changes, they are assignee changes.

Could we make all state-changes purple boxes, and make all assignment changes e.g. yellow hexagons or something like that. So that the shape/color directly indicates what is expected to happen at this point?

[dviererbe]

Although mermaid flowchart's allow to set the color, I would recommend against it, because if we set a color, it does not change with the github theme (selected by a user).

This can result in bad visibility for people that require e.g. a dark high contrast theme.

But I incorporated more distinguishable shapes and removed the subgraph.

[github-actions]

@check-spelling-bot Report

🔴 Please review

See the 📂 files view or the 📜action log for details.

Unrecognized words (2)

URLs
workaround

To accept ✔️ these unrecognized words as correct, run the following commands

... in a clone of the git@github.com:dviererbe/ubuntu-mir.git repository
on the modernize-process-states-overview branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/canonical/ubuntu-mir/actions/runs/5256386511/attempts/1'

Available 📚 dictionaries could cover words not in the 📘 dictionary

This includes both expected items (10) from .github/actions/spelling/expect.txt and unrecognized words (2)

Dictionary	Entries	Covers
cspell:cpp/src/cpp.txt	30216	4
cspell:win32/src/win32.txt	53509	2
cspell:php/php.txt	2597	2
cspell:cpp/src/stdlib-c.txt	290	2
cspell:ruby/ruby.txt	278	1
cspell:r/src/r.txt	808	1
cspell:python/src/python/python-lib.txt	3873	1
cspell:fullstack/fullstack.txt	390	1

Consider adding them using (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/cpp.txt
          cspell:win32/src/win32.txt
          cspell:php/php.txt
          cspell:cpp/src/stdlib-c.txt
          cspell:ruby/ruby.txt
          cspell:r/src/r.txt
          cspell:python/src/python/python-lib.txt
          cspell:fullstack/fullstack.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''

✏️ Contributor please read this

By default the suggested command will add the listed items to the .github/actions/spelling/expect.txt. This is not allways desired!

If a listed items is

• ... misspelled, then please correct them instead of changing the spell checker configuration.
• ... an actual word/term that has a high probability of showing up in future contributions, please add it to the allowed words.
• ... an term/word that just you use or shouldn't generally be accepted, please add it to .github/actions/spelling/expect.txt.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push – it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

[cpaelzer]

Oh yeah, this looks much nicer.
I can see states, differentiate them from final-states, triggers, actions/decisions.

Let us bring the pre-rendering vs old ascii-art up in next weeks meeting for group exposure before merging.

[cpaelzer]

At the meeting we should look at it in rendered form:

• old: https://github.com/canonical/ubuntu-mir/blob/main/README.md#process-states
• new: https://github.com/dviererbe/ubuntu-mir/tree/modernize-process-states-overview#process-states