-
Notifications
You must be signed in to change notification settings - Fork 14
Add some more example prompts #154
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
base: master
Are you sure you want to change the base?
Add some more example prompts #154
Conversation
Adds prompts for setting the platform, analyzing logs, and configuring static networking.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: carbonin 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 |
WalkthroughDocumentation expansion adding example prompts for cluster management operations (platform configuration, log analysis) and NMState-based network configuration workflows to guide users through various infrastructure management tasks. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested labels
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
doc/example_prompts.md(1 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). (1)
- GitHub Check: Red Hat Konflux / assisted-service-mcp-saas-main-on-pull-request
🔇 Additional comments (2)
doc/example_prompts.md (2)
70-82: LGTM!The new
set_cluster_platformandanalyze_cluster_logssections follow the established format and provide clear, actionable example prompts. Good additions to the cluster management documentation.
84-113: Well-structured new Network Configuration section.The new section is well-organized with clear descriptions and actionable examples for NMState-based network management workflows. All subsections follow the documentation style consistently. Once line 104 is corrected, this section will be ready.
|
|
||
| **Example Prompts:** | ||
| - "Add a new static network configuration for a host in my-cluster" | ||
| - "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24 |
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.
Fix unclosed string in example prompt.
Line 104 is missing a closing double quote, which breaks the markdown formatting of this bullet point.
Apply this diff to fix the syntax error:
-- "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24
+- "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24"📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24 | |
| - "Update the network config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR length 24" |
🤖 Prompt for AI Agents
In doc/example_prompts.md around line 104, the example prompt string is missing
its closing double quote which breaks the markdown; add the missing closing
double quote at the end of the line so the bullet reads: "Update the network
config for mac address c5:d6:bc:f0:05:20 to set ip address 10.0.0.5 with CIDR
length 24"
Adds prompts for setting the platform, analyzing logs, and configuring static networking.
cc @lalon4
Summary by CodeRabbit