openservicebrokerapi / servicebroker

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

Add diagram of workflows #364

Closed mattmcneeney closed 6 years ago

mattmcneeney commented 7 years ago

Following on from #361 and the discussion last night's call, here is a PR that adds a diagram of the platform to service broker workflows to the repository.

The diagram is a Google Drawing hosted in the OSBAPI Google Drive folder which all PMC members should be able to edit. The new diagram.md file automatically renders the live version of the linked drawing. I'm hoping this is a sensible approach as it means nobody has to learn any new 'drawing languages'.

I also updated CONTRIBUTING.md to ensure the workflow diagram is updated on a spec release (which I presume is the most sensible time that we will do this).

Feedback is welcome!

cfdreddbot commented 7 years ago

Hey mattmcneeney!

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 7 years ago

you could use a relative URL for the diagram so that Travis doesn't fail?

angarg12 commented 7 years ago

LGTM

Approved with PullApprove

avade commented 7 years ago

LGTM

Approved with PullApprove

duglin commented 6 years ago

LGTM

Approved with PullApprove

fmui commented 6 years ago

LGTM

Approved with PullApprove

vaikas commented 6 years ago

LGTM

Approved with PullApprove