Skip to content

Story 16.6 — Operator guide (elasticsql)#124

Draft
fupelaqu wants to merge 5 commits into
release-r1from
feature/16.6
Draft

Story 16.6 — Operator guide (elasticsql)#124
fupelaqu wants to merge 5 commits into
release-r1from
feature/16.6

Conversation

@fupelaqu

Copy link
Copy Markdown
Contributor

Story 16.6 — Operator guide (core-docs mirror)

LAST story of Epic 16 (Federation Helm Chart). Independent doc mirror — no build dependency on the arrow/web copies.

What

  • NEW documentation/client/federation_operator_guide.md — the elasticsql core-docs mirror of the canonical operator guide (softclient4es-arrow/helm/softclient4es-federation/docs/operator-guide.md). Plain Markdown with H1 + canonical-source pointer.
  • UPDATE documentation/client/README.md — index link after the Telemetry & Privacy line.
  • UPDATE documentation/sql/README.md — cross-link to ../client/federation_operator_guide.md (the epic's literally-named target).

Customer-facing runtime/deployment docs home is documentation/client/ (same class as repl/adbc/arrow-flight-sql/telemetry); documentation/sql/ gets only the cross-link.

Verification

  • markdownlint-style sanity; README index links resolve (federation_operator_guide.md sibling + ../client/federation_operator_guide.md from sql/).
  • Dual-docs parity with the arrow canonical + web mirror (identical §1–§12 + SRE walkthrough + For Epic 17).
  • Documentation-only — zero Scala/sbt change.

Sibling 16.6 PRs

  • softclient4es-arrow (canonical, top of stacked chain): SOFTNETWORK-APP/softclient4es-arrow#115
  • softclient4es-web (federation-helm.mdx + sidebar): SOFTNETWORK-APP/softclient4es-web#8

Closes #123
Refs SOFTNETWORK-APP/softclient4es-arrow#113

🤖 Generated with Claude Code

fupelaqu and others added 2 commits June 23, 2026 02:25
Add documentation/client/federation_operator_guide.md — the elasticsql
core-docs mirror of the canonical operator guide
(softclient4es-arrow/helm/softclient4es-federation/docs/operator-guide.md),
linked from documentation/client/README.md AND documentation/sql/README.md
(the epic's literally-named target).

Customer-facing runtime/deployment docs home is documentation/client/ (same
class as repl/adbc/arrow-flight-sql/telemetry); documentation/sql/ gets only
the cross-link. Plain Markdown with H1 + canonical-source pointer.
Documentation-only — zero Scala/sbt change.

LAST story of Epic 16 (Federation Helm Chart).

Closed Issue #123
Refs SOFTNETWORK-APP/softclient4es-arrow#113
Story 16.6

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…l location

Remove 'mirror' wording and the private-repo (softclient4es-arrow) reference from
the canonical-source note; the authoritative guide ships with the federation Helm
chart at softclient4es-federation/docs/operator-guide.md. Fix the working-directory
convention path (helm/softclient4es-federation/ -> softclient4es-federation/).

Refs #123

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… block, add JOIN-matrix cross-link)

Story 17.2 (Epic 17 — R1 Documentation & Marketing). Path A: extend the open
16.6 PR (#124) rather than recreate. Drops the chart-internal '## For Epic 17'
hand-off block from the customer mirror (kept in the canonical chart copy) and
adds an intro See-also cross-link to the Story 17.1 Cross-Index JOIN matrix
(../sql/joins.md) as a tracked placeholder until 17.1 lands on release-r1.

Closed Issue #140

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