Skip to content

Commit

Permalink
docs: try to consistently use telemetry term (#99)
Browse files Browse the repository at this point in the history
* docs: try to consistently use telemetry term

Try and be consistent around the language of Divvi Up being a "privacy
preserving telemtry service". This gets a little tricky in the how it
works section because the DAP protocol talks about "measurements" but I
think it is easy enough to say a measurement is the telemetric data.

* docs: update command line video demo

update with telemetry voiceover
  • Loading branch information
philips authored Jul 30, 2024
1 parent f3d51d7 commit 3bed8ad
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/command-line-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ export HELPER_ID=96301951-c848-4a57-b4f5-32812e4db1be
## Collector Credential

Next, generate a collector-credential for the task. The collector credential
will be used by the collector to export the aggregated statistics.
will be used by the collector to export the aggregated telemetry.

```sh
divviup collector-credential generate --save
Expand Down
2 changes: 1 addition & 1 deletion docs/command-line-video-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ The video below shows the [command line tutorial](./command-line-tutorial) with
some additional explanation. If you prefer to try it for yourself on your
computer checkout the [command line tutorial](./command-line-tutorial).

<iframe width="840" height="473" src="https://www.youtube.com/embed/sCJlJAy1Fyg?si=MUUburZe1XbOjvq2" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
<iframe width="840" height="473" src="https://www.youtube.com/embed/QC5rH4FO6fw" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
13 changes: 7 additions & 6 deletions docs/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Learn how Divvi Up works and how it protects privacy.

## Breakdown

Divvi Up ingests measurements and aggregates them, while protecting the privacy
of each individual measurement. This can be broadly broken down into several
steps, described in the following sections.
Divvi Up ingests and aggregates telemetric data while protecting the privacy of
each individual measurement. Example use cases might be application metrics,
survey results, or machine learning data. The process can be broadly broken down
into several steps, described in the following sections.

<!-- TODO(inahga): Consider making this a more detailed `mermaid` diagram -->

Expand Down Expand Up @@ -47,9 +48,9 @@ For each measurement, the subsequent steps are performed.

### Step 2: Client shards the measurement

The app uses the DAP client library to randomly shard the measurement into two
parts, known as report shares. One report share is for the leader aggregator,
and the other for the helper aggregator.
The app uses the DAP client library to randomly shard the telemetric data,
called a measurement, into two parts, known as report shares. One report share
is for the leader aggregator, and the other for the helper aggregator.

The client library encrypts each share with a public key advertised by the
respective aggregator.
Expand Down
8 changes: 4 additions & 4 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ sidebar_position: 1

# Overview

Divvi Up is a privacy preserving metrics platform for collecting aggregate
statistics. Using Divvi Up can help users gain insights into a user base while
respecting users' individual privacy, eliminating the need to store PII for
telemetry, and mitigating compliance risks.
Divvi Up is a privacy preserving telemetry service. It enables application
owners to gain insights into a user base while respecting users' individual
privacy, eliminating the need to store PII for telemetry, and mitigating
compliance risks.

The best two places to get started are:

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const darkTheme = themes.dracula;
const config = {
title: "Divvi Up",
tagline:
"Documentation site for Divvi Up, a privacy-respecting system for aggregate statistics.",
"Documentation site for Divvi Up, a privacy-respecting telemetry service for metrics or machine learning.",
favicon: "favicon.png",

// Set the production url of your site here
Expand Down

0 comments on commit 3bed8ad

Please sign in to comment.