Uninett / zino

Zino 2.0 - Network state monitor for research networks
Apache License 2.0
4 stars 5 forks source link

Properly document Zino #381

Open lunkwill42 opened 2 weeks ago

lunkwill42 commented 2 weeks ago

The legacy Zino state monitor has no public documentation that would aid new users in understanding what Zino is and what is design concepts are. Writing this type of documentation was never part of the original Zino 2.0 project specification - but it is nonetheless important if we want new users to be able to adopt Zino.

The best format for this documentation going forward with Zino 2 would be Sphinx documentation (i.e. mostly plain text / reStructured Text markup, or potentially markdown). The question is whether Håvard should be the one to begin the writing process, or if it should be more collaborative.