docs: update HDI case study #3434
Conversation
…config. Added reference to IDP.
reviewed the article, made some changes for consistency
thorbenheins
requested review from
derberg,
akshatnema,
magicmatatjahu,
anshgoyalevil,
Mayaleeeee and
asyncapi-bot-eve
as code owners
WalkthroughThe changes made in the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3434 +/- ##
=======================================
Coverage 67.77% 67.77%
=======================================
Files 21 21
Lines 664 664
=======================================
Hits 450 450
Misses 214 214 ☔ View full report in Codecov by Sentry. |
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3434--asyncapi-website.netlify.app/ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
config/casestudies/hdi.yml (4)
14-14: Remove trailing spacesSeveral lines in this section contain trailing spaces.
- The HDI has various platform teams, among them the Integration Platform team, which offers three products: Azure API Management, Azure Event Hub, and the Azure Service Bus. + The HDI has various platform teams, among them the Integration Platform team, which offers three products: Azure API Management, Azure Event Hub, and the Azure Service Bus. - configuration model in a GitOps fashion. + configuration model in a GitOps fashion. - We want to establish AsyncAPI as documentation standard in HDI's organization. Information about the available message formats and topics is already available in distributed + We want to establish AsyncAPI as documentation standard in HDI's organization. Information about the available message formats and topics is already available in distributed - sources (e.g. repositories) and needs to be aggregated. + sources (e.g. repositories) and needs to be aggregated. - To achieve discoverability the creation of a comprehensive catalog of existing topics is necessary, allowing potential subscribers access to information about + To achieve discoverability the creation of a comprehensive catalog of existing topics is necessary, allowing potential subscribers access to information aboutAlso applies to: 17-17, 18-18, 19-19, 20-20
🧰 Tools
🪛 yamllint (1.35.1)
[error] 14-14: trailing spaces
(trailing-spaces)
25-25: Remove trailing spacesSeveral lines in this section contain trailing spaces.
- The solution is to create AsyncAPI documents where each topic owned by the customer is represented as a channel. + The solution is to create AsyncAPI documents where each topic owned by the customer is represented as a channel. - As we are using the GitOps setup it is straightforward to run pipeline whenever there is a change (commit) in the topic configuration. + As we are using the GitOps setup it is straightforward to run pipeline whenever there is a change (commit) in the topic configuration.Also applies to: 26-26, 27-27, 28-28
🧰 Tools
🪛 yamllint (1.35.1)
[error] 25-25: trailing spaces
(trailing-spaces)
203-205: LGTM: Clear roadmap for AsyncAPI adoptionThe outlook section presents a well-structured roadmap. Consider prioritizing the evaluation of replacing the custom configuration model (line 205) before implementing the internal developer portal integration, as this architectural decision could impact the portal's implementation.
216-216: LGTM: Added AsyncAPI validation stepGood addition of the AsyncAPI CLI validation step. Consider documenting the error handling process for validation failures to ensure consistent handling across the team.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
config/casestudies/hdi.yml(3 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
config/casestudies/hdi.yml
[error] 14-14: trailing spaces
(trailing-spaces)
[error] 17-17: trailing spaces
(trailing-spaces)
[error] 18-18: trailing spaces
(trailing-spaces)
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 20-20: trailing spaces
(trailing-spaces)
[error] 25-25: trailing spaces
(trailing-spaces)
[error] 26-26: trailing spaces
(trailing-spaces)
[error] 27-27: trailing spaces
(trailing-spaces)
[error] 28-28: trailing spaces
(trailing-spaces)
🔇 Additional comments (3)
config/casestudies/hdi.yml (3)
7-7: LGTM: Revenue format standardization
The change from "Mrd." to "B" makes the revenue format more internationally recognizable.
14-21: LGTM: Clear articulation of challenges
The challenges section effectively communicates:
- The context of platform teams and their products
- The parallel between OpenAPI (sync) and AsyncAPI (async) standards
- The GitOps approach to topic management
- The goal of establishing AsyncAPI as a documentation standard
🧰 Tools
🪛 yamllint (1.35.1)
[error] 14-14: trailing spaces
(trailing-spaces)
[error] 17-17: trailing spaces
(trailing-spaces)
[error] 18-18: trailing spaces
(trailing-spaces)
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 20-20: trailing spaces
(trailing-spaces)
25-31: LGTM: Well-defined solution implementation
The solution section effectively describes:
- The use of AsyncAPI documents for topic representation
- Integration with GitOps workflow
- Documentation accessibility through Azure DevOps wiki
🧰 Tools
🪛 yamllint (1.35.1)
[error] 25-25: trailing spaces
(trailing-spaces)
[error] 26-26: trailing spaces
(trailing-spaces)
[error] 27-27: trailing spaces
(trailing-spaces)
[error] 28-28: trailing spaces
(trailing-spaces)
derberg
changed the title
removing reference to specific library to use, in order avoid confusion and not send dev running in the wrong direction, as modelina is the correct approach.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
config/casestudies/hdi.yml (2)
25-31: Consider clarifying the pipeline processThe solution description could be more specific about the pipeline process. Consider mentioning:
- The trigger conditions for the pipeline
- The validation steps performed
- The deployment process to the Azure DevOps wiki
The solution is to create AsyncAPI documents where each topic owned by the customer is represented as a channel. - As we are using the GitOps setup it is straightforward to run pipeline whenever there is a change (commit) in the topic configuration. + As we are using the GitOps setup, our CI/CD pipeline automatically triggers when a commit is made to the topic configuration. + The pipeline performs the following steps: + 1. Validates the configuration changes + 2. Generates the AsyncAPI document + 3. Creates the corresponding markdown documentation + 4. Deploys both files to our documentation repository🧰 Tools
🪛 yamllint (1.35.1)
[error] 25-25: trailing spaces
(trailing-spaces)
[error] 26-26: trailing spaces
(trailing-spaces)
[error] 27-27: trailing spaces
(trailing-spaces)
[error] 28-28: trailing spaces
(trailing-spaces)
14-28: Fix trailing spaces in YAML fileMultiple trailing spaces were detected in the file. While this doesn't affect functionality, clean formatting improves maintainability.
Consider running the file through a YAML formatter to clean up these formatting issues.
🧰 Tools
🪛 yamllint (1.35.1)
[error] 14-14: trailing spaces
(trailing-spaces)
[error] 17-17: trailing spaces
(trailing-spaces)
[error] 18-18: trailing spaces
(trailing-spaces)
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 20-20: trailing spaces
(trailing-spaces)
[error] 25-25: trailing spaces
(trailing-spaces)
[error] 26-26: trailing spaces
(trailing-spaces)
[error] 27-27: trailing spaces
(trailing-spaces)
[error] 28-28: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
config/casestudies/hdi.yml(3 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
config/casestudies/hdi.yml
[error] 14-14: trailing spaces
(trailing-spaces)
[error] 17-17: trailing spaces
(trailing-spaces)
[error] 18-18: trailing spaces
(trailing-spaces)
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 20-20: trailing spaces
(trailing-spaces)
[error] 25-25: trailing spaces
(trailing-spaces)
[error] 26-26: trailing spaces
(trailing-spaces)
[error] 27-27: trailing spaces
(trailing-spaces)
[error] 28-28: trailing spaces
(trailing-spaces)
🔇 Additional comments (4)
config/casestudies/hdi.yml (4)
7-7: LGTM: Revenue format standardization
The change from "Mrd." to "B" improves international readability of the revenue figure.
14-21: LGTM: Clear articulation of challenges
The revised challenges section effectively communicates:
- The context of platform teams and their products
- The parallel between OpenAPI (sync) and AsyncAPI (async) standards
- The GitOps-based self-service approach
- The need for centralized documentation
🧰 Tools
🪛 yamllint (1.35.1)
[error] 14-14: trailing spaces
(trailing-spaces)
[error] 17-17: trailing spaces
(trailing-spaces)
[error] 18-18: trailing spaces
(trailing-spaces)
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 20-20: trailing spaces
(trailing-spaces)
216-216: LGTM: Added AsyncAPI document validation
Good addition of the AsyncAPI CLI validation step. This ensures document correctness before committing to the repository.
203-205: 🛠️ Refactor suggestion
Consider using Modelina for DTO generation
While the future plans are well-defined, for Java DTO generation specifically, consider using Modelina instead of AsyncAPI Generator. Modelina is the recommended tool for simple class generation, while AsyncAPI Generator is better suited for generating clients, docs, and SDKs.
- (Outlook) The AsyncAPI document will be used to generate Java DTOs, ensuring type safety and clear data structure understanding.
+ (Outlook) The AsyncAPI document will be used with Modelina to generate Java DTOs, ensuring type safety and clear data structure understanding.
|
/update |
Description
Related issue(s)
Summary by CodeRabbit
New Features
Documentation