[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[tor-bugs] #7376 [Ooni]: Reorganize the documentation
#7376: Reorganize the documentation
---------------------------+------------------------------------------------
Reporter: hellais | Owner: hellais
Type: task | Status: new
Priority: critical | Milestone:
Component: Ooni | Version:
Keywords: documentation | Parent:
Points: | Actualpoints:
---------------------------+------------------------------------------------
Currently our documentation is a mess.
It is distributed across multiple different places and there is no central
way of knowing which one is right.
Here is the list of all the current documentation locations:
https://trac.torproject.org/projects/tor/wiki/doc/OONI/ThreatModel
https://trac.torproject.org/projects/tor/wiki/doc/OONI/TestWritingMethodology
https://trac.torproject.org/projects/tor/wiki/doc/OONI/Architecture
https://trac.torproject.org/projects/tor/wiki/doc/OONI/Backend
https://trac.torproject.org/projects/tor/wiki/doc/OONI/Tests
https://trac.torproject.org/projects/tor/wiki/doc/OONI/DataCollection
https://trac.torproject.org/projects/tor/wiki/doc/OONI/SetupHowto
http://ooni.readthedocs.org/en/latest/
We are currently using for the developer documentation readthedocs.org:
http://ooni.readthedocs.org/en/latest/
The reason for doing so is that it will automatically build the sphinx
documentation for us and we don't have to worry about setting up anything
on torproject machines to create these docs.
The documentation that is currently stored on the wiki should be moved to
.rst files that are in:
https://gitweb.torproject.org/ooni-probe.git/tree/HEAD:/docs/source
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/7376>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs