-
Notifications
You must be signed in to change notification settings - Fork 947
ARTEMIS-3657 refactor address docs #3930
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
72a07d2 to
70019ba
Compare
910fbe9 to
7fbbdcd
Compare
|
I realize this is a lot to review, but it's been up for over 20 days now with no comments. I optimistically assume that's a good thing. I'll give it a few more days and then merge it if there's no feedback. |
brusdev
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!!!
7fbbdcd to
6f1ac80
Compare
| Messages are *sent* to an address. An address is given a unique name, a routing | ||
| type, and zero or more queues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Messages are *sent* to an address. An address is given a unique name, a routing | |
| type, and zero or more queues. | |
| Messages are *sent* to an address. An address is given a unique name and zero or more queues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have routing type in here to explain a configuration like this:
<address name="myTopic">
<multicast/>
</address>Here the address has a routing type and 0 queues.
Mainly refactoring the address docs. This commit has the following changes: - Remove examples for discouraged use-cases (e.g. using anycast and multicast on the same address). - Reword to use configuration terms wherever possible. For example, instead of saying "point-to-point" (which is not a configuration term) say "anycast". References to things like "point-to-point" and "publish-subscribe" are still there since users are familiar with these terms. They're just used much less often. - Remove duplicate explanation of exclusive queues. - Remove duplicate explanation of auto-create and auto-delete elements. - Re-create graphics and include the master SVGs for potential updates later. - Give non-destructive queues its own chapter. - Add details about specifying routing type using a message property. - Update the styling on the user manual's cover page to look better. - Lots of re-wording for clarity's sake. - Re-order sub-sections for clarity's sake. - Break up the address model and the settings documentation. The settings documentation is large and deserves its own chapter. The original anchor link is still available with a link to the new chapter. In general the address-specific documentation should be much more clear, concise, and consistent now.
6f1ac80 to
e05825b
Compare
Mainly refactoring the address docs. This commit has the following
changes:
multicast on the same address).
instead of saying "point-to-point" (which is not a configuration term)
say "anycast". References to things like "point-to-point" and
"publish-subscribe" are still there since users are familiar with these
terms. They're just used much less often.
later.
settings documentation is large and deserves its own chapter. The
original anchor link is still available with a link to the new chapter.
In general the address-specific documentation should be much more clear,
concise, and consistent now.