Skip to content

docs: lead with declarative ingest.yaml + curl-installer helm upgrade note#43

Merged
divyasinghds merged 1 commit into
developfrom
docs/declarative-ingest-yaml-and-curl-helm-upgrade
May 21, 2026
Merged

docs: lead with declarative ingest.yaml + curl-installer helm upgrade note#43
divyasinghds merged 1 commit into
developfrom
docs/declarative-ingest-yaml-and-curl-helm-upgrade

Conversation

@divyasinghds
Copy link
Copy Markdown
Contributor

@divyasinghds divyasinghds commented May 21, 2026

Summary

Mirrors the corresponding data-ingestors PR. Driven by user feedback after a fresh end-to-end setup.

  • prepare-dataset.mdx — adds a new "Declarative YAML (recommended)" section before the existing Quick Setup / Detailed Setup walkthroughs. The simpler flow (helm install tracebloc/ingestor --set-file ingestConfig=./ingest.yaml) is now the default; the existing Python-template + Docker + Kubernetes Job flow stays as the advanced path under a short framing intro. Calls out that ingest.yaml fields vary per category and links to examples/yaml/ and templates/.
  • setup-guide.mdx — adds a Note after the curl one-liner with the right helm-upgrade command for installer-deployed clients: helm upgrade <workspace> tracebloc/client -n <namespace> --reset-then-reuse-values (with the --version pinning tip), linking to the existing Configuration → Upgrade section.

Test plan

  • Preview both pages in the docs site (Mintlify) and confirm callouts/links render correctly
  • Follow the declarative flow end-to-end against a fresh client and confirm the page sequence (setup-guide → prepare-data) reads top-to-bottom without dead ends
  • Confirm the advanced (Python template) section still works as a fallback for users on that path

🤖 Generated with Claude Code


Note

Low Risk
Low risk documentation-only changes; main risk is user confusion if Helm commands/links are incorrect.

Overview
Adds a new declarative ingest.yaml ingestion path to prepare-dataset.mdx as the recommended default, including Helm repo setup, PVC data staging guidance, a per-category ingest.yaml example, and the helm install tracebloc/ingestor --set-file ingestConfig=... command, while reframing the existing Python-template/Kubernetes Job workflow as advanced.

Updates setup-guide.mdx with a note for one-liner installs documenting the correct helm upgrade ... --reset-then-reuse-values command (and optional --version pinning) with a link to the upgrade docs.

Reviewed by Cursor Bugbot for commit 049395b. Bugbot is set up for automated code reviews on this repo. Configure here.

Two changes to the prepare-data and setup-guide pages driven by user
feedback after a fresh end-to-end setup:

- prepare-dataset.mdx: lead with the declarative YAML method (helm
  install tracebloc/ingestor --set-file ingestConfig=./ingest.yaml).
  The existing Python-template + Docker + kubectl flow stays as the
  advanced path for users who need custom processors. Calls out that
  ingest.yaml fields vary per category and points at the per-category
  examples in the data-ingestors repo.
- setup-guide.mdx: add a Note after the curl one-liner pointing at
  the helm upgrade command (--reset-then-reuse-values, --version) so
  users know how to upgrade an installer-deployed client without
  losing applied values.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@LukasWodka
Copy link
Copy Markdown
Contributor

👋 Heads-up — Code review queue is at 19 / 8

Above the WIP limit. The team convention is to review existing PRs before opening new work.

Open PRs currently in Code review (oldest first):

Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.)

@divyasinghds divyasinghds merged commit aa81c24 into develop May 21, 2026
5 checks passed
@divyasinghds divyasinghds deleted the docs/declarative-ingest-yaml-and-curl-helm-upgrade branch May 21, 2026 12:16
divyasinghds added a commit that referenced this pull request May 21, 2026
…43) (#44)

Two changes to the prepare-data and setup-guide pages driven by user
feedback after a fresh end-to-end setup:

- prepare-dataset.mdx: lead with the declarative YAML method (helm
  install tracebloc/ingestor --set-file ingestConfig=./ingest.yaml).
  The existing Python-template + Docker + kubectl flow stays as the
  advanced path for users who need custom processors. Calls out that
  ingest.yaml fields vary per category and points at the per-category
  examples in the data-ingestors repo.
- setup-guide.mdx: add a Note after the curl one-liner pointing at
  the helm upgrade command (--reset-then-reuse-values, --version) so
  users know how to upgrade an installer-deployed client without
  losing applied values.

Co-authored-by: Asad Iqbal (Saadi) <asad.dsoft@gmail.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@divyasinghds divyasinghds self-assigned this Jun 1, 2026
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.

3 participants