[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

Re: [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:  ooni_documentation, SponsorH201210  |         Parent:         
   Points:                                      |   Actualpoints:         
------------------------------------------------+---------------------------

Comment(by aagbsn):

 Documentation is now located at https://ooni.torproject.org/docs.

 https://trac.torproject.org/projects/tor/wiki/doc/OONI/ThreatModel
 is not yet ported to ooni.torproject.org/docs

 https://trac.torproject.org/projects/tor/wiki/doc/OONI/TestWritingMethodology
 is now: https://ooni.torproject.org/docs/writing_tests.html

 https://trac.torproject.org/projects/tor/wiki/doc/OONI/Architecture
 is now: https://ooni.torproject.org/docs/architecture.html

 https://trac.torproject.org/projects/tor/wiki/doc/OONI/Tests
 see: https://ooni.torproject.org/docs/index.html#core-ooniprobe-tests
 and: https://ooni.torproject.org/docs/nettests/modules.html

 https://trac.torproject.org/projects/tor/wiki/doc/OONI/DataCollection
 This needs to be more thoroughly documented and linked to the oonib
 documentation. For example, there should be a page describing the report
 format, and also link to the backend setup and use of ooni-probe with a
 collector. See also below:

 https://trac.torproject.org/projects/tor/wiki/doc/OONI/Backend
 is briefly mentioned here:
 https://ooni.torproject.org/docs/index.html#oonib
 and: https://ooni.torproject.org/docs/architecture.html#oonib
 It should have its own page with sections for setting up the backend
 (similar to or taken from oonib/README.md) and test helpers, and document
 what each test helper does.

 https://trac.torproject.org/projects/tor/wiki/doc/OONI/SetupHowto
 This page points at the readthedocs site which in turn points to:
 https://github.com/hellais/ooni-probe#getting-started (which displays the
 README.md file). We should replace this link with a page generated from
 the README.md file and host it on ooni.torproject.org

-- 
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/7376#comment:5>
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