Skip to content
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

Conversation

matzew
Copy link
Member

@matzew matzew commented Sep 7, 2023

Fixes SRVCOM-2668

Proposed Changes

  • offers more meaningful description of our provided APIs

@ReToCode
Copy link
Member

ReToCode commented Sep 7, 2023

I like it 🎉
/cc @rhuss

@openshift-ci openshift-ci bot requested a review from rhuss September 7, 2023 07:00
@matzew matzew changed the title WIP: better proposed apis desc WIP: Better proposed APIs desc Sep 7, 2023
@matzew matzew force-pushed the SRVCOM-2668_wip_better_proposed_apis_desc branch from a76f022 to d3ee6b6 Compare September 7, 2023 09:55
@Preeticp
Copy link

Preeticp commented Sep 7, 2023

LGTM

Copy link
Member

@Cali0707 Cali0707 left a 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

templates/csv.yaml Outdated Show resolved Hide resolved
@matzew
Copy link
Member Author

matzew commented Sep 8, 2023

I think the text for Serving is a bit long here. I think I tend to have a more crisp description, as smaller text is easier to parse/read... 🤷‍♂️

Screenshot from 2023-09-08 08-19-12

@matzew matzew changed the title WIP: Better proposed APIs desc Better proposed APIs desc Sep 11, 2023
@matzew
Copy link
Member Author

matzew commented Sep 11, 2023

Screenshot from 2023-09-11 09-42-53

Latest updates ^

@ReToCode
Copy link
Member

LGTM

templates/csv.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
Copy link
Member

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?

Suggested change
- 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.

Copy link
Member Author

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

@matzew
Copy link
Member Author

matzew commented Sep 11, 2023

Screenshot from 2023-09-11 12-37-08

This is the current ^

@pierDipi
Copy link
Member

LGTM

2 similar comments
@Cali0707
Copy link
Member

LGTM

@Preeticp
Copy link

LGTM

@rhuss
Copy link
Contributor

rhuss commented Sep 11, 2023

I would shorten the Serving description to:

Knative Serving simplifies application deployment, enables scaling from and to zero replicas, and enables advanced traffic routing use-cases.

  • There is no such thing like a "severless container"
  • Be explicit what to scale

@rhuss
Copy link
Contributor

rhuss commented Sep 11, 2023

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:

  • Knative Serving: A platform for streamlined app deployment, traffic-based auto-scaling from zero to N, and traffic-split rollouts.
  • Knative Eventing: An OpenShift-native EDA runtime platform that leverages Cloud Events with a simple HTTP interface.
  • Knative Kafka: An extension to Knative Eventing, merging HTTP accessibility with Apache Kafka's proven efficiency and reliability.

I believe these very condensed and concise descriptions highlight the core features. Is there anything missing?

@matzew matzew force-pushed the SRVCOM-2668_wip_better_proposed_apis_desc branch from 3e5db25 to a9c6298 Compare September 12, 2023 13:31
@matzew
Copy link
Member Author

matzew commented Sep 12, 2023

Latest proposal....

Screenshot from 2023-09-12 16-34-47

Signed-off-by: Matthias Wessendorf <[email protected]>
@matzew matzew force-pushed the SRVCOM-2668_wip_better_proposed_apis_desc branch from a9c6298 to 0c549ae Compare September 12, 2023 16:16
Copy link
Contributor

@rhuss rhuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

thanks!

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 12, 2023

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 0a81e8c into openshift-knative:main Sep 12, 2023
3 checks passed
@nainaz
Copy link

nainaz commented Sep 13, 2023

Love It!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants