Skip to content

Story 17.7 — Privacy/telemetry doc (R1 mirror + de-dup) — elasticsql#138

Draft
fupelaqu wants to merge 1 commit into
release-r1from
feature/17.7
Draft

Story 17.7 — Privacy/telemetry doc (R1 mirror + de-dup) — elasticsql#138
fupelaqu wants to merge 1 commit into
release-r1from
feature/17.7

Conversation

@fupelaqu

Copy link
Copy Markdown
Contributor

Story 17.7 — Privacy + telemetry doc (R1 launch mirror + cross-link)

Epic 17 (R1 Documentation & Marketing), Layer 0. Docs-only — no sbt/compile. Closes #136.

The elasticsql MD half of the R1 privacy/telemetry reconciliation. Story 15.6 already shipped the content; this PR applies the AC-7 hedge correction and resolves a launch-time duplicate.

Changes

  • AC-7 hedge correctiondocumentation/client/telemetry.md: the stale 15.6 hedge ("a dedicated driver property … may also be offered … until then use HOCON/-D") becomes the now-accurate statement: JDBC accepts ?telemetry=false directly on the JDBC URL (implemented, ConnectionUrl.scala:54,102-115); ADBC has no equivalent connection option (HOCON/-D only, ElasticAdbcConnection.scala:125). The daily-ping key softclient4es.telemetry.enabled is merged (reference.conf:28-31, TelemetryConfig.scala:38) — no PROPOSED marker survives. Byte-identical to the web source-of-truth edit (softclient4es-web#13).
  • De-duplicate the MD telemetry docs (D1c(i))git mv documentation/sql/telemetry.md → documentation/client/download_analytics.md, H1 → # Download Analytics, download-analytics facts kept verbatim, intro reworked to link the canonical [Telemetry & Privacy](telemetry.md) sibling. This resolves the defect where two MD docs shared the # Telemetry & Privacy H1 and sql/README.md linked both with identical labels.
  • README fixes (text-anchored)sql/README.md now has exactly one [Telemetry & Privacy](../client/telemetry.md) + one [Download Analytics](../client/download_analytics.md); client/README.md gains the [Download Analytics](download_analytics.md) bullet.

Verification

Docs-only. Stale hedge dedicated driver property = 0 hits; exactly one [Telemetry & Privacy] label per README; per-surface opt-out one-liners (adbc/arrow_flight_sql/repl) verified present; retention (13 months) + contact (sales@softclient4es.com) parity with the web source-of-truth confirmed.

Sibling PR

  • softclient4es-web: web source-of-truth + site-wide privacy footer cross-link (closes softclient4es-web#13).

🤖 Generated with Claude Code

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) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant