Feature specification content on the website

[strogonoff]

No description provided.

[strogonoff]

Upstream issues:

• Build fetched specification docsets using Metanorma flow riboseinc/jekyll-theme-open-project-helpers#9 — implement build Metanorma -> HTML
• Show Metanorma-built specification content on website riboseinc/jekyll-theme-open-project#38 — integrate built HTML into open project site

[strogonoff]

Current implementation integrates model diagrams (screenshot). To do before release:

• Fix specification layout to match software docs (with expandable narrow-viewport-friendly navigation bar)
• Make build work with Metanorma-based specs in addition to PNG diagrams

[ronaldtse]

I wonder if we should directly incorporate PlantUML into site generation rather than relying on PNG files?

[strogonoff]

Sure, could be another plugin. This one is convenient in that if you switch to another diagram generator it won’t break project sites downstream, and that it takes any PNGs, not just a UML spec.

…

On 25 Nov 2018, at 8:32 PM, Ronald Tse ***@***.***> wrote: I wonder if we should directly incorporate PlantUML into site generation rather than relying on PNG files? — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub, or mute the thread.

[ronaldtse]

Yes indeed. Maybe that is desirable. Let's hold off PlantUML for now.

[strogonoff]

Yeah seems pragmatic to hold off PlantUML for now since handling its dependencies (or containerizing the whole thing) complicates things. Adding the Metanorma engine next, there’re some challenges there too. PNG illustration engine to fix #34 is working at the moment, pending deployment: http://www.metanorma.com/specs/metanorma-model-gb/

[ronaldtse]

BTW it is easy to build Metanorma documents now using Travis, you can see the Travis CI file here https://github.com/riboseinc/ogc-tcpnp.

So it should be really easy to have a Jekyll plugin that renders Metanorma.

[strogonoff]

To build PlantUML sources into SVG, rather than rely on images being part of model repo, it should be possible to call these methods: https://github.com/nus/gitbucket-plantuml-plugin/blob/master/src/main/scala/com/yotaichino/gitbucket/plugins/plantuml/PlantUMLUtils.scala#L12

[ronaldtse]

You can consider the asciidoctor-diagram gem that allows this?