Add RFC process document (#369) + mermaid dependencies #427
Conversation
Try and improve display onf mermaid Try and fix the mermaid dimensions Remove clutter on mermaid config
Automated Review URLs |
|
A screenshot of the diagram on https://ngff--427.org.readthedocs.build/resources/process/index.html 
|
|
The link from the RFC page to the new page resolves as |
Updated the link to the RFC process page for clarity.
|
Thanks, @lubianat, for driving this. As discussed with @clbarnes and @jo-mueller, converting the Google Drawing to a SVG might be something we still want to consider. If you think that will delay getting this out, 👍 for splitting into multiple parts. Also as we discussed, for the text change, it might still be worth thinking through whether this actually is the beginning of a wider "governance" document and either way, we likely need to make it clear that any (significant) change to this document requires an RFC of its own. |
|
@joshmoore I think changing to SVG might improve readability, but may come itself with a set of issues (e.g. mobile view, screen types and such). There could be other visualization options, but maybe splitting is better to avoid dragging this PR too long. What would be the minimum for getting this out? Maybe a disclaimer on the top?
Perhaps something similar to the Warning in #404 
Would this suffice to mitigate risks? |
|
Yeah, let's get that in place and then I'll make one read through and we can move forward. |
|
A quick thanks for picking this up, and sorry I didn't have time to fix it in the end. |
Aligned better the text with RFC 1 Added colors Single graph rendered weirdly, unreadable.Divided the graph in 3 to try and improve readability (mixed success)
Uses class instantiation for colors Tweaks font size and other config parameter Fixes subgraph title display bugs using workaround
|
This was the best I could do w.r.t. readability. Not everything is perfect as the sphinx-myst-rst-md-mermaid interfaces have a lot of small details The text (for the flowchart) is revised and matching RFC 1 to the best that I can. 
|
|
This pull request has been mentioned on Image.sc Forum. There might be relevant details there: https://forum.image.sc/t/ngff-weekly-dev-update-thread/110810/56 |
4 participants
this extends #369, adding the mermaid dependencies for the flowchart to build and organizing the documentation around the RFC process .