ARTEMIS-5797 Updated docs for AMQP federation #6101
Conversation
There was a problem hiding this comment.
What do the arrows specifically represent here? Are they based on what the underlying federation would be doing given the message demand from the consumers and the message supply from the producer? If so, I would expect there to be no arrow between Spoke 3 and the Hub since there is neither demand or supply on Spoke 3.
There was a problem hiding this comment.
The arrows represent a consumer link with the arrow point to where the messages flow. There is demand on the other spokes which means the hub listens on the spoke in case messages are delivered there as it needs to forward them to where there is demand.
There was a problem hiding this comment.
That makes sense. Thanks!
There was a problem hiding this comment.
It's not always intuitive and it was a bit hard to create diagrams that don't get way to busy trying to show what's going on. I was trying to keep from adding to much actual implementation details but eventually we might want to expand on things more as folks ask questions.
There was a problem hiding this comment.
I added some clarification in that paragraph about the linkages between nodes
Add more detailed documentation for AMQP federation convering more of the configuration options and example configurations.
tabish121
force-pushed
the
amqp-federation-docs
branch
from
f80aa31 to
48f030d
Compare
|
The convention we've adopted for AsciiDoc uses one sentence-per-line. I see that being used in some places, but not in others. |
Is there a technical reason for that, it makes actually writing them god awful. |
|
We manually wrapped our previous mark-down docs which was extremely tedious and prone to mess up. Lines with no wrapping are a pain to scroll down and read. Soft wrapping is an option in some cases, but not all. The sentence-per-line convention is a balance of the two options, and it's recommended by the AsciiDoc folks for a number of reasons. For what it's worth, I've not found the process to be a hindrance or an annoyance. Is there something specific that's "god awful"? 😆 |
I won't ever remember to do it, so will always have to go back and do it as I apparently will now, and reading it either involves endless scrolling for long sentences or a jumbled mess if you use auto wrap. In any case I will mark this as draft and try and find some motivation to fix it later. |
|
If you use the AsciiDoctor plugin for IntelliJ you can just do Ctrl-Alt-Shift-F and the plugin will format everything correctly. I've been using this plugin for a few years now and found it quite useful. |
|
Not everyone uses intellij |
|
Done. |
Explain a bit more of the linkages between nodes when demand is applied on a spoke.
Thanks, that saves me some eye strain |
2 participants
Add more detailed documentation for AMQP federation convering more of the configuration options and example configurations.