-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Replace the PNG diagram with Mermaid #29
Conversation
Is it possible to have a legend like in the original png? I looked at the mermaid docs to do it myself quickly but it didn't seem obvious what do or would we need to add it in the markdown itself? |
Looks really nice though |
It is possible, however after played with the diagram (especially trying to find the color that works for both dark/light modes), I start to prefer that we don't specify color at all:
|
This is what I would suggest after tried various approaches (which looks nice in both light/dark theme): graph TD
adservice(Ad Service<br/>(Java)):::java
cache[(Cache<br/>(redis))]
cartservice(Cart Service<br/>(.NET)):::dotnet
checkoutservice(Checkout Service<br/>(Go)):::golang
currencyservice(Currency Service<br/>(Node.js)):::nodejs
emailservice(Email Service<br/>(Python)):::python
frontend(Frontend<br/>(Go)):::golang
loadgenerator([Load Generator<br/>(Python)]):::python
paymentservice(Payment Service<br/>(Node.js)):::nodejs
productcatalogservice(ProductCatalog Service<br/>(Go)):::golang
recommendationservice(Recommendation Service<br/>(Python)):::python
shippingservice(Shipping Service<br/>(Go)):::golang
Internet -->|HTTP| frontend
loadgenerator -->|HTTP| frontend
checkoutservice --> cartservice --> cache
checkoutservice --> productcatalogservice
checkoutservice --> currencyservice
checkoutservice --> emailservice
checkoutservice --> paymentservice
checkoutservice --> shippingservice
frontend --> adservice
frontend --> cartservice
frontend --> productcatalogservice
frontend --> checkoutservice
frontend --> currencyservice
frontend --> recommendationservice --> productcatalogservice
frontend --> shippingservice
|
future enhancement would be to add grpc / http between the various services but non blocking for now. We can open an issue for that later |
Fixes #27.
Here goes what the diagram looks like:
Old version, please refer to the new one and the discussion #29 (comment)