Skip to content

Conversation

@jbertram
Copy link
Contributor

@jbertram jbertram commented Jan 26, 2022

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.

@jbertram jbertram force-pushed the ARTEMIS-3657 branch 2 times, most recently from 72a07d2 to 70019ba Compare January 26, 2022 18:02
@jbertram jbertram force-pushed the ARTEMIS-3657 branch 3 times, most recently from 910fbe9 to 7fbbdcd Compare February 10, 2022 16:29
@jbertram
Copy link
Contributor Author

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.

Copy link
Member

@brusdev brusdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!!!

Comment on lines +21 to +22
Messages are *sent* to an address. An address is given a unique name, a routing
type, and zero or more queues.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor Author

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants