docbrown/docs/backend/notification.md
Jacob Herrington 7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00

30 lines
935 B
Markdown

---
title: Notifications
---
# Notifications
Since notifications are run asynchronously, we'll want to make sure jobs are
running: `bin/rails jobs:work`. If that's not running, you won't receive any
notifications. You might need to create another account to pass notifications
back and forth if you're doing this all through the UI.
Otherwise, you can generate notifications from the Rails console and run the
class methods from `app/models/notification.rb`. For example:
```ruby
# follow notification
me = User.last
follow = User.first.follow(me)
Notification.send_new_follower_notification_without_delay(follow)
# reaction notification
rxn = Reaction.create(
user_id: 1,
category: "like",
reactable: me.articles.last, # this assumes you have an article written
)
Notification.send_reaction_notification_without_delay(rxn, me)
```
Notice you have to run these methods `without_delay` since this is assuming jobs
are not running.