From d38a2af71cfe201b9ce03f7b1ced590c8216ed95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Manciot?= Date: Thu, 25 Jun 2026 07:31:05 +0200 Subject: [PATCH 1/2] docs: reconcile privacy/telemetry MD docs for R1 (AC-7 hedge + de-dup) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Story 17.7 (Epic 17 — R1 Documentation & Marketing). - Correct the stale JDBC opt-out hedge in documentation/client/telemetry.md: JDBC accepts ?telemetry=false on the URL (implemented); ADBC is HOCON/-D only. Mirrors the web source-of-truth byte-for-byte; key softclient4es.telemetry.enabled is merged (no PROPOSED marker survives). - De-duplicate (D1c(i)): rename documentation/sql/telemetry.md -> documentation/client/download_analytics.md with a distinct H1 (# Download Analytics), keeping the download-analytics facts verbatim and linking the canonical privacy page. - Collapse the duplicate [Telemetry & Privacy] labels: sql/README.md and client/README.md now carry exactly one canonical privacy link plus a distinct [Download Analytics] link. Closed Issue #136 Co-Authored-By: Claude Opus 4.8 (1M context) --- documentation/client/README.md | 1 + .../telemetry.md => client/download_analytics.md} | 11 +++++------ documentation/client/telemetry.md | 2 +- documentation/sql/README.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) rename documentation/{sql/telemetry.md => client/download_analytics.md} (85%) diff --git a/documentation/client/README.md b/documentation/client/README.md index d5e206c6..b3a3189e 100644 --- a/documentation/client/README.md +++ b/documentation/client/README.md @@ -24,3 +24,4 @@ Welcome to the Client Engine Documentation. Navigate through the sections below: - [Arrow Flight SQL](arrow_flight_sql.md) - [ADBC Driver](adbc_driver.md) - [Telemetry & Privacy](telemetry.md) +- [Download Analytics](download_analytics.md) diff --git a/documentation/sql/telemetry.md b/documentation/client/download_analytics.md similarity index 85% rename from documentation/sql/telemetry.md rename to documentation/client/download_analytics.md index 8f91b595..4f00956e 100644 --- a/documentation/sql/telemetry.md +++ b/documentation/client/download_analytics.md @@ -1,11 +1,10 @@ -# Telemetry & Privacy +# Download Analytics SoftClient4ES measures **driver adoption** with anonymous, aggregate counts only. This page describes -the download analytics specifically; a complete, surface-by-surface telemetry overview will follow. - -> This is the core-project mirror of the website page -> [Telemetry & Privacy](https://softclient4es.com/privacy/telemetry/) — kept in sync per the dual-doc -> convention. +the **download analytics** specifically — the small beacon sent when you click a Download button on the +website. For the complete, surface-by-surface product-telemetry overview (what the JDBC/ADBC drivers, the +REPL, and the Arrow Flight SQL / federation servers send, and how to opt out), see +[Telemetry & Privacy](telemetry.md). ## What is collected diff --git a/documentation/client/telemetry.md b/documentation/client/telemetry.md index 41d64631..c1e57ead 100644 --- a/documentation/client/telemetry.md +++ b/documentation/client/telemetry.md @@ -116,7 +116,7 @@ softclient4es.telemetry.enabled = false -Dsoftclient4es.telemetry.enabled=false ``` -> A dedicated driver property (JDBC URL `?telemetry=false`) or ADBC connection option may also be offered — when available it will be documented here. Until then, use the HOCON / `-D` form above for the drivers. +> The JDBC driver also accepts `?telemetry=false` directly on the JDBC URL. The ADBC driver has no equivalent connection option — use the HOCON / `-D` form above. ## What happens when you opt out diff --git a/documentation/sql/README.md b/documentation/sql/README.md index 996339c6..a36fd630 100644 --- a/documentation/sql/README.md +++ b/documentation/sql/README.md @@ -19,4 +19,4 @@ Welcome to the SQL Engine Documentation. Navigate through the sections below: - [DQL Support](dql_statements.md) - [Materialized Views](materialized_views.md) - [Telemetry & Privacy](../client/telemetry.md) -- [Telemetry & Privacy](telemetry.md) +- [Download Analytics](../client/download_analytics.md) From f36b0ccc18bb7b8b3f9e14499b7cf97cbbe2810c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Manciot?= Date: Thu, 25 Jun 2026 21:45:09 +0200 Subject: [PATCH 2/2] docs(17.7): sweep R1 codename + driver version 0.2.0 (missed in 2nd pass) Co-Authored-By: Claude Opus 4.8 --- documentation/client/download_analytics.md | 2 +- documentation/client/telemetry.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/client/download_analytics.md b/documentation/client/download_analytics.md index 4f00956e..8b20bb08 100644 --- a/documentation/client/download_analytics.md +++ b/documentation/client/download_analytics.md @@ -15,7 +15,7 @@ beacon to a public endpoint with exactly these fields: |---------------|----------|-----------------------------------------------| | `source` | `portal` | Where the count came from (the docs button) | | `driver` | `jdbc` | Which driver family (`jdbc` or `adbc`) | -| `version` | `0.1.4` | The published artifact version | +| `version` | `0.2.0` | The published artifact version | | `count_delta` | `1` | One download | A timestamp is added on the server. That is the **entire** record. diff --git a/documentation/client/telemetry.md b/documentation/client/telemetry.md index c1e57ead..9e6117d3 100644 --- a/documentation/client/telemetry.md +++ b/documentation/client/telemetry.md @@ -134,7 +134,7 @@ Nothing else changes. With telemetry disabled: ## Why we collect this -- **Measure the R1 launch** — did people actually adopt SoftClient4ES? +- **Measure the launch of this release** — did people actually adopt SoftClient4ES? - **Prioritise the right features** — which surfaces and capabilities get used most. - **Understand the mix** — how many JDBC vs. ADBC vs. sidecar vs. federation vs. REPL deployments exist, so we invest where it matters.