OSDOCS-16406: Suggested CLI changes to comply with product documentation#3345
OSDOCS-16406: Suggested CLI changes to comply with product documentation#3345EricPonvelle wants to merge 1 commit into
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@EricPonvelle: This pull request references OSDOCS-16406 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 story to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
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. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Central YAML (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (24)
✅ Files skipped from review due to trivial changes (24)
📝 WalkthroughWalkthroughThis pull request updates Cobra command help text across create, delete, unlink, list, link, and verify commands. Several create commands now spell out DNS, OIDC, IAM, and identity provider terms, and 🚥 Pre-merge checks | ✅ 14 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (14 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: EricPonvelle The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cmd/create/idp/cmd.go`:
- Around line 92-93: Tighten the help text in the command definition by updating
the `Short` and `Long` descriptions to use clearer wording: change the phrase in
the `cmd/create/idp/cmd.go` command metadata so it reads naturally as “Add
identity provider (IDP) for a cluster” and rephrase the longer description to
avoid “identity providers” in the awkward plural form. Keep the fix confined to
the `Short` and `Long` fields in the `createIDPCmd` command setup.
In `@cmd/create/oidcconfig/cmd.go`:
- Around line 57-58: Update the user-facing long description in the OIDC config
command metadata so the help text uses “an S3 bucket” instead of “a S3 bucket.”
Make this change in the command definition where the OpenID Connect config
description is built, keeping the rest of the wording unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 92ddc5da-4fd9-4965-a78c-1522ad0a5e4d
📒 Files selected for processing (5)
cmd/create/dnsdomains/cmd.gocmd/create/idp/cmd.gocmd/create/ocmrole/cmd.gocmd/create/oidcconfig/cmd.gocmd/create/oidcprovider/cmd.go
EricPonvelle
force-pushed
the
OSDOCS-16406_rosa-updates
branch
from
db3f59a to
0efd712
Compare
bhardesty
left a comment
bhardesty
left a comment
There was a problem hiding this comment.
Just noticed one small spacing issue.
EricPonvelle
force-pushed
the
OSDOCS-16406_rosa-updates
branch
from
0efd712 to
ab7f08f
Compare
EricPonvelle
force-pushed
the
OSDOCS-16406_rosa-updates
branch
from
ab7f08f to
68ad034
Compare
|
@EricPonvelle: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
3 participants
This PR addresses:
Detailed Description of the Issue
This PR addresses some language issues that were not in compliance with product documentation standards. Since we generate our CLI documentation from this repo, the updates had to be done here. To that end, I have changed the descriptions on a few ROSA commands so that they have the full names rather than acronyms.
Type of Change
Developer Verification Checklist
[JIRA-TICKET] | [TYPE]: <MESSAGE>.make install-hookshas been run in this clone.make testpasses.make lintpasses.make rosapasses.Summary by CodeRabbit
create,delete,list,link,unlink, andverify) with clearer descriptions and standardized capitalization.