#20234: Define CollecTor's file-structure protocol 1.0 -------------------------------+-------------------------------- Reporter: karsten | Owner: iwakeh Type: enhancement | Status: needs_revision Priority: High | Milestone: Component: Metrics/CollecTor | Version: Severity: Normal | Resolution: Keywords: | Actual Points: Parent ID: | Points: Reviewer: | Sponsor: -------------------------------+--------------------------------
Comment (by karsten): Wait. Let me go back one step and ask: why are we writing this document now? Is this for ourselves, for future contributors, for operators, or even for users? And can't we update or extend the existing documentation on `/index.html` with the most relevant missing parts? When I created this ticket I was thinking of coming up with a common structure for the ''web-facing'' parts of CollecTor, so that we can move forward with synchronization between CollecTor instances. I was not thinking of an implementation-level documentation of how we're using the file system, and I don't really see the urgent need for that. (When I mentioned the `stats/` directory and others, I basically wanted to give an example of something that, IMHO, does not fit into the protocol rather than suggest to include it. I should have phrased that more clearly.) Can we, for now, focus on any open questions you have about CollecTor's file structure and postpone the decision what documentation of the local file system structure we need? And can we make a decision how we're changing existing web-facing directories like moving `/index.json*` to `/index/index.json*` on the main CollecTor instance? Don't get me wrong, I do see the value of documentation, but I also see the cost of writing, reviewing, revising, and maintaining documentation, and in this case I don't yet see how the value is greater than the costs. -- Ticket URL: <https://trac.torproject.org/projects/tor/ticket/20234#comment:8> Tor Bug Tracker & Wiki <https://trac.torproject.org/> The Tor Project: anonymity online _______________________________________________ tor-bugs mailing list tor-bugs@lists.torproject.org https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs