Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document overriding mailer templates #10574

Merged
merged 2 commits into from Oct 20, 2020
Merged

Document overriding mailer templates #10574

merged 2 commits into from Oct 20, 2020

Conversation

boardfish
Copy link
Contributor

@boardfish boardfish commented Oct 4, 2020 •
edited

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Updates documentation relating to emails. In particular, documents how the mailer views can be overridden, especially for devise_invitable.

While working on this, I identified that there aren't mailer previews for devise_invitable (#10575).

Related Tickets & Documents

#9849

QA Instructions, Screenshots, Recordings

Edit the contents of a mailer view under the given directories, and check the mailer previews to make sure they make sense.

Added tests?

  • yes
  • no, because they aren't needed
  • no, because I need help

Added to documentation?

  • docs.forem.com
  • readme
  • no documentation needed

@boardfish boardfish requested a review from a team October 4, 2020 15:58
@pr-triage pr-triage bot added the PR: unreviewed bot applied label for PR's with no review label Oct 4, 2020
@CLAassistant
Copy link

CLAassistant commented Oct 4, 2020 •
edited

CLA assistant check
All committers have signed the CLA.

jacobherrington
jacobherrington approved these changes Oct 6, 2020
View reviewed changes
Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to the project @boardfish! Thanks for making a PR. I think this looks good to merge!

I'm not certain this closes Lee's request in #9849 because this isn't an ideal solution for the Forem product. I'll mention my thoughts in the issue.

I think ideally we'd find a way to modify mailer templates in the UI.

However, this is a good thing to have documented 👍

@pr-triage pr-triage bot added PR: partially-approved bot applied label for PR's where a single reviewer approves changes and removed PR: unreviewed bot applied label for PR's with no review labels Oct 6, 2020
@jacobherrington jacobherrington mentioned this pull request Oct 6, 2020
Closed
@boardfish
Copy link
Contributor Author

Okay, I've modified the description so this won't close the PR. Good for this to be merged. Thanks for the warm welcome!

rhymes
rhymes reviewed Oct 7, 2020
View reviewed changes
Copy link
Contributor

@rhymes rhymes left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @boardfish, one small detail, the new page should be listed in https://github.com/forem/forem/blob/master/docs/backend/readme.md (which now points to the old template) so it can be listed in https://docs.dev.to/backend/

@boardfish boardfish requested review from nickytonline and a team as code owners October 17, 2020 14:43
@pr-triage pr-triage bot added PR: unreviewed bot applied label for PR's with no review and removed PR: partially-approved bot applied label for PR's where a single reviewer approves changes labels Oct 17, 2020
@boardfish boardfish force-pushed the 9849-devise-mailer-documentation branch from 08d51d0 to 8931be0 Compare October 17, 2020 14:46
@boardfish
Copy link
Contributor Author

Apologies for the delay, I've had a lot going on. Looking to make some progress on all my assigned issues this weekend.

mstruve
mstruve approved these changes Oct 17, 2020
View reviewed changes
Copy link
Contributor

@mstruve mstruve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NICE!!! Nothing beats good clear docs 🚀

@pr-triage pr-triage bot added PR: partially-approved bot applied label for PR's where a single reviewer approves changes and removed PR: unreviewed bot applied label for PR's with no review labels Oct 17, 2020
@rhymes rhymes merged commit 1c6f82b into forem:master Oct 20, 2020
@pr-triage pr-triage bot added PR: merged bot applied label for PR's that are merged and removed PR: partially-approved bot applied label for PR's where a single reviewer approves changes labels Oct 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhymes rhymes rhymes left review comments

@mstruve mstruve mstruve approved these changes

@jacobherrington jacobherrington jacobherrington approved these changes

@nickytonline nickytonline Awaiting requested review from nickytonline

Assignees
No one assigned
Labels
PR: merged bot applied label for PR's that are merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@boardfish @CLAassistant @rhymes @mstruve @jacobherrington