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

chore(messaging-documentation) - Add GH page for Message Router #638

Merged
merged 2 commits into from
May 7, 2024

Conversation

lilla28
Copy link
Contributor

@lilla28 lilla28 commented May 7, 2024

Changes:

  • Added GH page for Message Router

@lilla28 lilla28 requested a review from a team as a code owner May 7, 2024 10:40
Copy link

codecov bot commented May 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.08%. Comparing base (47ad140) to head (8411684).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #638      +/-   ##
==========================================
- Coverage   74.11%   74.08%   -0.03%     
==========================================
  Files         242      242              
  Lines        7495     7495              
  Branches      843      842       -1     
==========================================
- Hits         5555     5553       -2     
  Misses       1742     1742              
- Partials      198      200       +2     

see 2 files with indirect coverage changes

@psmulovics
Copy link
Member

@mimiflynn , this would our first version specific documentation page. Can you please confirm we are doing the right thing?

@kruplm
Copy link
Contributor

kruplm commented May 7, 2024

FYI I'm checking a local build with the changes at the moment.

@kruplm
Copy link
Contributor

kruplm commented May 7, 2024

@psmulovics @lilla28 This is looking good to me based on the local build:
docu-1
docu-2
docu-3

@mimiflynn feel free to verify as well :)

Message Router is an open-source out-of-the-box library that is fast and reliable. It supports JSON and it also uses WebSockets and has a Javascript library, so Web-based applications can be integrated.
So basically it is real-time solution that can be easily setup for Pub-Sub messaging.

More details can be found under the [ADR-012](https://github.com/morganstanley/ComposeUI/blob/main/architecture/adr-012-message-router.md).
Copy link
Member

Choose a reason for hiding this comment

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

Any interest in having a section of the documentation site for these ADRs?

Copy link
Member

Choose a reason for hiding this comment

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

@mimiflynn , definitely. Where would you suggest putting them?

Copy link
Member

Choose a reason for hiding this comment

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

Would it makes sense to keep in the docs section or do you think a separate ADR space would be better?

Copy link
Member

Choose a reason for hiding this comment

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

I'm far from being a designer :) but I'd put it under docs.

@psmulovics psmulovics merged commit e0a5520 into morganstanley:main May 7, 2024
4 of 5 checks passed
@lilla28 lilla28 deleted the message-router/documentation branch May 15, 2024 10:06
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.

4 participants