grimoirelab-tutorial icon indicating copy to clipboard operation
grimoirelab-tutorial copied to clipboard

Add initial support to represent diagrams with Mermaid

Open dplanella opened this issue 5 years ago • 5 comments

Adds support for generating diagrams with Mermaid for easier maintenance and for lowering the barrier to documentation contributions.

Notes:

  • I only replaced one diagram for now to gather feedback. If this change is accepted, happy to convert the rest to Mermaid as well.
  • The diagram can be displayed top-down as well (less compact, better for mobile view) by replacing the graph LR line by graph TD

dplanella avatar Jun 04 '19 07:06 dplanella

Pretty cool. I need to play with mermaid to understand its full capabilities. Thanks @dplanella

acs avatar Jun 04 '19 07:06 acs

-1 , I would prefer to replace the diagrams with artworks (pngs files derived from svg ones) as proposed at: https://github.com/chaoss/grimoirelab-tutorial/pull/6

valeriocos avatar Jun 04 '19 07:06 valeriocos

Thanks for the reviews. The ideas behind it were to ultimately lower the barrier for contribution, as:

  • Bitmaps are not accessible
  • Not everyone feels comfortable with using an SVG editor, but everyone can use a text editor to generate or update the diagrams
  • Enables contributors to edit the diagrams online with the GitHub web UI.
  • The diagram at https://github.com/chaoss/grimoirelab-tutorial/pull/6/ could still be used as a nicer representation of how all the tools/backends work together, as an overview on the tutorial landing page.

dplanella avatar Jun 12 '19 17:06 dplanella

@acs @valeriocos @jgbarah any further thoughts on this PR? Thanks.

dplanella avatar Jun 18 '19 07:06 dplanella

I'm fine with any decision @dplanella :)

valeriocos avatar Jun 18 '19 11:06 valeriocos