search

openservicebrokerapi / servicebroker

Open Service Broker API Specification
https://openservicebrokerapi.org/
Apache License 2.0
1.19k stars 434 forks source link

[WIP] to swap google doc for mermaidjs diagrams #383

Closed JJediny closed 6 years ago

JJediny commented 6 years ago

FOR DISCUSSION ONLY: See #374

cfdreddbot commented 6 years ago

Hey JJediny!

Thanks for submitting this pull request! I'm here to inform the recipients of the pull request that you and the commit authors have already signed the CLA.

avade commented 6 years ago

We use mermaidjs for diagrams in Pivotal docs and it is much easier to maintain vs static pictures.

In terms of the styling here, font and sizing could be smaller.

n3wscott commented 6 years ago

I like this idea. I have been a graphviz user for a long time, programmatic charts are great.

mattmcneeney commented 6 years ago

Hey @JJediny I'm still keen to move this into the spec. Are there any outstanding issues with this?

duglin commented 6 years ago

During this week's call we discussed this and there was no objection with heading this direction.

duglin commented 6 years ago

@JJediny What do we need to do to move this one forward? Does someone need to create some kind of build process to build the images as part of a PR? Is this something you want to do?

JJediny commented 6 years ago

The next few weeks don't look good for me doing much proactive work to support this; but want to help it see it through. Would like someone to propose the ideal workflow for updating (either as steps to re-gen or build into CI).

duglin commented 6 years ago

Any update on this? If no one has the time to work on it then I'm wondering if we should close it, or move it back to just an issue and then reopen the PR if/when someone has time.

n3wscott commented 6 years ago

Reopen if there is need.

mattmcneeney commented 6 years ago

We'll need to update the Workflows diagram soon to cover async bindings!