Skip to content

Add NOTES.txt for Helm chart post-install guidance #4615

Description

@ChrisJBurns

Summary

The operator Helm chart does not include a NOTES.txt template. After helm install, users see no post-installation guidance about how to verify the operator is running, create their first MCPServer resource, or check logs for issues.

This is a missed opportunity to improve the first-run experience and reduce support burden. Most production Helm charts include NOTES.txt to print actionable next steps.

Severity: CONSIDER
Area: Helm Chart
Breaking: No

Location

  • deploy/charts/operator/templates/ (missing NOTES.txt)

Recommended Fix

  1. Create deploy/charts/operator/templates/NOTES.txt with content covering:
    • How to verify the operator pod is running (kubectl get pods -n {{ .Release.Namespace }})
    • How to check operator logs
    • A minimal MCPServer example to get started
    • Link to documentation for advanced configuration
  2. Use Helm template variables for namespace and release name so the instructions are copy-pasteable.
  3. Test the output with helm install --dry-run to verify formatting.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions