rubyforgood / rubyforgood/human-essentials
Add email samples into the User Guide and link to them
Open
Nobody has claimed this yet.
Ruby for Good 2026 DC
- Dominant language
- Ruby
- Stars
- 593
- Forks
- 593
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 41
Description
Summary
We send several different emails, let's give Bank Organizations previews!
Background references, notes
We send a variety of emails, including some that can be customized and ones that can be enable/disabled. For each of these it'd be good to show a sample of what this email will look like.
For each email we send:
- From the place where that email is configured or sent
- Link to the User Guide with a pre-created sample of what the email looks like
- If there is an enable/disable option, place the link near that option
- For example, when creating a partner we ask "Do you want this partner to receive emails for distributions and reminders from the system?". Add a link to the User Guide next to that which shows what the email will look like in general
- For each email, trigger the email in your development environment locally and copy/paste that into the User Guide
- Optional/Experimental: Write a script that generates a page (or pages) in the User Guide with the emails; consider triggering a PR-create process from a github action
Criteria for completion / testing needs
- Enumerate email sends
- For each email ensure the User Guide has a sample output of the email
- For each email link to the User Guide from where the email is configured or sent
- Add a request spec that verifies that the links work (are not dead)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.