Clearly moving away from binary image formats is a huge benefit as it allows to diff them, which is very nice.
But as least people write SVGs manually, the diff is not very self-explanatory: Drawing software often completely rewrites the SVG or adds clutter.
So I see a source-based image format the most useful.
While I do not know Asciidoctor very well, I think it is exactly what we should strive for.
If Jakarta EE spec moves to Asciidoctor and this works well, I could imagine that most Jakarta specs would follow.
-Markus
Von: jakartaee-platform-dev [mailto:jakartaee-platform-dev-bounces@xxxxxxxxxxx] Im Auftrag von Ivar Grimstad
Gesendet: Donnerstag, 3. Juni 2021 08:14
An: jakartaee-platform-dev@xxxxxxxxxxx
Betreff: [jakartaee-platform-dev] Image formats in the specification
Hi,
I can't remember if we reached any conclusion for how to handle the images, diagrams, and illustrations in the specification document.
Currently, there is a pull request for replacing the PNGs with SVGs [1] that needs some feedback.
Does this conversion step help now? Or should we move directly to a text-based format to generate the diagrams from the Asciidoc to make editing easier? Something like AsciiDoctor Diagram [2]?
--
Ivar Grimstad
Jakarta EE Developer Advocate | Eclipse Foundation Eclipse Foundation - Community. Code. Collaboration.