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

Re: [tor-bugs] #5405 [Website]: we need a place to keep track of our tech reports

#5405: we need a place to keep track of our tech reports
-------------------------+--------------------------------------------------
 Reporter:  arma         |          Owner:  arma
     Type:  enhancement  |         Status:  new 
 Priority:  normal       |      Milestone:      
Component:  Website      |        Version:      
 Keywords:               |         Parent:      
   Points:               |   Actualpoints:      
-------------------------+--------------------------------------------------

Comment(by karsten):

 So, now that we have a list of possible Tor Tech Reports, how do we
 proceed?  I think one aspect we need to discuss is the process for
 publishing a Tor Tech Report.  Here's a suggestion:

  - We define YYYY-NNNN as the numbering scheme with YYYY being the year
 and NNNN being a counter that starts at 0001.  Numbers in a given year
 don't necessarily match publication order, especially not for past years.
 But that's probably fine.

  - We set up a tech-reports.git repository with all the LaTeX sources of
 published tech reports in their own subdirectory.  Whenever someone wants
 to publish a tech report, they clone that repository, create a new
 directory YYYY/short-tech-report-title/, and put all their source files in
 there.  They don't assign a tech report number yet.  They send an email to
 tor-dev with the abstract or first introduction paragraph and links to
 their repo and to the PDF.  Roger or Nick approve that their report should
 become a Tor Tech Report.  The guy maintaining tech-reports.git (which
 could be me) pulls from the repo of whoever sent the tor-dev mail, assigns
 the next report number to it, puts the number in the LaTeX sources, merges
 them into the official tech-reports.git, puts the PDF on the Tor website,
 and replies to tor-dev that the report is available.

  - There are no formatting requirements to the report, except that they
 must contain a line "Tor Tech Report YYYY-NNNN" in their subtitle.

  - Changes to existing tech reports should be rare.  It's okay to fix
 typos or add a footnote saying that the report is superseded by another
 report.  But major updates should instead go into a new report.

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