reviewed the article, made some changes for consistency

thorbenheins commented 5 days ago

maybe we should also update this to contain information about event hub?

Summary by CodeRabbit

Documentation
- Updated descriptions of challenges and solutions related to AsyncAPI integration.
- Clarified the transition from a custom configuration model to AsyncAPI documentation.
- Specified the creation of multiple AsyncAPI documents and the use of GitOps for topic configurations.
- Improved clarity and consistency with grammatical corrections and rephrasing.
- Updated future plans for replacing the custom configuration model with AsyncAPI documents.

coderabbitai[bot] commented 5 days ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes in the hdi.yml configuration file focus on enhancing the descriptions related to challenges and solutions for integrating AsyncAPI in asynchronous communication. Key updates include consistent capitalization of "Integration Platform Team," clarification of the transition to AsyncAPI documentation, and the specification that multiple AsyncAPI documents will be created. The document also outlines a GitOps setup for managing topic configurations and describes an automatic generation process for the AsyncAPI document upon configuration changes. Minor grammatical corrections were made throughout for clarity.

Changes

File	Change Summary
config/casestudies/hdi.yml	Updated descriptions of challenges and solutions regarding AsyncAPI integration, clarified transition from custom model to AsyncAPI, and specified multiple document creation. Consistent capitalization applied and minor grammatical corrections made.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AsyncAPI
    participant GitOps
    participant Repo

    User->>AsyncAPI: Request configuration change
    AsyncAPI->>GitOps: Trigger document generation
    GitOps->>Repo: Update topic configurations
    Repo->>AsyncAPI: Validate and commit changes

🐇 "In the meadow where bunnies play,
We’ve updated our docs today!
AsyncAPI leads the way,
With clarity in every sway.
GitOps and changes, oh what fun,
Hop along, the work is done!" 🐇

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?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

netlify[bot] commented 5 days ago

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
Latest commit	9550a046bc7326679f5ee8ca10450b3905eef0a6
Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67457382171736000911c28f
Deploy Preview	https://deploy-preview-3431--asyncapi-website.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

asyncapi-bot commented 5 days ago

We require all PRs to follow Conventional Commits specification. More details 👇🏼

 No release type found in pull request title "reviewed the article, made some changes for consistency". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

thorbenheins commented 5 days ago

sorry for the mixup, we want to review it on our side first

asyncapi-bot commented 5 days ago

⚡️ Lighthouse report for the changes in this PR:	Category	Score
🔴 Performance	39
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-3431--asyncapi-website.netlify.app/

derberg commented 4 days ago

@thorbenheins no worries, just ping us in this PR whenever you're ready by putting / and ptal as a command. You can also do this /help

asyncapi-bot commented 4 days ago

Hello, @derberg! 👋🏼

    I'm 🧞🧞🧞 Genie 🧞🧞🧞 from the magic lamp. Looks like somebody needs a hand!

    At the moment the following comments are supported in pull requests:

    - `/please-take-a-look` or `/ptal` - This comment will add a comment to the PR asking for attention from the reviewrs who have not reviewed the PR yet.
    - `/ready-to-merge` or `/rtm` - This comment will trigger automerge of PR in case all required checks are green, approvals in place and do-not-merge label is not added
    - `/do-not-merge` or `/dnm` - This comment will block automerging even if all conditions are met and ready-to-merge label is added
    - `/autoupdate` or `/au` - This comment will add `autoupdate` label to the PR and keeps your PR up-to-date to the target branch's future changes. Unless there is a merge conflict or it is a draft PR. (Currently only works for upstream branches.)
    - `/update` or `/u` - This comment will update the PR with the latest changes from the target branch. Unless there is a merge conflict or it is a draft PR. NOTE: this only updates the PR once, so if you need to update again, you need to call the command again.

asyncapi / website