[Messenger] Updating messenger docs for 4.3 #11602
Conversation
| @@ -0,0 +1,138 @@ | |||
| How to Create Your own Messenger Transport | |||
There was a problem hiding this comment.
This document was extracted to its own doc, but is unchanged and still untested.
| .. configuration-block:: | ||
| Supervisor is a great tool to guarantee that your worker process(es) is | ||
| *always* running (even if it closes due to failure, hitting a message limit | ||
| or thanks to ``messenger:stop-workers``). You can install it on Ubuntu, for |
There was a problem hiding this comment.
We should mention Windows and macOS too, even adding some links to how to install Supervisor (or its alternatives, if they are compatible with Messenger too).
There was a problem hiding this comment.
Usually, we do not show installation instructions of third party tools. We only link to their official installation guide
There was a problem hiding this comment.
It's so simple to say apt-get install supervisor - I think it illustrates (without going into too much detail) how you install it on the most popular system. The realistic options are just to say "Install supervisor" and nothing else (because we don't want to link to or show every system's setup, obviously) or sudo apt-get install supervisor. The latter feels more practical to me
There was a problem hiding this comment.
Hmm, good point! I think the best way is linking to their docs and showing the apt install line (btw please suggest apt and not apt-get), that'll please everyone :)
|
|
||
| ================== =================================== ======= | ||
| Option Description Default | ||
| ================== =================================== ======= |
There was a problem hiding this comment.
I think we should fix these outline lines to match the longest length of this column
There was a problem hiding this comment.
I kind of did it on purpose :). These "simple" tables are meant to be easier to write - I think we should be a bit flexible on them.
There was a problem hiding this comment.
Hmm, I guess it's just me that goes "whaaaa" when seeing outlining like this :)
Co-Authored-By: Wouter J <[email protected]> Co-Authored-By: Maxime Helias <[email protected]>
This PR was merged into the 4.3 branch. Discussion ---------- [Messenger] Updating messenger docs for 4.3 Hi! This rewrites the docs for Messenger for 4.3. Code was tested as I wrote it, however, any reviews are warmly welcomed as there are many details. Btw, I'm experimenting with a new (but not crazy) idea with the messenger docs, which is: A) To mostly favor in big document, but still isolate bigger, more complex "how to" topics to other documents B) To think critically about the top level (h2) and secondary level (h3) headlines and let that guide the docs. The reason is that these are what show up on the left sidebar of the docs (https://symfony.com/doc/4.1/messenger.html) and I think we should control what this looks like in a purposeful way. Here is the hierarchy for these new docs: ``` - Installation - Creating a Message & Handler - Dispatching the Message - Transports: Async/Queued Messages - Routing Messages to a Transport - Doctrine Entities in Messages - Handling Messages Synchronously - creating your own transport [External] - Consuming Messages (Running the Worker) - Deploying to Production - Prioritized Transports - Supervisor Configuration - Retries & Failure - Avoiding Retry on an Error - Saving & Retrying Failed Messages - Transport Configuration - amqp Transport - doctrine Transport - redis Transport - in-memory Transport - Serializing Messages - Customizing Handlers - Manually Configuring the Handler - Handler Subscriber & Options - Sending Handlers to Different Transports - Extending Messenger - Envelopes - Disabling default Middleware - Adding your own Middleware - Middleware for Doctrine - Events - Multiple Buses, Command & Event Buses - Learn More ``` Closes #11236 Closes #10281 Closes #10279 Closes #9662 Closes #9651 Closes #9639 Commits ------- 3e67080 Updating messenger docs for 4.3
|
Nice work @weaverryan. I just added some comments while reading through it with pleasure. |
…(weaverryan) This PR was merged into the 4.3 branch. Discussion ---------- Tweaks to messenger docs based on feedback from @Tobion See @Tobion's review: #11602 (review) - it contains some good stuff. Commits ------- 5d561fb tweaks to messenger docs based on feedback from @Tobion
Hi!
This rewrites the docs for Messenger for 4.3. Code was tested as I wrote it, however, any reviews are warmly welcomed as there are many details.
Btw, I'm experimenting with a new (but not crazy) idea with the messenger docs, which is:
A) To mostly favor in big document, but still isolate bigger, more complex "how to" topics to other documents
B) To think critically about the top level (h2) and secondary level (h3) headlines and let that guide the docs. The reason is that these are what show up on the left sidebar of the docs (https://symfony.com/doc/4.1/messenger.html) and I think we should control what this looks like in a purposeful way. Here is the hierarchy for these new docs:
Closes #11236
Closes #10281
Closes #10279
Closes #9662
Closes #9651
Closes #9639