Skip to content

docs: address maintainer feedback on email template customization#6354

Open
Gitjay11 wants to merge 1 commit intomindersec:mainfrom
Gitjay11:docs/email-template-customization-followup
Open

docs: address maintainer feedback on email template customization#6354
Gitjay11 wants to merge 1 commit intomindersec:mainfrom
Gitjay11:docs/email-template-customization-followup

Conversation

@Gitjay11
Copy link
Copy Markdown
Contributor

Summary

This is a follow-up PR to address maintainer feedback from PR #6313 regarding the email template customization documentation.

The changes include:

  • Encoding Static Parameters: Added a recommendation and updated structural examples to explicitly hardcode non-variable paths (like the base URL for invitations and sign-in) alongside the {{.InvitationCode}}, rather than relying on fully dynamic variables like {{.InvitationURL}} or {{.SignInURL}}. This allows operators to easily configure default Stacklok-specific variables (like Terms and Privacy URLs).
  • Helm Deployment Updates: Added a dedicated sub-section demonstrating how operators using Helm can inject their custom templates by utilizing the deploymentSettings.extraVolumes and deploymentSettings.extraVolumeMounts values.
  • Debugging Constraints: Rewrote the debugging instructions. Since the Minder container is a distroless image built with ko (which lacks a shell and core utilities like ls and cat), using kubectl exec is not viable. The guide now encourages users to verify configurations using kubectl describe deployment or check the underlying OCI artifact using the external dive tool.

No new dependencies are introduced.

Follow-up to #6313

Testing

  • Verified that the Markdown file renders correctly and the styling matches the layout standards.
  • Confirmed the YAML syntax inside the newly added Reference via Helm Chart section is correct and aligns with Minder's defined deploymentSettings schemas.
  • Reviewed the dive command and kubectl describe deployment debug instructions to verify they represent the accurate workflows for testing distroless pods and OCI volume mounts.

Signed-off-by: Ajay Rajera <newajay.11r@gmail.com>
@Gitjay11 Gitjay11 requested a review from a team as a code owner April 13, 2026 12:35
@coveralls
Copy link
Copy Markdown

Coverage Status

coverage: 59.387% (-0.003%) from 59.39% — Gitjay11:docs/email-template-customization-followup into mindersec:main

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.

2 participants