Skip to content

docs: improve Helm install guidance - #389

Merged
chiragjn merged 2 commits into
truefoundry:mainfrom
jayesh9747:docs/improve-helm-install
Aug 21, 2026
Merged

chiragjn merged 2 commits into
truefoundry:mainfrom
jayesh9747:docs/improve-helm-install

Conversation

@jayesh9747

@jayesh9747 jayesh9747 commented Aug 21, 2026 •

Copy link
Copy Markdown
Contributor

What this solves

Closes #385.

The Quickstart Helm instructions did not tell users where to find published chart versions, and they did not include a minimal ingress configuration.

This PR:

  • links to the JFrog page containing published TrueForge Helm chart versions;
  • adds a ready-to-adapt Istio VirtualService example using the chart extraObjects value;
  • keeps ingress guidance deliberately scoped to the common Istio approach, rather than documenting every possible ingress controller or gateway.

Validation

  • git diff --check passed.
  • pnpm lint:ci is currently blocked by 31 pre-existing, unrelated TypeScript lint errors.

Note

Low Risk
Documentation-only change to the Quickstart Helm tab; no application or chart behavior is modified.

Overview
Adds missing Kubernetes Helm install details to the Quickstart: a link to published chart versions on JFrog, and a copy-paste Istio VirtualService under extraObjects plus a --values install command.

Ingress coverage stays Istio-only; no chart or runtime code changes.

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

Copilot AI lite review requested due to automatic review settings August 21, 2026 10:00
@changeset-bot

changeset-bot Bot commented Aug 21, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2e19307

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jayesh9747

Copy link
Copy Markdown
Contributor Author

looks like
image

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Improves Helm quickstart documentation with chart-version discovery and Istio exposure guidance.

Changes:

  • Links to published Helm chart versions.
  • Adds an Istio VirtualService example using extraObjects.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/quickstart.mdx Resolved
Comment thread docs/quickstart.mdx Resolved
Signed-off-by: Jayesh Savaliya <jsavaliya.tech@gmail.com>
@jayesh9747
jayesh9747 force-pushed the docs/improve-helm-install branch from 3812895 to 5080cbb Compare August 21, 2026 10:18
@chiragjn
chiragjn merged commit 94f673f into truefoundry:main Aug 21, 2026
1 check passed
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.

Docs improvement for helm

3 participants