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

fix: add description field to CSV base #366

Merged
merged 3 commits into from
Oct 5, 2023

Conversation

marioferh
Copy link
Contributor

Add description field to CSV base of every owned CRD to generate correct description when run bundle generate.

@marioferh marioferh requested a review from a team as a code owner September 28, 2023 09:13
@marioferh marioferh requested review from sthaha and slashpai and removed request for a team September 28, 2023 09:13
@@ -59,40 +59,68 @@ spec:
apiservicedefinitions: {}
customresourcedefinitions:
owned:
- kind: AlertmanagerConfig
- description: AlertmanagerConfig defines a namespaced AlertmanagerConfig to be

Choose a reason for hiding this comment

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

Did you take a look at the UI rendering? I think it should be shorter to fit into the box, like in Gabriel's example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is ok, thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

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

image

Copy link
Collaborator

Choose a reason for hiding this comment

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

You can use https://operatorhub.io/preview to preview the bundle/csv.yaml
I think we can improve the AlertmanagerConfig a bit .. (ask chatgpt :D )

Copy link
Collaborator

Choose a reason for hiding this comment

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

BTW, are we now supporting all these API?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In a cluster this is the result:
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"AlertmanagerConfig is used to define configurations for Prometheus Alertmanager, specifying how alerts are handled and routed for notifications."

Something like this?

Copy link
Collaborator

Choose a reason for hiding this comment

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

@simonpasquier would be the best judge of this :) .. BTW, for the record, this was only a suggestion and shouldn't block the PR from merging.

Copy link
Contributor

Choose a reason for hiding this comment

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

small suggestion compared to @marioferh

... specifying how alerts are grouped and notified to external systems.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@machine424
Copy link

The descriptions are not truncated and the boxes don't look text-heavy.

/lgtm

@openshift-ci openshift-ci bot added lgtm and removed lgtm labels Sep 28, 2023
@marioferh marioferh force-pushed the add_descrpition_field_to_CSV branch from 1506632 to df31425 Compare September 28, 2023 13:07
@marioferh marioferh force-pushed the add_descrpition_field_to_CSV branch from df31425 to 447fa95 Compare September 28, 2023 13:10
@machine424
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Sep 28, 2023
Signed-off-by: Mario Fernandez <[email protected]>
@openshift-ci openshift-ci bot removed the lgtm label Oct 4, 2023
@jan--f
Copy link
Collaborator

jan--f commented Oct 5, 2023

Thanks! I guess there is nothing but keeping these up-to-date manually is there?

@jan--f
Copy link
Collaborator

jan--f commented Oct 5, 2023

/lgtm

@jan--f
Copy link
Collaborator

jan--f commented Oct 5, 2023

/approve

@openshift-ci
Copy link

openshift-ci bot commented Oct 5, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jan--f, marioferh

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-ci openshift-ci bot added the approved label Oct 5, 2023
@openshift-ci openshift-ci bot merged commit 22bb08b into rhobs:main Oct 5, 2023
7 checks passed
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.

5 participants