crossbario / crossbar

Crossbar.io - WAMP application router
https://crossbar.io/
Other
2.05k stars 274 forks source link

Draw figures for authentication and cookie handling #760

Open goeddea opened 8 years ago

goeddea commented 8 years ago

from @oberstet

Draw figures from these sketches in LibreOffice Draw / Inkskape: https://github.com/crossbario/crossbardocs/tree/master/work/docs/auth

migrated from https://github.com/crossbario/crossbardocs/issues/37

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/33648773-draw-figures-for-authentication-and-cookie-handling?utm_campaign=plugin&utm_content=tracker%2F462544&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F462544&utm_medium=issues&utm_source=github).
meejah commented 8 years ago

Might be worth looking at seqdiag for this; not sure how easy it would be to get it to spit out custom colors/styling etc. but ...

oberstet commented 8 years ago

I think, for now, we should restrict "figures" in the CB docs here to be ASCII art, like we have for the WAMP spec eg.

IOW: there must not be image file types in this repo (like png, jpg or svg).

meejah commented 8 years ago

There's also this: http://ditaa.sourceforge.net/ which turns ASCII drawings into PNGs etc. I haven't used it, but seqdiag (http://blockdiag.com/en/seqdiag/index.html) is nice and simple (there's also a Sphinx plugin) and should be really good for drawing the linked diagrams and fulfilling the "no PNGs in the repo" requirement :)

That is, we'd put the seqdiag source in the repo and build the images from it (seqdiag looks a lot like GrahpViz/dot syntax).

matthewh commented 6 years ago

@oberstet @meejah The original links from @goeddea are no longer working. Where are they now?

I'll go out on a limb and say https://github.com/crossbario/crossbar/tree/master/docs/pages/administration/auth. Where are the sketches?