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 typos in ClusterServiceVersion description #320

Merged

Conversation

grdryn
Copy link
Contributor

@grdryn grdryn commented Nov 28, 2023


Summary

Some minor typo fixes in the description that gets displayed in places
like the operator hub.

Related issue(s)

Fixes #

@openshift-ci openshift-ci bot requested review from deads2k and jnpacker November 28, 2023 00:45

## Prerequisites
You need a Hub cluster which has installed ClusterManager.
You need a Hub cluster with ClusterManager installed.

## How to Install
* Install Klusterlet operator by following instructions in top right button `Install`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

At least in the OperatorHub in OpenShift 4.14, the "Install" button doesn't appear to be in the top right. I'm not sure if it is in other environments. If so, maybe this could/should be a little more accommodating of potential UI changes?

Copy link
Member

Choose a reason for hiding this comment

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

I think the install button is displayed on the https://operatorhub.io/operator/klusterlet page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah right, I didn't think of that page.

This text also appears in the in-cluster OperatorHub in OpenShift, where the "Install" button tends to be further left than the text, so I think my point about not being too specific to one particular UI may still be relevant? I don't intend to make any changes around that in this PR, just highlighting it in case it could be improved.

image

@qiujian16
Copy link
Member

/assign @zhiweiyin318

Copy link

codecov bot commented Nov 28, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.47%. Comparing base (7a8e444) to head (9bcf9f8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #320   +/-   ##
=======================================
  Coverage   62.47%   62.47%           
=======================================
  Files         178      178           
  Lines       13968    13968           
=======================================
  Hits         8726     8726           
  Misses       4358     4358           
  Partials      884      884           
Flag Coverage Δ
unit 62.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zhiweiyin318
Copy link
Member

Thanks for the contribution.
we need add -s when git commit to pass the DCO check.
could you run make update-csv locally which is to update the klusterlet csv file ?

Copy link

This pull request is stale because it has been open for 120 days with no activity. After 14 days of inactivity, it will be closed. Remove the stable label to prevent this issue from being closed.

Signed-off-by: Gerard Ryan <git@grdryn.xyz>
@grdryn
Copy link
Contributor Author

grdryn commented Jul 14, 2024

we need add -s when git commit to pass the DCO check.
could you run make update-csv locally which is to update the klusterlet csv file ?

@zhiweiyin318 sorry, I completely missed this at the time. I just noticed it now when I got a notification that this needed rebasing (you addressed some of these typos in #548, so this commit conflicted).

I've rebased and signed-off the commit and run make update-csv as requested. Let me know if there's anything else I need to do here. Thanks!

@qiujian16
Copy link
Member

/approve
/lgtm

Copy link
Contributor

openshift-ci bot commented Jul 15, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: grdryn, qiujian16

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-bot openshift-merge-bot bot merged commit 110a804 into open-cluster-management-io:main Jul 15, 2024
15 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.

4 participants