Skip to content

TELCODOCS#2148: Usability improvements in cluster-compare plugin #91033

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

TELCODOCS#2148: Usability improvements in cluster-compare plugin #91033

wants to merge 1 commit into from

Conversation

sr1kar99
Copy link
Contributor

@sr1kar99 sr1kar99 commented Mar 25, 2025 •
edited
Loading

Version(s):
4.19

Issue:
TELCODOCS-2148

Link to docs preview:

QE review:

  • QE has approved this change.

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 25, 2025
@sr1kar99
Copy link
Contributor Author

@lack
Could you please review this PR?
Thanks!

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Mar 25, 2025 •
edited
Loading

🤖 Wed May 14 18:17:24 - Prow CI generated the docs preview:

https://91033--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/cluster-compare/creating-a-reference-configuration.html
https://91033--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/cluster-compare/using-the-cluster-compare-plugin.html

lack
lack reviewed Mar 26, 2025
View reviewed changes
Copy link
Member

@lack lack left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 26, 2025
@sr1kar99 sr1kar99 force-pushed the 2148-usability-improvs branch from 3ec8b17 to b36e460 Compare April 28, 2025 09:55
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 28, 2025
@sr1kar99 sr1kar99 force-pushed the 2148-usability-improvs branch from b36e460 to 5379cca Compare April 28, 2025 10:07
@lack
Copy link
Member

lack commented May 1, 2025

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 1, 2025
@sr1kar99
Copy link
Contributor Author

sr1kar99 commented May 5, 2025

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label May 5, 2025
@xenolinux xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels May 6, 2025
@xenolinux xenolinux added this to the Planned for 4.19 GA milestone May 6, 2025
xenolinux
xenolinux reviewed May 6, 2025
View reviewed changes
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

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

2 minor comments; LGTM

@xenolinux xenolinux added peer-review-done Signifies that the peer review team has reviewed this PR branch/enterprise-4.19 and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels May 6, 2025
@sr1kar99 sr1kar99 force-pushed the 2148-usability-improvs branch from 5379cca to b6939a3 Compare May 8, 2025 06:48
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label May 8, 2025
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented May 8, 2025

New changes are detected. LGTM label has been removed.

@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 8, 2025
@sr1kar99 sr1kar99 force-pushed the 2148-usability-improvs branch from b6939a3 to 5842ef2 Compare May 8, 2025 06:51
@sr1kar99 sr1kar99 force-pushed the 2148-usability-improvs branch 2 times, most recently from 6561625 to 3095932 Compare May 9, 2025 21:21
lack
lack suggested changes May 12, 2025
View reviewed changes
modules/cluster-compare-templating-reference.adoc
|`toYaml`
|Renders incoming data as YAML while preserving object types.

|`doNotMatch`
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we should have an example like we do for lookupCRs so that the syntax is clear and we've got similar format for all three of these custom functions?

Example: {{ if $condition }}{{ doNotMatch $reason }}{{ end }}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes! That works too!
For now I have added the above example that you have shared!
If there is an example similar to lookupCR, could you please here? @lack

@sr1kar99 sr1kar99 force-pushed the 2148-usability-improvs branch from 3095932 to e4b8e50 Compare May 14, 2025 18:11
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented May 14, 2025

@sr1kar99: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@dgonyier
Copy link

/lgtm

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented May 14, 2025

@dgonyier: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@sr1kar99
Copy link
Contributor Author

Requesting another round of peer review because of some updates!

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label May 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xenolinux xenolinux xenolinux left review comments

@lack lack lack requested changes

Assignees

@lack lack

Labels
branch/enterprise-4.19 peer-review-done Signifies that the peer review team has reviewed this PR peer-review-needed Signifies that the peer review team needs to review this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
Planned for 4.19 GA
Development

Successfully merging this pull request may close these issues.
5 participants
@sr1kar99 @ocpdocs-previewbot @lack @dgonyier @xenolinux