docs: facelift of operator list in README.md - #3534
Conversation
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
There was a problem hiding this comment.
Pull request overview
Updates the “Projects using JOSDK” section in README.md to refresh and expand the operator list, making it more current and better organized for readers discovering Java Operator SDK adopters.
Changes:
- Reorders the existing operator list and normalizes list formatting/indentation.
- Adds several new operator entries (e.g., Debezium, Hive, OpenMetadata, Wanaku, Apicurio).
- Adjusts some descriptions to be more concise / single-line.
Suppressed comments (1)
README.md:78
- This list item ends with a trailing space and doesn’t include a short description (the section intro asks for one). Consider adding a brief description and removing the trailing whitespace.
- [Apicurio Registry Operator](https://github.com/Apicurio/apicurio-registry/tree/main/operator)
| - [Apache Hive Kubernetes Operator](https://github.com/apache/hive/tree/master/packaging/src/kubernetes/src/java/org/apache/hive/kubernetes/operator) | ||
| - [OpenMetadata Operator](https://github.com/open-metadata/OpenMetadata/tree/main/openmetadata-k8s-operator) |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (5)
README.md:71
- There are multiple extra spaces in this description, and "Openshift" should be capitalized as "OpenShift".
- [Debezium Operator](https://github.com/debezium/debezium-operator): Debezium Operator adds Change-Data-Capture capabilities to your Kubernetes or Openshift cluster by providing an easy way to run and manage [Debezium Server](https://debezium.io/documentation/reference/stable/operations/debezium-server.html) instances.
README.md:78
- This new entry has trailing whitespace and doesn’t include a short description (the section asks for a link plus a short description).
- [Apicurio Registry Operator](https://github.com/Apicurio/apicurio-registry/tree/main/operator)
README.md:79
- This new entry capitalizes "Operator" mid-sentence and doesn’t include a short description; also consider adding consistent punctuation.
- [Kaap](https://github.com/datastax/kaap) autoscaling Operator for Apache Pulsar
README.md:70
- The markdown hard line break (two trailing spaces) at the end of this list item appears unintentional and can introduce noisy whitespace-only diffs later.
- [kroxylicious](https://github.com/kroxylicious/kroxylicious/tree/main/kroxylicious-kubernetes/kroxylicious-operator) Kafka proxy operator
README.md:74
- These new entries don’t include a short description, but the section text asks contributors to add both a link and a short description.
This issue also appears in the following locations of the same file:
- line 78
- line 79
- [Apache Hive Kubernetes Operator](https://github.com/apache/hive/tree/master/packaging/src/kubernetes/src/java/org/apache/hive/kubernetes/operator)
- [OpenMetadata Operator](https://github.com/open-metadata/OpenMetadata/tree/main/openmetadata-k8s-operator) for AI context, data cataloging, and metadata management service
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (4)
README.md:70
- The trailing two spaces at the end of this list item force a Markdown hard line break; since this is a standalone bullet, the hard break is unnecessary and can render oddly depending on the Markdown viewer.
- [kroxylicious](https://github.com/kroxylicious/kroxylicious/tree/main/kroxylicious-kubernetes/kroxylicious-operator) Kafka proxy operator
README.md:71
- “Openshift” should be spelled “OpenShift”, and the extra double spaces in the sentence make the rendered Markdown look uneven.
- [Debezium Operator](https://github.com/debezium/debezium-operator): Debezium Operator adds Change-Data-Capture capabilities to your Kubernetes or OpenShift cluster by providing an easy way to run and manage [Debezium Server](https://debezium.io/documentation/reference/stable/operations/debezium-server.html) instances.
README.md:73
- This new entry is missing the short description that the section asks contributors to provide; adding a brief description keeps the list consistent and more useful to readers.
- [Apache Hive Kubernetes Operator](https://github.com/apache/hive/tree/master/packaging/src/kubernetes/src/java/org/apache/hive/kubernetes/operator)
README.md:78
- This new entry has trailing whitespace and is missing a short description, which makes it inconsistent with the format requested for this section.
- [Apicurio Registry Operator](https://github.com/Apicurio/apicurio-registry/tree/main/operator)
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (4)
README.md:78
- This entry has trailing whitespace and is missing the short description requested above (README.md:65-66). Adding a brief description (and trimming the trailing space) keeps the list consistent and readable.
- [Apicurio Registry Operator](https://github.com/Apicurio/apicurio-registry/tree/main/operator)
README.md:79
- “autoscaling Operator” has inconsistent capitalization within the sentence. Using lowercase “operator” here matches the surrounding prose style in this list.
- [Kaap](https://github.com/datastax/kaap) autoscaling Operator for Apache Pulsar
README.md:73
- This entry lacks the “short description” requested above (README.md:65-66). Please add a brief description after the link so readers know what the project is.
This issue also appears on line 78 of the same file.
- [Apache Hive Kubernetes Operator](https://github.com/apache/hive/tree/master/packaging/src/kubernetes/src/java/org/apache/hive/kubernetes/operator)
README.md:72
- Inconsistent capitalization: other list entries use “Operator” as part of the project name (e.g., “Apache Spark Kubernetes Operator”, “Debezium Operator”). Consider capitalizing it here as well, including in the description sentence.
This issue also appears on line 79 of the same file.
- [Keycloak operator](https://github.com/keycloak/keycloak/tree/main/operator): the official Keycloak operator, built with Quarkus and JOSDK.
Signed-off-by: Attila Mészáros <a_meszaros@apple.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros a_meszaros@apple.com