Add developer documentation about working with sent emails and previews
This commit is contained in:
parent
0cd1563fb6
commit
ac51f44f75
2 changed files with 24 additions and 0 deletions
|
@ -43,6 +43,7 @@
|
||||||
- [Object state models](object_state_models.md)
|
- [Object state models](object_state_models.md)
|
||||||
- [Building a package for testing purposes](build_test_package.md)
|
- [Building a package for testing purposes](build_test_package.md)
|
||||||
- [Manage feature flags](feature_flags.md)
|
- [Manage feature flags](feature_flags.md)
|
||||||
|
- [View sent emails or preview mailers](emails.md)
|
||||||
|
|
||||||
## Databases
|
## Databases
|
||||||
|
|
||||||
|
|
23
doc/development/emails.md
Normal file
23
doc/development/emails.md
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
# Dealing with email in development
|
||||||
|
|
||||||
|
## Sent emails
|
||||||
|
|
||||||
|
To view rendered emails "sent" in your development instance, visit
|
||||||
|
[`/rails/letter_opener`](http://localhost:3000/rails/letter_opener).
|
||||||
|
|
||||||
|
## Mailer previews
|
||||||
|
|
||||||
|
Rails provides a way to preview our mailer templates in HTML and plaintext using
|
||||||
|
dummy data.
|
||||||
|
|
||||||
|
The previews live in [`spec/mailers/previews`][previews] and can be viewed at
|
||||||
|
[`/rails/mailers`](http://localhost:3000/rails/mailers).
|
||||||
|
|
||||||
|
See the [Rails guides] for more info.
|
||||||
|
|
||||||
|
[previews]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/spec/mailers/previews
|
||||||
|
[Rails guides]: http://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[Return to Development documentation](README.md)
|
Loading…
Reference in a new issue