Skip to content

Conversation

@bergerhoffer
Copy link
Contributor

…act/short description

https://issues.redhat.com/browse/OSDOCS-18071

OCP docs is moving to a new docs tooling system. This update is a requirement to migrate to the new system.

@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

Walkthrough

This PR adds documentation metadata blocks to two template files. Each receives a new [role="_abstract"] section containing high-level descriptions of CLI commands, positioned before the template iteration sections. No functional logic changes are introduced.

Changes

Cohort / File(s) Summary
Documentation Metadata Augmentation
hack/clibyexample/template, hack/clibyexample/template-admin
Adds identical [role="_abstract"] block (+3 lines each) with command descriptions. Both blocks inserted before {{range .items}} sections for template documentation purposes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes


Comment @coderabbitai help to get the list of available commands and usage tips.

@bergerhoffer
Copy link
Contributor Author

CC @ardaguclu if you can help review/approve this update. Let me know if you have any questions, thanks!

@ardaguclu
Copy link
Member

/lgtm
/approve
/hold
feel free to unhold anytime you want to merge this PR

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 28, 2026
@bergerhoffer
Copy link
Contributor Author

bergerhoffer commented Jan 28, 2026

Thanks! I'm good with it merging whenever. I just need it in for 4.22.

/unhold

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 28, 2026
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 28, 2026
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 28, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ardaguclu, bergerhoffer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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 Jan 28, 2026
@ardaguclu
Copy link
Member

ardaguclu commented Jan 28, 2026

/retitle OSDOCS-18071: Updating CLI docs templates to include a required abstract/short description

@openshift-ci openshift-ci bot changed the title OSDOCS#18071: Updating CLI docs templates to include a required abstr… OSDOCS-18071: Updating CLI docs templates to include a required abstract/short description Jan 28, 2026
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 28, 2026
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 28, 2026

@bergerhoffer: This pull request references OSDOCS-18071 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

…act/short description

https://issues.redhat.com/browse/OSDOCS-18071

OCP docs is moving to a new docs tooling system. This update is a requirement to migrate to the new system.

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.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 28, 2026

@bergerhoffer: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

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

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants