Opened 2 weeks ago

Last modified 7 days ago

#29315 needs_review enhancement

Write down guidelines for adding new stats

Reported by: karsten Owned by: karsten
Priority: Very High Milestone:
Component: Metrics/Website Version:
Severity: Normal Keywords: metrics-roadmap-2019-q2
Cc: metrics-team, dgoulet, ahf, juga, teor Actual Points:
Parent ID: Points: 3
Reviewer: Sponsor:

Description

We're going to add a few new stats to Tor Metrics in the next months: BridgeDB, PrivCount, sbws, and maybe more, in no specific order.

Let's write down some initial guidelines what we expect and what others can expect. And let's refine these initial guidelines as we add some actual stats. Once we're happy with them we should put them on Tor Metrics.

Assigning this ticket to myself for now, as I'm going to post a first draft soon. Cc'ing a few folks who we'll be working together with on adding new data.

Child Tickets

Attachments (1)

guidelines.txt (8.4 KB) - added by karsten 2 weeks ago.
Initial guidelines for adding stats

Download all attachments as: .zip

Change History (7)

Changed 2 weeks ago by karsten

Attachment: guidelines.txt added

Initial guidelines for adding stats

comment:1 Changed 2 weeks ago by karsten

Status: assignedneeds_review

There, attached a first draft. Please let me know what you think!

comment:2 Changed 11 days ago by juga

Read it, sounds good to me.
I'd just add the links to all the projects you mention and Tor proposals.
Nitpick: "your data", i never thought i was asking metrics to publish "my data" but rather Tor network data.

comment:3 in reply to:  2 ; Changed 11 days ago by karsten

Replying to juga:

Read it, sounds good to me.
I'd just add the links to all the projects you mention and Tor proposals.

Yep, agreed.

Nitpick: "your data", i never thought i was asking metrics to publish "my data" but rather Tor network data.

Ah, interesting point.

The reason why the document says "you" and "me" is that it's basically the transcription of an imaginary conversation I had with dgoulet or ahf or teor or you. And of course I didn't mean "your data" as in "juga's data", but I think you didn't mean that either.

The decision how to refer to the tool providing data is an important one. I wanted to make clear that Tor Metrics does not suddenly become the owner of the tool, neither with respect to its code nor to its operation, not even of the part that exports data to Tor Metrics. There must be a clear interface, and the owner of the tool providing the data will always stay in charge of the parts beyond that interface from a Tor Metrics point of view. It's not that Tor network data magically lands on Tor Metrics and nobody feels responsible anymore. I think I implicitly wanted to make that clear by using "you" and "we" in the document.

I'm open to different suggestions, though. This is just the very first draft, and we'll improve it as we add more of "your" Tor network data to Tor Metrics. :)

Thanks for the feedback!

comment:4 in reply to:  3 Changed 9 days ago by juga

Replying to karsten:
[...]

Nitpick: "your data", i never thought i was asking metrics to publish "my data" but rather Tor network data.

Ah, interesting point.

The reason why the document says "you" and "me" is that it's basically the transcription of an imaginary conversation I had with dgoulet or ahf or teor or you. And of course I didn't mean "your data" as in "juga's data", but I think you didn't mean that either.

The decision how to refer to the tool providing data is an important one. I wanted to make clear that Tor Metrics does not suddenly become the owner of the tool, neither with respect to its code nor to its operation, not even of the part that exports data to Tor Metrics. There must be a clear interface, and the owner of the tool providing the data will always stay in charge of the parts beyond that interface from a Tor Metrics point of view. It's not that Tor network data magically lands on Tor Metrics and nobody feels responsible anymore. I think I implicitly wanted to make that clear by using "you" and "we" in the document.

That makes sense. I also think that the conversation style probably makes it easier to read.

I'm open to different suggestions, though. This is just the very first draft, and we'll improve it as we add more of "your" Tor network data to Tor Metrics. :)

:)
Certainly seems hard to come up with an alternative without making the style more impersonal or using longer sentences.
I can only come now with adding a note after the the first "your data" something like:
"[*] by your data we don't mean the data belongs to you, but you're one of the persons working on the source that produces the data."
Still fine if you leave it without any note.

comment:5 Changed 7 days ago by irl

Keywords: metrics-roadmap-2019-q2 added

comment:6 Changed 7 days ago by irl

Priority: MediumVery High
Note: See TracTickets for help on using tickets.