docs: case study from HDI Global SE #3010
Conversation
vlazw
requested review from
derberg,
akshatnema,
magicmatatjahu,
anshgoyalevil,
Mayaleeeee and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
vlazw
changed the title
derberg
changed the title
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3010--asyncapi-website.netlify.app/ |
|
@TRohit20 why WIP? I'm focusing on review |
| helloworld-emea: | ||
| servers: | ||
| - $ref: '#/servers/box-emea' | ||
| address: https://namespace.servicebus.windows.net/topic/example/helloworld |
There was a problem hiding this comment.
can you elaborate a bit more about the address please, so I understand how things work on your end - I don't have much experience with Azure Service Bus
so in servers, you specify host as namespace.servicebus.windows.net and protocol is amqp but in channel address you have a link using HTTPS scheme. Can you share why it works this way?
config/casestudies/hdi.yml
Outdated
| This approach makes our asynchronous communication is as transparent and discoverable as our synchronous communication. | ||
| technical: #We need some more technical information related to case study. | ||
| languages: | ||
| - bash |
There was a problem hiding this comment.
languages are not only for the language used to provide your solution to a problem. It is more about entire EDA solution, what programming languages you use. I guess it is Java, right? then please change that
config/casestudies/hdi.yml
Outdated
| languages: | ||
| - bash | ||
| frameworks: | ||
| - Nothing specific |
There was a problem hiding this comment.
same as with languages, any specific framework for EDA you use? Spring Cloud Stream? or maybe Quarkus?
| frameworks: | ||
| - Nothing specific | ||
| protocols: | ||
| - AMQP |
There was a problem hiding this comment.
so AMQP is main protocol, and HTTPS is just a transport?
There was a problem hiding this comment.
Yes exactly the primary protocol for Service Bus is AMQP
config/casestudies/hdi.yml
Outdated
| - AMQP | ||
| brokers: Azure Service Bus | ||
| testing: | | ||
| The AsyncAPI document is validated using the AsyncAPI CLI to confirm that the document is correctly formatted and adheres to the AsyncAPI specification. |
There was a problem hiding this comment.
it is more related to overall testing strategy for EDA, how do you approach it.
info about validating AsyncAPI documents with CLI, please move it to Solution section, where you can specify if the check happens in a pipeline or where exactly?
config/casestudies/hdi.yml
Outdated
| This pipeline uses a bash script to read the updated configuration from the customer's repository. | ||
| It then generates a new AsyncAPI file reflecting these changes. | ||
| maintainers: | | ||
| No specific maintainers are assigned to the AsyncAPI document. The document is automatically generated by a pipeline. |
There was a problem hiding this comment.
can you also elaborate more, here or in Solution section about the custom format you have, for specifying topics. To explain where AsyncAPI document is generated from, what is the source of information, what comes from custom format, what from code - and who maintains these sources
config/casestudies/hdi.yml
Outdated
| extensions: | | ||
| none | ||
| documentation: | | ||
| Documentation is generated via AsyncAPI CLI and published to the wiki right after the AsyncAPI file is generated. |
There was a problem hiding this comment.
when you write wiki,
the central repo with all AsyncAPI docs and generated markdown - do you use GitHub Wiki solution to render these markdowns? or? why you call it wiki?
| Documentation is generated via AsyncAPI CLI and published to the wiki right after the AsyncAPI file is generated. | ||
| bindings: | | ||
| none | ||
| tools: | |
There was a problem hiding this comment.
can you add CLI to the list please? and also code generators that you use, which ones
Co-authored-by: Lukasz Gornicki <[email protected]>
Co-authored-by: Lukasz Gornicki <[email protected]>
There was a problem hiding this comment.
@vlazw thanks a lot man!!! I only made directly small change as like we talked during the call, "testing" part is about general testing strategies you do in EDA, not how you test asyncapi documents. I moved that part to asyncapi.editing
|
@derberg do we need other people to approve this one or we can merge this one |
|
/rtm |
Description