Re: [tor-bugs] #23169 [Metrics/Website]: Explain why metrics are important and what we do to make sure they're safe

["Tor Bug Tracker & Wiki" <blackhole@xxxxxxxxxxxxxx>]

#23169: Explain why metrics are important and what we do to make sure they're safe
-----------------------------+------------------------------
 Reporter:  arma             |          Owner:  irl
     Type:  defect           |         Status:  needs_review
 Priority:  Medium           |      Milestone:
Component:  Metrics/Website  |        Version:
 Severity:  Normal           |     Resolution:
 Keywords:  metrics-2018     |  Actual Points:
Parent ID:                   |         Points:  2
 Reviewer:  iwakeh, karsten  |        Sponsor:
-----------------------------+------------------------------

Comment (by irl):

 Replying to [comment:24 iwakeh]:
 > The dot file should not be in the 'web/images' folder as it is only the
 source for the png.  The png should always be committed (same process as
 with our generated spec jsps, for example), because these depend on the
 dot implementation used.  Even with a future Ant task at hand that limits
 dependencies for building the war file.  Regarding dot file location: what
 about `src/main/resources/doc/ecosystem.dot` or
 `src/main/resources/doc/ecosystem/ecosystem.dot`?

 Having reviewed the man page for dot, I noticed the standard file
 extension is actually .gv so I've changed that and moved the source to
 `src/main/resources/graphviz`. The idea would be that this serves as a
 common directory for any graphviz source files and then they are installed
 into `src/main/resources/web/images` with the "generate-graphviz-pngs" Ant
 task (added in a separate commit).

 > A second thought about this graph, which I like and understand, but it
 might cause confusion for the 'uninitiated' as it is not really described
 fully.  And, the metrics-lib oval is kind of dangling in the air and the
 "via metrics-lib" label used three times.  I first thought of making it a
 different shape (see attachment),
 > [[Image(https://trac.torproject.org/projects/tor/attachment/ticket/23169
 /another-overview.png)]]
 > but then noticed that this also is not at all self-explanatory.  So,
 maybe leave the picture out unless we describe the graph a little more?

 I've removed the floating metrics-lib and instead added 3 smaller boxes on
 the paths between CollecTor and the consuming services. I've also added an
 additional paragraph above the image that should help to explain it
 further. If people want to learn additional information, they should read
 the relevant pages that are linked in the text, this is only meant to be a
 quick primer.

 > Should we think about removing Schneier's quote from the header now (as
 was requested before)?
 > It's on the about page now.

 I've created #25411 (as a subticket of #25404) for this.

 Changes are rebased and pushed to my
 [[https://gitweb.torproject.org/user/irl/metrics-
 web.git/log/?h=task/23169|task/23169]] branch.

 I would be particularly interested in feedback on my Ant, as I haven't
 done much Ant and learning what I'm doing wrong is good.

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