-
Notifications
You must be signed in to change notification settings - Fork 69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Better proposed APIs desc #2266
Better proposed APIs desc #2266
Conversation
I like it 🎉 |
a76f022
to
d3ee6b6
Compare
LGTM |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@matzew feel free to ignore if you disagree, just my 2 cents on the wording of the Kafka bits
olm-catalog/serverless-operator/manifests/serverless-operator.clusterserviceversion.yaml
Outdated
Show resolved
Hide resolved
LGTM |
olm-catalog/serverless-operator/manifests/serverless-operator.clusterserviceversion.yaml
Outdated
Show resolved
Hide resolved
@@ -214,7 +214,7 @@ spec: | |||
displayName: Version | |||
path: version | |||
version: v1beta1 | |||
- description: Represents an installation of a particular version of Knative Kafka components | |||
- description: Additionl extensions based on Apache Kafka for production-ready Knative Eventing deployments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what do you think about this instead?
- description: Additionl extensions based on Apache Kafka for production-ready Knative Eventing deployments | |
- description: Knative Kafka is the Knative Eventing extensions for Apache Kafka. It allows to trigger services based on Apache Kafka topics and create your event-driven applications with a simple HTTP interface with the the underlying reliability and efficiency of Apache Kafka. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's quite a mouthful. How about:
Knative Kafka is the Knative Eventing extensions for Apache Kafka. Create event-driven applications with a simple HTTP interface while leveraging the underlying reliability and efficiency of Apache Kafka
LGTM |
2 similar comments
LGTM |
LGTM |
I would shorten the Serving description to:
|
Some thoughts on the descriptions to make them more concise and aligned in the format (e.g. the Knative Kafka description is not in the same style as the others:
I believe these very condensed and concise descriptions highlight the core features. Is there anything missing? |
3e5db25
to
a9c6298
Compare
Signed-off-by: Matthias Wessendorf <[email protected]>
a9c6298
to
0c549ae
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
thanks!
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: matzew, rhuss The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
0a81e8c
into
openshift-knative:main
Love It! |
Fixes SRVCOM-2668
Proposed Changes