docs: mail master documentation #38
Open
Conversation
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
abhibhaw
requested changes
Feb 28, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the Mail Master plugin, which enables automated bulk email notifications through SMTP servers for Devtron applications. The documentation provides setup instructions, user input specifications, and integration guidance for the plugin.
- Added new Mail Master plugin documentation with setup instructions and configuration details
- Updated the documentation table of contents to include the new plugin and reorganize GKE Provisioner entry
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/user-guide/plugins/mail-master.md | Complete documentation for Mail Master plugin including prerequisites, setup steps, and configuration parameters |
| docs/SUMMARY.md | Added Mail Master entry and reorganized GKE Provisioner entry in the plugins section |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| | SenderName | STRING | Name of sender | John Doe | | ||
| | RecipientsGroupName | STRING | Group id for selecting recipients from config.json | "ReleaseTeam" | | ||
| | RecipientsSubGroupName | STRING | The Sub-group id for selecting recipients from config.json | "NorthRegion" | | ||
| | Recipients | STRING | Emails of recipients seprated by "," if user is not specified in config.json file | [email protected],[email protected] | |
There was a problem hiding this comment.
Corrected spelling of 'seprated' to 'separated'.
Suggested change
| | Recipients | STRING | Emails of recipients seprated by "," if user is not specified in config.json file | [email protected],[email protected] | | |
| | Recipients | STRING | Emails of recipients separated by "," if user is not specified in config.json file | [email protected],[email protected] | |
| | RecipientConfigFile | STRING | Provide path of config.json, that contains list of recipients | /path/to/recipientsConfig.json | | ||
| | EmailSubject | STRING | Provide subject for the email. Subject can also be provided in `EmailContentFile` after "Subject" | "Monthly Release" | | ||
| | BatchSize | NUMBER | Number of emails that should be sent per batch. The default number is 10 | 200 | | ||
| | BatchDelayTime | NUMBER | Time to wait in two batch (in seconds) | 15 | |
There was a problem hiding this comment.
Grammar error: should be 'between two batches' instead of 'in two batch'.
Suggested change
| | BatchDelayTime | NUMBER | Time to wait in two batch (in seconds) | 15 | | |
| | BatchDelayTime | NUMBER | Time to wait between two batches (in seconds) | 15 | |
| | SmtpServer | STRING | The host name of SMTP server | smtp.gmail.com | | ||
| | SmtpUsername | STRING | The username of SMTP connection | [email protected] | | ||
| | SmtpPassword | STRING | Password of SMTP connection | mysecretpassword | | ||
| | SenderEmail | STRING | Sender's email address | [email protected] | |
There was a problem hiding this comment.
There's inconsistent whitespace formatting with a tab character before the sample value. Should use consistent spacing like other rows in the table.
Suggested change
| | SenderEmail | STRING | Sender's email address | [email protected] | | |
| | SenderEmail | STRING | Sender's email address | [email protected] | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
#37