docs: add gerrit to operator list and additional enhancements - #3539
docs: add gerrit to operator list and additional enhancements#3539csviri wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README project list adds descriptions for Apache Hive and Apicurio Registry. It updates the Apicurio Registry description and adds the Gerrit Operator entry. ChangesProjects Using JOSDK
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Updates the repository’s README “Projects using JOSDK” section to better describe and expand the list of known operators built with (or related to) the Java Operator SDK.
Changes:
- Adds the Gerrit Operator to the “Projects using JOSDK” list.
- Improves a couple of existing entries by adding short descriptive text and aligning list formatting.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 81: Update the “Locust k8s operator” README entry by changing the
compound adjective “Cloud native” to “Cloud-native,” preserving the rest of the
description and link.
- Line 80: Update the EureKubeOperator description in the README to use direct
wording and replace the grammatically incorrect phrase “an open source” with
“open source,” while preserving the existing meaning and link.
- Around line 75-76: Update the Strimzi Access operator description in the
README to remove the redundant “While”/“but” construction and change “components
... is using” to grammatically correct plural wording, while preserving the
intended meaning.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| - [Strimzi Access operator](https://github.com/strimzi/kafka-access-operator). While the core Strimzi operator development predates | ||
| JOSDK, but new components like the Access operator is using the framework. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the Strimzi description grammar.
The sentence uses both While and but. The plural subject components also requires use, not is using.
Proposed wording
-- [Strimzi Access operator](https://github.com/strimzi/kafka-access-operator). While the core Strimzi operator development predates
- JOSDK, but new components like the Access operator is using the framework.
+- [Strimzi Access operator](https://github.com/strimzi/kafka-access-operator). The core Strimzi operator predates
+ JOSDK, but newer components such as the Access operator use the framework.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Strimzi Access operator](https://github.com/strimzi/kafka-access-operator). While the core Strimzi operator development predates | |
| JOSDK, but new components like the Access operator is using the framework. | |
| - [Strimzi Access operator](https://github.com/strimzi/kafka-access-operator). The core Strimzi operator predates | |
| JOSDK, but newer components such as the Access operator use the framework. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 75 - 76, Update the Strimzi Access operator
description in the README to remove the redundant “While”/“but” construction and
change “components ... is using” to grammatically correct plural wording, while
preserving the intended meaning.
| - [Apicurio Registry Operator](https://github.com/Apicurio/apicurio-registry/tree/main/operator) | ||
| - [Apicurio Registry Operator](https://github.com/Apicurio/apicurio-registry/tree/main/operator) to run the registry | ||
| - [Kaap](https://github.com/datastax/kaap) autoscaling Operator for Apache Pulsar | ||
| - [EureKubeOperator](https://medium.com/@heesuk.dev/implementing-kubernetes-operator-for-eureka-service-discovery-integration-by-java-operator-sdk-d21d8087c38e): integrates service discovery of Eureka and Kubernetes using the framework - developed by 11street. It is not released as an open source yet but is very interesting to read about this problem and how it is solved by an operator written with JOSDK. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Clarify the EureKubeOperator description.
Use direct wording and replace an open source with open source.
Proposed wording
-- [EureKubeOperator](https://medium.com/@heesuk.dev/implementing-kubernetes-operator-for-eureka-service-discovery-integration-by-java-operator-sdk-d21d8087c38e): integrates service discovery of Eureka and Kubernetes using the framework - developed by 11street. It is not released as an open source yet but is very interesting to read about this problem and how it is solved by an operator written with JOSDK.
+- [EureKubeOperator](https://medium.com/@heesuk.dev/implementing-kubernetes-operator-for-eureka-service-discovery-integration-by-java-operator-sdk-d21d8087c38e): integrates Eureka and Kubernetes service discovery using the framework and was developed by 11street. It is not yet open source, but the article provides an interesting example of solving this problem with an operator written with JOSDK.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [EureKubeOperator](https://medium.com/@heesuk.dev/implementing-kubernetes-operator-for-eureka-service-discovery-integration-by-java-operator-sdk-d21d8087c38e): integrates service discovery of Eureka and Kubernetes using the framework - developed by 11street. It is not released as an open source yet but is very interesting to read about this problem and how it is solved by an operator written with JOSDK. | |
| - [EureKubeOperator](https://medium.com/@heesuk.dev/implementing-kubernetes-operator-for-eureka-service-discovery-integration-by-java-operator-sdk-d21d8087c38e): integrates Eureka and Kubernetes service discovery using the framework and was developed by 11street. It is not yet open source, but the article provides an interesting example of solving this problem with an operator written with JOSDK. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 80, Update the EureKubeOperator description in the README
to use direct wording and replace the grammatically incorrect phrase “an open
source” with “open source,” while preserving the existing meaning and link.
| - [Apicurio Registry Operator](https://github.com/Apicurio/apicurio-registry/tree/main/operator) to run the registry | ||
| - [Kaap](https://github.com/datastax/kaap) autoscaling Operator for Apache Pulsar | ||
| - [EureKubeOperator](https://medium.com/@heesuk.dev/implementing-kubernetes-operator-for-eureka-service-discovery-integration-by-java-operator-sdk-d21d8087c38e): integrates service discovery of Eureka and Kubernetes using the framework - developed by 11street. It is not released as an open source yet but is very interesting to read about this problem and how it is solved by an operator written with JOSDK. | ||
| - [Locust k8s operator](https://github.com/AbdelrhmanHamouda/locust-k8s-operator): Cloud native solution to run performance tests on any Kubernetes cluster. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Hyphenate the compound adjective.
Change Cloud native to Cloud-native.
🧰 Tools
🪛 LanguageTool
[grammar] ~81-~81: Use a hyphen to join words.
Context: ...rhmanHamouda/locust-k8s-operator): Cloud native solution to run performance tests...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 81, Update the “Locust k8s operator” README entry by
changing the compound adjective “Cloud native” to “Cloud-native,” preserving the
rest of the description and link.
Source: Linters/SAST tools
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
Signed-off-by: Attila Mészáros a_meszaros@apple.com
Summary by CodeRabbit