Skip to content
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

[AMQ-8324] Add design doc for Jakarta Messaging 3.1 asynchronous send #1390

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

kenliao94
Copy link
Contributor

Add design doc for implementing Jakarta Messaging 3.1 asynchronous send per the latest process discussed on dev list.

Note to reviewers, GitHub rich diff doesn't render image properly. You can click "view file" from the hamburger button to see the rendered markdown.

@jbonofre jbonofre self-requested a review February 19, 2025 07:25
@cshannon
Copy link
Contributor

I don't really like the use of images as they are not easily modifiable. Markdown supports code blocks (and you can mark it as java) so I would use something like that instead.

Copy link
Member

@jbonofre jbonofre left a comment

Choose a reason for hiding this comment

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

Image is fine for design diagram/schema.
However, it should not be used for code.
Instead we should use the markdown code block: the huge advantage is that we can suggest change during the review.

@@ -0,0 +1,225 @@
# Jakarta Messaging 3.1: asynchronous send design doc

Date: Jan 5th 2025
Copy link
Member

Choose a reason for hiding this comment

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

I would not add date here (the PR date is good enough 😄 ).

@cshannon
Copy link
Contributor

Image is fine for design diagram/schema. However, it should not be used for code. Instead we should use the markdown code block: the huge advantage is that we can suggest change during the review.

+1 for this

@kenliao94
Copy link
Contributor Author

Thanks @cshannon and @jbonofre for the feedback, I will use code block instead. Hoping to publish a new revision tmr.

@kenliao94
Copy link
Contributor Author

Use codeblock instead of image.

@kenliao94 kenliao94 requested a review from jbonofre February 25, 2025 23:18
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.

3 participants