Skip to content

docs(generic): sync template standards updates#345

Open
mberlofa wants to merge 1 commit into
mainfrom
docs/generic-template-standards-sync
Open

docs(generic): sync template standards updates#345
mberlofa wants to merge 1 commit into
mainfrom
docs/generic-template-standards-sync

Conversation

@mberlofa

@mberlofa mberlofa commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • document Generic ingress class behavior and networkPolicy.extraEgress
  • add Generic to the playground registry with curated defaults
  • sync the configuration reference for the new NetworkPolicy value

Validation

  • make site-sync-check CHART=generic
  • npm run lint
  • npm run format:check
  • npm run build
  • make release-check REPO=site
  • make attribution-check REPO=site

Charts PR: helmforgedev/charts#667
Issue: helmforgedev/charts#633

@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a new generic chart configuration entry to the playground config data with workload, ingress, resources, and network policy field groups; registers generic in the playground page's sync config list; and updates the generic chart documentation table formatting and an ingressClassName description.

Changes

Generic Chart Playground Support

Layer / File(s) Summary
Generic chart playground field definitions
src/data/playground-configs.ts
Adds a generic chart config with workload, ingress (gated by ingress.enabled), resource request/limit, and network policy (gated by networkPolicy.enabled) field groups.
Enable generic chart in playground page
src/pages/playground.astro
Registers generic in siteSyncPlaygroundConfigs, allowing it to appear in the playground regardless of maturity.
Generic chart docs updates
src/pages/docs/charts/generic.mdx
Clarifies that an empty ingress.ingressClassName omits spec.ingressClassName and reflows the Security and Storage parameters table.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is relevant to the Generic docs sync, though it is a bit broad about the exact changes.
Description check ✅ Passed The description includes a clear summary, validation steps, and issue references, with no blog section needed for these files.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/generic-template-standards-sync

Comment @coderabbitai help to get the list of available commands.

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