Skip to content

Add Helm installation steps to policy-controller install docs - #448

Merged
Hayden-IO merged 1 commit into
sigstore:mainfrom
nellshamrell:policy-controller-installation-helm-steps
Jul 27, 2026
Merged

Add Helm installation steps to policy-controller install docs#448
Hayden-IO merged 1 commit into
sigstore:mainfrom
nellshamrell:policy-controller-installation-helm-steps

Conversation

@nellshamrell

@nellshamrell nellshamrell commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Summary

The policy-controller installation page mentioned the Helm chart only via a link buried in the first paragraph, then jumped straight into advanced TUF root configuration — with no actual installation instructions. This restructures the page to lead with an actionable Helm install workflow.

I have verified the additions using an AKS cluster.

Fixes sigstore/policy-controller#1992

Changes

  • Add a Prerequisites section (Kubernetes cluster + kubectl, Helm v3).
  • Add a prominent Install with Helm section with the helm repo add / helm install commands and the cosign-system namespace, sourced from the chart README.
  • Add a Verify the installation step.
  • Group the existing advanced content (private Sigstore/TUF root, resync period) under clear headings — no information removed.
  • Fix a stale cross-page anchor so the "namespaces" link points at the current overview heading (#configure-policy-controller-admission-controller-for-namespaces).

Testing

  • markdownlint-cli2 --config .markdownlint-cli2.jsonc content/en/policy-controller/installation.md → 0 issues.
  • Verified both cross-page anchors resolve to existing headings in overview.md.

The policy-controller installation page mentioned the Helm chart only via a
link in the first paragraph and jumped straight into advanced TUF root
configuration, with no actual installation instructions. New users had a hard
time finding how to install the controller.

Restructure the page to lead with the Helm install workflow:
- Add a Prerequisites section.
- Add a prominent "Install with Helm" section with the repo add / install
  commands and the cosign-system namespace.
- Add a verification step.
- Group the existing advanced content (private TUF root, resync period) under
  clear headings.
- Fix a stale cross-page anchor to the overview "Configure ... for namespaces"
  section.

No existing information was removed.

Fixes sigstore/policy-controller#1992

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 0ce53efa-a7e9-4046-a24e-34c406601950
Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>
@netlify

netlify Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploy Preview for docssigstore ready!

Name Link
🔨 Latest commit a3af762
🔍 Latest deploy log https://app.netlify.com/projects/docssigstore/deploys/6a67d864b462ae0008c5c7bc
😎 Deploy Preview https://deploy-preview-448--docssigstore.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Hayden-IO Hayden-IO 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.

Thank you!

@Hayden-IO
Hayden-IO merged commit e005d4a into sigstore:main Jul 27, 2026
6 checks passed
@kastl-ars

Copy link
Copy Markdown

Thanks @nellshamrell that page looks really nice now. Well done!

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.

Installation documentation is very sparse and only mentions the helm chart in a very hidden way

3 participants