api icon indicating copy to clipboard operation
api copied to clipboard

image/v1/types: improve documentation

Open Frankkkkk opened this issue 11 months ago • 6 comments

Hi, Just a really small MR (my first here :) ) to improve some documentation wording.

Thanks!

Frankkkkk avatar Mar 18 '25 14:03 Frankkkkk

Hello @Frankkkkk! Some important instructions when contributing to openshift/api: API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

openshift-ci[bot] avatar Mar 18 '25 14:03 openshift-ci[bot]

Hi @Frankkkkk. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

openshift-ci[bot] avatar Mar 18 '25 14:03 openshift-ci[bot]

/lgtm cancel

The documentation changes look fine, but you'll need to regenerate the generated contents with make update

everettraven avatar Mar 18 '25 21:03 everettraven

Sorry for the overlook @everettraven , it's fixed. Thanks!

Frankkkkk avatar Mar 18 '25 22:03 Frankkkkk

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

openshift-ci[bot] avatar Mar 19 '25 13:03 openshift-ci[bot]

/approve

JoelSpeed avatar Apr 11 '25 13:04 JoelSpeed

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: everettraven, Frankkkkk, JoelSpeed

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[bot] avatar Apr 11 '25 13:04 openshift-ci[bot]

[ART PR BUILD NOTIFIER]

Distgit: ose-cluster-config-api This PR has been included in build ose-cluster-config-api-container-v4.19.0-202504111744.p0.g10a8fa5.assembly.stream.el9. All builds following this will include this PR.

openshift-bot avatar Apr 11 '25 18:04 openshift-bot