diff --git a/README.md b/README.md index d143961..ef36799 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,15 @@ Install these separately in your cluster before using this chart: You will also need the corresponding credentials for Socket.dev, Pulumi, S3-compatible object storage, and DefectDojo. +## Reading the chart + +If the Helm templates start to feel too abstract, use these two files together: + +- [`helm/values.schema.json`](helm/values.schema.json) documents the expected shape and meaning of the values file. +- [`docs/rendered/default-clusterworkflowtemplate.yaml`](docs/rendered/default-clusterworkflowtemplate.yaml) shows the default rendered `ClusterWorkflowTemplate` without Helm directives in the way. + +The rendered reference reflects the default values in `helm/values.yaml`, so optional storage, DefectDojo, and Infisical resources are intentionally omitted there. + ## Validation workflow For fast validation while wiring up infrastructure, use these tools together: