docs: address maintainer feedback on email template customization#6354
Open
Gitjay11 wants to merge 1 commit intomindersec:mainfrom
Open
docs: address maintainer feedback on email template customization#6354Gitjay11 wants to merge 1 commit intomindersec:mainfrom
Gitjay11 wants to merge 1 commit intomindersec:mainfrom
Conversation
Signed-off-by: Ajay Rajera <newajay.11r@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This is a follow-up PR to address maintainer feedback from PR #6313 regarding the email template customization documentation.
The changes include:
{{.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).deploymentSettings.extraVolumesanddeploymentSettings.extraVolumeMountsvalues.ko(which lacks a shell and core utilities likelsandcat), usingkubectl execis not viable. The guide now encourages users to verify configurations usingkubectl describe deploymentor check the underlying OCI artifact using the externaldivetool.No new dependencies are introduced.
Follow-up to #6313
Testing
Reference via Helm Chartsection is correct and aligns with Minder's defineddeploymentSettingsschemas.divecommand andkubectl describe deploymentdebug instructions to verify they represent the accurate workflows for testing distroless pods and OCI volume mounts.