DoSomethingArchive / quicksilver-api

:postbox: API gateway to Quicksilver (Message Broker) functionality.
MIT License
0 stars 3 forks source link

Create queues documentation table. #6

Closed sergiitk closed 8 years ago

sergiitk commented 8 years ago

A boilerplate queues documentation.

deezone commented 8 years ago

Add:

| Producers | Exchange | Queue | Consumers | Description |
sergiitk commented 8 years ago

Should I keep the queues list?

deezone commented 8 years ago

This is an example of one row with only one of many queues connected to the transactionalExchange:

| Producers                                                   | Exchange                      | Queue                                  | Consumers                                              | Description                                             |
| ----------------------------------------------------------: |:-----------------------------:|:--------------------------------------:| :----------------------------------------------------: | :-----------------------------------------------------: |
| Phoenix                                                     | transactionalExchange (topic) | transactionalQueue (*.*.transactional) | mbc-transactional-email                                |                                                         |
| -> user registration (user.registration.transactional)      |                               |                                        | https://github.com/DoSomething/mbc-transactional-email | Transactional email messages sent through Mandrill API. |
| -> user password reset (user.password_reset.transactional)  |                               |                                        |                                                        |                                                         |
| -> campaign signup (campaign.signup.transactional)          |                               |                                        |                                                        |                                                         |
| -> campaign reportback (campaign.report_back.transactional) |                               |                                        |                                                        |                                                         |

Perhaps the queue list should be broken down as their own table by exchange?

sergiitk commented 8 years ago

Merging this version so @DeeZone can make his changes to the structure, which is a little off.