docs: lead with declarative ingest.yaml + curl-installer helm upgrade note#43
Merged
divyasinghds merged 1 commit intoMay 21, 2026
Conversation
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>
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.) |
aptracebloc
approved these changes
May 21, 2026
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Mirrors the corresponding data-ingestors PR. Driven by user feedback after a fresh end-to-end setup.
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 thatingest.yamlfields vary per category and links toexamples/yaml/andtemplates/.helm upgrade <workspace> tracebloc/client -n <namespace> --reset-then-reuse-values(with the--versionpinning tip), linking to the existing Configuration → Upgrade section.Test plan
🤖 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.yamlingestion path toprepare-dataset.mdxas the recommended default, including Helm repo setup, PVC data staging guidance, a per-categoryingest.yamlexample, and thehelm install tracebloc/ingestor --set-file ingestConfig=...command, while reframing the existing Python-template/Kubernetes Job workflow as advanced.Updates
setup-guide.mdxwith a note for one-liner installs documenting the correcthelm upgrade ... --reset-then-reuse-valuescommand (and optional--versionpinning) 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.