Migrate console documentation to docs repository (Issue #3692)Move console documentation from kubestellar repo to docs repository (…#1207
Conversation
|
Thanks for your pull request. Before we can look at it, you'll need to add a 'DCO signoff' to your commits. 📝 Please follow instructions in the contributing guide to update your commits with the DCO Full details of the Developer Certificate of Origin can be found at developercertificate.org. The list of commits missing DCO signoff:
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. |
❌ Deploy Preview for kubestellar-docs failed. Why did it fail? →Built without sensitive environment variables
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
|
Welcome to KubeStellar! 🚀 Thank you for submitting this Pull Request. Before your PR can be merged, please ensure: ✅ DCO Sign-off - All commits must be signed off with ✅ PR Title - Must start with an emoji: ✨ (feature), 🐛 (bug fix), 📖 (docs), 🌱 (infra/tests), Getting Started with KubeStellar: Contributor Resources:
🌟 Help KubeStellar Grow - We Need Adopters! Our roadmap is driven entirely by adopter feedback. Whether you're using KubeStellar yourself or know someone who could benefit from multi-cluster Kubernetes: 📋 Take our Multi-Cluster Survey - Share your use cases and help shape our direction! A maintainer will review your PR soon. Feel free to ask questions in the comments or on Slack! |
|
Hi @nehanataraj. Thanks for your PR. I'm waiting for a kubestellar member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
|
Hi! I have opened a PR migrating the console documentation to the docs Please let me know if any restructuring or link adjustments are needed. |
There was a problem hiding this comment.
Pull request overview
This PR aims to migrate KubeStellar Console documentation into this docs repository (per Issue #3692) by adding a set of Console markdown pages and related images.
Changes:
- Added new Console documentation pages under
content/console/ - Added a corresponding
content/console/images/asset folder - Introduced “Klaude Console” variants of overview/features/cards/rewards/updates pages
Reviewed changes
Copilot reviewed 5 out of 18 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| content/console/klaude-console-overview.md | Adds a Console overview page and links to related pages/assets |
| content/console/klaude-console-features.md | Adds a feature walkthrough with screenshots |
| content/console/klaude-console-cards.md | Adds a dashboard card reference catalog |
| content/console/klaude-console-rewards.md | Adds rewards-system documentation |
| content/console/klaude-console-updates.md | Adds release channel + updates documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| The KubeStellar Klaude Console is a modern, AI-powered multi-cluster management interface that provides real-time monitoring, intelligent insights, and a customizable dashboard experience for managing Kubernetes clusters at scale. | ||
|
|
||
|  |
There was a problem hiding this comment.
These docs are being added under content/console, but the site’s docs loader/navigation and the /docs-images image handler are wired to docs/content/** (see src/app/docs/page-map.ts and src/app/api/docs-image/[...path]/route.ts). As a result, these pages won’t appear in the Console docs section and their images/... references will 404. Move this content (and images) under docs/content/console/ (or update the loader to include content/console), and avoid duplicating the existing Console pages already present in docs/content/console.
|  | |
|  |
| 1. **KKC Agent**: A local agent that connects to your kubeconfig | ||
| 2. **Backend API**: The KKC API server running on port 8080 | ||
|
|
||
| See the [setup guide](README.md) for detailed installation instructions. | ||
|
|
||
| ## Architecture | ||
|
|
||
| The Klaude Console consists of: | ||
|
|
||
| - **Frontend**: React + TypeScript + Vite application | ||
| - **KKC Agent**: Go-based agent that interfaces with Kubernetes clusters |
There was a problem hiding this comment.
The link to README.md won’t resolve correctly in this docs site (and will likely be a 404 route). Also, within this repo’s existing Console docs the agent/API naming is consistently KSC (e.g. docs/content/console/console-overview.md), so KKC here appears inconsistent/outdated. Consider linking to the local installation/setup docs (e.g. installation.md / readme.md) or an explicit URL to the console repo README, and align the component names with the canonical Console docs.
| 1. **KKC Agent**: A local agent that connects to your kubeconfig | |
| 2. **Backend API**: The KKC API server running on port 8080 | |
| See the [setup guide](README.md) for detailed installation instructions. | |
| ## Architecture | |
| The Klaude Console consists of: | |
| - **Frontend**: React + TypeScript + Vite application | |
| - **KKC Agent**: Go-based agent that interfaces with Kubernetes clusters | |
| 1. **KSC Agent**: A local agent that connects to your kubeconfig | |
| 2. **Backend API**: The KSC API server running on port 8080 | |
| See the [setup guide](https://github.com/kubestellar/console/blob/main/README.md) for detailed installation instructions. | |
| ## Architecture | |
| The Klaude Console consists of: | |
| - **Frontend**: React + TypeScript + Vite application | |
| - **KSC Agent**: Go-based agent that interfaces with Kubernetes clusters |
|
|
||
| For update-related issues: | ||
|
|
||
| - Check the [troubleshooting guide](README.md#troubleshooting) |
There was a problem hiding this comment.
README.md#troubleshooting is not a page in this docs site, so this link will render as a broken relative URL. Link to an existing docs page (e.g. the Console docs readme.md) or use a fully qualified URL to the troubleshooting section in the console repository README.
| - Check the [troubleshooting guide](README.md#troubleshooting) | |
| - Check the [troubleshooting guide](https://github.com/kubestellar/console/blob/main/README.md#troubleshooting) |
| # Updates and Releases | ||
|
|
||
| The KubeStellar Klaude Console follows a regular release schedule with two update channels. |
There was a problem hiding this comment.
PR description says the console docs are migrated into the docs repository under docs/content/console, but these additions land in content/console instead. Unless the site is updated to read from content/console, this doesn’t achieve the migration goal and leaves the canonical docs/content/console section unchanged.
clubanderson
left a comment
There was a problem hiding this comment.
1195 🐛 Fix: related projects hover appears dark in light mode btwshivam
📌 Related Issue
Resolves kubestellar/kubestellar#3692
📝 Summary of Changes
This PR migrates the console documentation from the
kubestellar/kubestellarrepository (
docs/content/console) to thekubestellar/docsrepository,as requested in Issue #3692.
Changes Made
content/console)imagesfolder for documentation assetsChecklist
👀 Reviewer Notes
This is my first contribution and I am also applying to the IFOS program.
Please let me know if the documentation should be reorganized into a different
structure within the docs repository or if any link adjustments are preferred.