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

Add some diagrams to the documentation #1914

Open
NuvandaPV opened this issue Nov 4, 2019 · 3 comments

Comments

@NuvandaPV
Copy link
Contributor

@NuvandaPV NuvandaPV commented Nov 4, 2019

It would be nice to have a few diagrams in the documentation. Specifically I think a deployment diagram giving an example for the components involved in a typical use of push tokens, as well as sequence diagrams for the three authentication modes would be nice.

@cornelinux

This comment has been minimized.

Copy link
Member

@cornelinux cornelinux commented Nov 5, 2019

This would be great.

It would be great if we could do a structural apptoach. I think there is a markdown extension to do diagrams.
(To avoid to actually draw stuff)

@plettich

This comment has been minimized.

Copy link
Member

@plettich plettich commented Nov 12, 2019

Do You mean the readthedocs documentation or the guthub docs?
RTD uses reST and github Markdown.
PlantUML looks promising. It works with Markdown and RestructuredText.

@NuvandaPV

This comment has been minimized.

Copy link
Contributor Author

@NuvandaPV NuvandaPV commented Nov 12, 2019

I was mainly referring to RTD. PlantUML is the approach I am favoring as well. I have written a few diagrams locally. I am not sure on the best way to add the though.
Apparently readthedocs.org has recently gained the ability to render PlantUML, however it is woefully undocumented (see this issue).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.