Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discussion: Inline graph handling #69

Open
PeterJCLaw opened this issue Aug 31, 2019 · 2 comments
Open

Discussion: Inline graph handling #69

PeterJCLaw opened this issue Aug 31, 2019 · 2 comments
Labels
Tooling Relates to the runbook platform software rather than actual SR documentation

Comments

@PeterJCLaw
Copy link
Member

Since merging #35 we now have some inline graph rendering from mermaidjs via https://github.com/pugong/mkdocs-mermaid-plugin. This works ok for small graphs (for example the asset lifecycle flowchart), but starts to degrade for larger ones (see #68 for an experiment in that regard).

GraphViz is the usual defacto tool for command line usage and typically outputs reasonable graphs and I did explore using it previously. It would mean adding another dependency (and one we're not sure about the windows support for), but would likely mean better graphs and offline development. The latter is something I do think we should aim for.

In terms of GraphViz: https://github.com/sprin/markdown-inline-graphviz was what I'd explored previously, though it didn't interact well with mkdocs (see sprin/markdown-inline-graphviz#8 (comment) for the generalisation of the issue I hit). It looks like https://github.com/cesaremorel/markdown-inline-graphviz might be interested in updating that, though it's not clear whether that project is just Python 3 support or other extensions too.

@RealOrangeOne
Copy link
Member

I don't think there's any strong ties to mermaid, although the fact it doesn't require any external dependencies is quite nice.

Is there a way to render the GraphViz in the browser / in pure python instead? Save having to install it on every machine which wants to develop the runbook.

@trickeydan
Copy link
Contributor

Is there a way to render the GraphViz in the browser / in pure python instead? Save having to install it on every machine which wants to develop the runbook.

JS Library: http://viz-js.com/

Python graph drawing library: https://github.com/bdcht/grandalf

@PeterJCLaw PeterJCLaw added the Tooling Relates to the runbook platform software rather than actual SR documentation label Oct 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Tooling Relates to the runbook platform software rather than actual SR documentation
Projects
None yet
Development

No branches or pull requests

3 participants