docs(configuration): add white labeling guide#441
Conversation
Add dedicated documentation page for configuring branding in Cozystack Dashboard and Keycloak authentication pages. Covers all available fields, SVG preparation, theme-aware variables, and migration notes from v0 ConfigMap approach. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
Remove misleading "colors" claim from description, add note explaining non-standard SVG template syntax, use portable base64 command, and fix migration link anchor. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
Use full CRD name packages.cozystack.io in kubectl commands for consistency with the rest of the documentation. Remove duplicated "Example SVG" heading. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
…se Hugo refs Package is a cluster-scoped resource, remove incorrect namespace field from the YAML example. Switch cross-references to Hugo ref shortcode for build-time validation. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
…bectl commands Use kubectl apply --server-side for idempotent application. Remove --namespace flag from kubectl commands since Package is a cluster-scoped resource. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates for white-labeling and branding configuration: the Platform Package reference was updated to cross-reference a new comprehensive white-labeling guide that covers Dashboard and Keycloak branding customization, SVG logo embedding, base64 encoding, configuration examples, and migration guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 introduces a new, comprehensive documentation guide for configuring white labeling within Cozystack v1. The guide aims to empower users to customize the branding elements across the Dashboard UI and Keycloak authentication pages, providing clear instructions on available configuration fields, SVG preparation, and migration considerations from previous versions. 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
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
The pull request introduces a comprehensive and well-structured white labeling guide, which is a valuable addition to the documentation. The new page clearly outlines the configuration steps for both the Dashboard and Keycloak, including practical examples for SVG preparation and patching the Platform Package. The update to platform-package.md correctly links to this new guide.
Note: Security Review has been skipped due to the limited scope of the PR.
| | --- | --- | --- | | ||
| | `titleText` | `Cozystack Dashboard` | Browser tab title and Dashboard header text. | | ||
| | `footerText` | `Cozystack` | Text displayed in the Dashboard footer. | | ||
| | `tenantText` | Platform version string | Version or tenant identifier displayed in the Dashboard. | |
There was a problem hiding this comment.
The default value for tenantText is described as "Platform version string". To enhance clarity, it would be beneficial to provide a more concrete example of what this string typically looks like (e.g., "v1.0.0" or "1.0") or explain how it's derived. This would help users understand what to expect if they don't explicitly set this field.
Add --server-side to kubectl patch for consistency, clarify SVG template syntax note, add variant comment to YAML example, and note individual field defaults in platform-package.md. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Aleksei Sviridkin <f@lex.la>
2 participants
Summary
Summary by CodeRabbit