From 50340b727bc7c186094c929e54508c1891da5abe Mon Sep 17 00:00:00 2001
From: Brandon Philips <brandon@ifup.org>
Date: Sun, 28 Jul 2024 18:36:40 -0700
Subject: [PATCH] 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/command-line-tutorial.md |  2 +-
 docs/how-it-works.md          | 13 +++++++------
 docs/intro.md                 |  8 ++++----
 docusaurus.config.js          |  2 +-
 4 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/docs/command-line-tutorial.md b/docs/command-line-tutorial.md
index 991cfc2..e779b00 100644
--- a/docs/command-line-tutorial.md
+++ b/docs/command-line-tutorial.md
@@ -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
diff --git a/docs/how-it-works.md b/docs/how-it-works.md
index 7d6723b..c6ad1fa 100644
--- a/docs/how-it-works.md
+++ b/docs/how-it-works.md
@@ -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 -->
 
@@ -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.
diff --git a/docs/intro.md b/docs/intro.md
index bab2467..0e917b0 100644
--- a/docs/intro.md
+++ b/docs/intro.md
@@ -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:
 
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 2819470..55a9b86 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -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