diff options
| author | Rémy Coutable <remy@rymai.me> | 2017-09-12 16:30:59 +0000 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2017-09-12 16:30:59 +0000 |
| commit | f0b4e547519af428e3827d6230505123ce9da0f6 (patch) | |
| tree | 1d6e189a1a15b4bfd6b76982e4f3ec9eca67abf6 | |
| parent | 0cd1563fb66e9ba533346fe3957912225e27000f (diff) | |
| parent | ac51f44f752476caf205dbeff03e094c829ea8e5 (diff) | |
| download | gitlab-ce-f0b4e547519af428e3827d6230505123ce9da0f6.tar.gz | |
Merge branch 'rs-dev-email-docs' into 'master'
Add developer documentation about working with sent emails and previews
See merge request !14227
| -rw-r--r-- | doc/development/README.md | 1 | ||||
| -rw-r--r-- | doc/development/emails.md | 23 |
2 files changed, 24 insertions, 0 deletions
diff --git a/doc/development/README.md b/doc/development/README.md index eeff14819da..3096d9f25f0 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -43,6 +43,7 @@ - [Object state models](object_state_models.md) - [Building a package for testing purposes](build_test_package.md) - [Manage feature flags](feature_flags.md) +- [View sent emails or preview mailers](emails.md) ## Databases diff --git a/doc/development/emails.md b/doc/development/emails.md new file mode 100644 index 00000000000..18f47f44cb5 --- /dev/null +++ b/doc/development/emails.md @@ -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) |