-
Notifications
You must be signed in to change notification settings - Fork 224
docs: add architecture diagram to README #1549
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
base: master
Are you sure you want to change the base?
Conversation
flowchart LR | ||
A[End User Application] -->|HTTP or gRPC| B[Dapr Java SDK] | ||
B -->|API calls| C[Dapr Sidecar] | ||
C -->|State Store, Pub/Sub, Service Invocation, Bindings, Actors, Workflows| D[External Components] |
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.
Would it be worth just saying Dapr API calls instead of listing them all out? I mention this because I notice you are missing some, and as we add more in the future we will become outdated if we list them all individually. My recommendation would be to note generally this section is the Dapr API calls and link to the available APIs from the Dapr Docs here: https://docs.dapr.io/reference/api/
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.
Thanks for the PR 🎉 I think this is great! Just one comment from me
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1549 +/- ##
============================================
+ Coverage 76.91% 78.91% +1.99%
- Complexity 1592 1936 +344
============================================
Files 145 237 +92
Lines 4843 5956 +1113
Branches 562 611 +49
============================================
+ Hits 3725 4700 +975
- Misses 821 936 +115
- Partials 297 320 +23 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This PR adds an architecture diagram to the README to help new contributors and users understand how a Java application interacts with the Dapr runtime via the Java SDK.
This addresses #915.
