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.

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

NO-JIRA: README updates #78

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

NO-JIRA: README updates #78

wants to merge 2 commits into from

Conversation

spadgett
Copy link
Member

  • Explain release-* branches
  • Add links to more plugin samples and real plugins

@spadgett
README updates
3404ba8 
- Explain release-* branches
- Add links to more plugin samples and real plugins
@openshift-ci openshift-ci bot requested review from florkbr and TheRealJon February 26, 2025 14:26
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Feb 26, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: spadgett

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 Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 26, 2025
@spadgett spadgett changed the title NO_JIRA: README updates NO-JIRA: README updates Feb 26, 2025
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 26, 2025
@openshift-ci-robot
Copy link

@spadgett: This pull request explicitly references no jira issue.

In response to this:

  • Explain release-* branches
  • Add links to more plugin samples and real plugins

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 openshift-eng/jira-lifecycle-plugin repository.

@spadgett spadgett removed the request for review from florkbr February 26, 2025 14:27
@spadgett
Copy link
Member Author

/cc @jhadvig @vojtechszocs

@spadgett
Copy link
Member Author

/retest

rhamilto
rhamilto reviewed Mar 3, 2025
View reviewed changes
@spadgett @rhamilto
Update README.md
c573f9f 
Co-authored-by: Robb Hamilton <[email protected]>
@spadgett
Copy link
Member Author

spadgett commented Mar 3, 2025

/label tide-merge-method-squash

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Mar 3, 2025

@spadgett: The label(s) /label tide-merge-method-squash cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, ux-approved, no-qe, downstream-change-needed, rebase/manual, cluster-config-api-changed, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, jira/valid-bug, staff-eng-approved. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/label tide-merge-method-squash

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.

@rhamilto
Copy link
Member

rhamilto commented Mar 3, 2025

/lgtm

@rhamilto
Copy link
Member

rhamilto commented Mar 3, 2025

/label tide/merge-method-squash

@openshift-ci openshift-ci bot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Mar 3, 2025
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 3, 2025
@spadgett
Copy link
Member Author

spadgett commented Mar 4, 2025

/retest

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Mar 4, 2025

@spadgett: 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.

@spadgett
Copy link
Member Author

spadgett commented Mar 4, 2025

README-only changes, which shouldn't require px or qe approval. @opayne1 Can you give docs-approved?

/label px-approved
/label qe-approved

@openshift-ci openshift-ci bot added px-approved Signifies that Product Support has signed off on this PR qe-approved Signifies that QE has signed off on this PR labels Mar 4, 2025
opayne1
opayne1 reviewed Mar 5, 2025
View reviewed changes
Copy link

@opayne1 opayne1 left a comment

Choose a reason for hiding this comment

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

Hey Sam! Just a few small suggestions. Let me know if you have thoughts/questions. Also, I am thinking I need to add this to the product docs? Maybe where the general information is? Thanks!

README.md

For an example of a plugin that works with OpenShift 4.11, see the `release-4.11` branch.
For a plugin that works with OpenShift 4.10, see the `release-4.10` branch.
This repository contains branches for older OpenShift releases. If you're
Copy link

Choose a reason for hiding this comment

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

Suggested change
This repository contains branches for older OpenShift releases. If you're
This repository contains branches for older OpenShift releases. If you are

README.md
For an example of a plugin that works with OpenShift 4.11, see the `release-4.11` branch.
For a plugin that works with OpenShift 4.10, see the `release-4.10` branch.
This repository contains branches for older OpenShift releases. If you're
writing a plugin that should be backwards compatible with older release, you
Copy link

Choose a reason for hiding this comment

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

Suggested change
writing a plugin that should be backwards compatible with older release, you
writing a plugin that is backwards compatible with older releases, you

README.md
For a plugin that works with OpenShift 4.10, see the `release-4.10` branch.
This repository contains branches for older OpenShift releases. If you're
writing a plugin that should be backwards compatible with older release, you
should base your plugin on those branches. The branch names follow pattern
Copy link

Choose a reason for hiding this comment

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

Suggested change
should base your plugin on those branches. The branch names follow pattern
must base your plugin on those branches. The branch names follow pattern

README.md
- [Console Plugin SDK README](https://github.com/openshift/console/tree/master/frontend/packages/console-dynamic-plugin-sdk)
- [Customization Plugin Example](https://github.com/spadgett/console-customization-plugin)
- [Dynamic Plugin Enhancement Proposal](https://github.com/openshift/enhancements/blob/master/enhancements/console/dynamic-plugins.md)
To learn more, have a look at the SDK documentation, a few sample plugins, and
Copy link

Choose a reason for hiding this comment

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

Suggested change
To learn more, have a look at the SDK documentation, a few sample plugins, and
To learn more, have a look at the SDK documentation, a few sample plugins, and

I am wondering if it might just be better to say something like "To learn more, refer to the following links" or "For more information, see the plugin documentation, sample plugins, and the source code for a few active plugins." to be more consistent with the product documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhamilto rhamilto rhamilto left review comments

@opayne1 opayne1 opayne1 left review comments

@TheRealJon TheRealJon Awaiting requested review from TheRealJon

@jhadvig jhadvig Awaiting requested review from jhadvig

@vojtechszocs vojtechszocs Awaiting requested review from vojtechszocs

Assignees

@rhamilto rhamilto

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. px-approved Signifies that Product Support has signed off on this PR qe-approved Signifies that QE has signed off on this PR tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@spadgett @openshift-ci-robot @rhamilto @opayne1