-
Notifications
You must be signed in to change notification settings - Fork 48
adds avaiable language for app generate #1426
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.
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
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis change updates the AsciiDoc documentation for the Estimated code review effort🎯 2 (Simple) | ⏱️ ~5–10 minutes
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc (3)
19-19: Improve phrasing for clarity.The sentence fragment "Available language:
go." reads awkwardly after "There is no default." Consider rephrasing to flow more naturally within the full sentence.-The `--language` flag lets you specify the language. There is no default. Available language: `go`. +The `--language` flag lets you specify the language; currently, only `go` is supported. There is no default.Alternatively:
-The `--language` flag lets you specify the language. There is no default. Available language: `go`. +The `--language` flag lets you specify the language. Currently, only `go` is supported.
75-76: Improve phrasing for clarity in flags description.The description trailing into "Available language:
go." reads awkwardly. Consider integrating the language constraint more naturally into the sentence.|-l, --language |string |The language you want the code sample to be -generated with. Available language: `go`. +generated with (currently only `go` is supported).
21-21: Pre-existing flag name inconsistency (outside scope of this PR).Unrelated to your changes, but worth noting for a future follow-up: Line 21 references
--new-sasl--user(appears to be a typo with double dash), the examples on line 50 show--new-sasl-user, but the flags table defines the actual flag as--new-sasl-credentialson line 78. These should be reconciled to avoid user confusion.Also applies to: 78-78
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc (1)
32-58: Verify example blocks in AI summary.The AI-generated summary mentions "Added user-facing example blocks demonstrating various ways to generate an app," but these lines are not marked with
~in the annotated code. Please confirm whether these examples were pre-existing or are part of this PR. If they were newly added, they should be marked as changed in the annotation.
|
I also updated this here in redpanda-data/cloud-docs#432 |
kbatuigas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only thing to note is for future-proofing, it would be better to say "Available languages:" even if the list currently only contains one item. But not sure how soon we'll see more options on this list. I'll approve but feel free to change it to "languages" if you like.
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1777
Review deadline:
Page previews
Checks