fix(docs): correct component values override instructions#436
Conversation
The previous instructions incorrectly showed overriding component values through the Platform Package. The correct approach is to modify the specific Package resource directly (e.g. cozystack.metallb) and specify values in its spec.components section. Updated the example to show enabling FRR-K8s mode for MetalLB and added a link to the system chart values in the Cozystack repository. Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation update clarifying how to override component parameters by modifying the corresponding Package resource. Examples revised to reference MetalLB-specific configuration instead of the platform package, with added guidance on enabling/disabling components via bundles. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
✨ 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 |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the accuracy of the documentation for Cozystack, specifically addressing how users should override component parameters. It clarifies that modifications should target individual Package resources directly, rather than the overarching Platform Package, and provides a practical example to guide users through the correct configuration process. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for overriding component parameters. The instructions have been corrected to show that overrides should be applied to the specific component's Package resource, not the main Platform Package. The example has also been updated to be more focused and now demonstrates enabling FRR-K8s for MetalLB. The changes improve the clarity and correctness of the documentation. I have one suggestion to make a link in the documentation less ambiguous.
| in the `spec.components` section. The values structure follows the | ||
| [values.yaml](https://github.com/cozystack/cozystack/tree/main/packages/system) | ||
| of the respective system chart in the Cozystack repository. |
There was a problem hiding this comment.
The link on line 15 is slightly misleading as the link text values.yaml suggests a file, but the URL points to a directory. This could be confusing for users. Consider rephrasing to improve clarity.
| in the `spec.components` section. The values structure follows the | |
| [values.yaml](https://github.com/cozystack/cozystack/tree/main/packages/system) | |
| of the respective system chart in the Cozystack repository. | |
| in the `spec.components` section. The values structure follows the `values.yaml` | |
| of the respective system chart, which can be found in the repository's | |
| [system packages directory](https://github.com/cozystack/cozystack/tree/main/packages/system). |
1 participant
What this PR does
Fixes the "Overwriting Component Parameters" section in the components
reference. The previous instructions incorrectly showed overriding
component values through the Platform Package. The correct approach is
to modify the specific Package resource directly (e.g.
cozystack.metallb)and specify values in its
spec.componentssection.The values structure follows the
values.yamlof the respective systemchart in the Cozystack repository.
Updated the example to show enabling FRR-K8s mode for MetalLB with a
link to the system chart values.
Summary by CodeRabbit