Skip to content

Add Enterprise Helm values references - #1234

Merged
danbarr merged 3 commits into
mainfrom
add-enterprise-helm-reference
Oct 13, 2026
Merged

danbarr merged 3 commits into
mainfrom
add-enterprise-helm-reference

Conversation

@danbarr

@danbarr danbarr commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Add Helm values references for the Stacklok Enterprise umbrella chart and nine first-party component and operator charts. The renderer preserves complete YAML examples and keeps indented prose out of code fences. A landing page explains umbrella dependency names and aliases, the sidebar groups the references under Helm values, and the deployment guide links to them.

Reuse the existing Helm generator and declarative upstream configuration. SEP generation records the source commit or release tag without linking readers to a private repository. Seed all ten references from SEP main at merged commit e71926418, which includes the upstream comment corrections from stacklok/stacklok-enterprise-platform#4965; the pages include the full commit SHA and cover 604 documented entries. Wrapped and third-party dependency defaults are not flattened into these references.

Type of change

  • New documentation
  • Navigation/structure change

Related issues/PRs

Addresses the Enterprise portion of #957. Chart descriptions landed in stacklok/stacklok-enterprise-platform#4895. Companion publisher PR: https://github.com/stacklok/stacklok-enterprise-platform/pull/4964. The source-comment fixes in stacklok/stacklok-enterprise-platform#4965 are merged. Merge this docs PR next, then publisher PR #4964.

Validation

  • Nine generator tests pass, including private-source provenance, complete YAML examples with parent keys and leading comments, prose detection, and MDX compilation. All 77 generated YAML blocks parse.
  • Production build, repository-wide Prettier and ESLint checks pass.
  • Generation against the pinned SEP source-comment snapshot is deterministic and leaves chart inputs unchanged.
  • The SEP sync script was exercised in an isolated docs checkout: Helm pages match this seed, API/CRD refreshes fit the existing artifact allowlist, and the resulting production build passes.
  • Zizmor reports no findings. Actionlint reports only the existing invalid $/.github/actions/setup reference.

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the authored content for spelling, grammar, and style

Navigation

  • New pages include title and description front matter
  • Sidebar navigation updated
  • No existing URLs moved or renamed

Reviewer checklist

Content

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Copilot AI balanced review requested due to automatic review settings October 13, 2026 18:03
@vercel

vercel Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs-website Ready Ready Preview Oct 13, 2026 7:22pm UTC

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Several generated references contain inaccurate types, malformed examples, and inaccessible private-source pointers.

13 open findings
What changed in this PR

Adds Stacklok Enterprise Helm values references, generation support, navigation, and release-sync handling.

Changes:

  • Adds references for the umbrella chart and nine component charts.
  • Supports private-source provenance without repository links.
  • Connects the references to navigation and deployment guidance.
File Description
.github/​upstream-projects.yaml Declares Enterprise Helm sources and pages.
.github/​workflows/​upstream-release-docs.yml Includes Enterprise references in release automation.
AGENTS.md Marks Enterprise Helm pages as generated.
sidebars.ts Adds Helm values navigation.
scripts/​upstream-release/​generate-helm-reference.mjs Supports private source provenance.
scripts/​upstream-release/​generate-helm-reference.test.mjs Tests private-source rendering.
docs/​platform/​enterprise-platform/​deployment.mdx Links deployment guidance to the references.
docs/​platform/​reference/​helm/​index.mdx Introduces and indexes chart references.
docs/​platform/​reference/​helm/​platform.mdx Documents umbrella chart values.
docs/​platform/​reference/​helm/​console.mdx Documents console chart values.
docs/​platform/​reference/​helm/​enterprise-manager.mdx Documents Enterprise Manager values.
docs/​platform/​reference/​helm/​toolhive-operator.mdx Documents ToolHive operator values.
docs/​platform/​reference/​helm/​toolhive-operator-crds.mdx Documents ToolHive CRD chart values.
docs/​platform/​reference/​helm/​registry-server.mdx Documents Registry Server values.
docs/​platform/​reference/​helm/​ai-gateway-operator.mdx Documents AI Gateway operator values.
docs/​platform/​reference/​helm/​ai-gateway-operator-crds.mdx Documents AI Gateway CRD chart values.
docs/​platform/​reference/​helm/​connector-gateway.mdx Documents Connector Gateway values.
docs/​platform/​reference/​helm/​ai-gateway.mdx Documents AI Gateway inference values.

🧠 Review effort: Balanced


💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/platform/reference/helm/ai-gateway.mdx Outdated
Comment thread docs/platform/reference/helm/ai-gateway.mdx Outdated
Comment thread docs/platform/reference/helm/connector-gateway.mdx Outdated
Comment thread docs/platform/reference/helm/connector-gateway.mdx Outdated
Comment thread docs/platform/reference/helm/console.mdx Outdated
Comment thread docs/platform/reference/helm/enterprise-manager.mdx Outdated
Comment thread docs/platform/reference/helm/enterprise-manager.mdx Outdated
Comment thread docs/platform/reference/helm/enterprise-manager.mdx Outdated
Comment thread docs/platform/reference/helm/enterprise-manager.mdx Outdated
Comment thread docs/platform/reference/helm/enterprise-manager.mdx Outdated
@danbarr
danbarr merged commit f529621 into main Oct 13, 2026
6 checks passed
@danbarr
danbarr deleted the add-enterprise-helm-reference branch October 13, 2026 19:22

This branch was successfully deployed

1 active deployment
Preview — 0b8664b1 Deployed Oct 13, 2026 by vercel[bot]
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