Skip to content

Comments

Migrate console documentation to docs repository (Issue #3692)Move console documentation from kubestellar repo to docs repository (…#1207

Open
nehanataraj wants to merge 1 commit intokubestellar:mainfrom
nehanataraj:move-console-docs
Open

Migrate console documentation to docs repository (Issue #3692)Move console documentation from kubestellar repo to docs repository (…#1207
nehanataraj wants to merge 1 commit intokubestellar:mainfrom
nehanataraj:move-console-docs

Conversation

@nehanataraj
Copy link

📌 Related Issue

Resolves kubestellar/kubestellar#3692


📝 Summary of Changes

This PR migrates the console documentation from the kubestellar/kubestellar
repository (docs/content/console) to the kubestellar/docs repository,
as requested in Issue #3692.


Changes Made

  • Migrated all console documentation markdown files
  • Preserved directory structure (content/console)
  • Included associated images folder for documentation assets
  • Ensured files are intact and readable in the docs repository

Checklist

  • I have reviewed the project's contribution guidelines.
  • I have updated the documentation (if applicable).
  • I have tested the changes locally and ensured they work as expected.

👀 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.

Copilot AI review requested due to automatic review settings February 24, 2026 18:52
@kubestellar-prow kubestellar-prow bot added the dco-signoff: no Indicates the PR's author has not signed the DCO. label Feb 24, 2026
@kubestellar-prow
Copy link

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:

  • 7ff106e Move console documentation from kubestellar repo to docs repository (Issue #3692)
Details

Instructions 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.

@netlify
Copy link

netlify bot commented Feb 24, 2026

Deploy Preview for kubestellar-docs failed. Why did it fail? →

Built without sensitive environment variables

Name Link
🔨 Latest commit 7ff106e
🔍 Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/699df3653e8db8000831d10a

@kubestellar-prow
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign mahimonga for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubestellar-prow kubestellar-prow bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Feb 24, 2026
@github-actions
Copy link
Contributor

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 git commit -s to certify the Developer Certificate of Origin

PR Title - Must start with an emoji: ✨ (feature), 🐛 (bug fix), 📖 (docs), 🌱 (infra/tests), ⚠️ (breaking change)

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!

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 24, 2026
@kubestellar-prow kubestellar-prow bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 24, 2026
@kubestellar-prow
Copy link

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions 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.

@nehanataraj
Copy link
Author

Hi! I have opened a PR migrating the console documentation to the docs
repository as suggested: #1207

Please let me know if any restructuring or link adjustments are needed.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

![Dashboard Overview](images/dashboard-overview.png)
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
![Dashboard Overview](images/dashboard-overview.png)
![Dashboard Overview](/docs-images/console/images/dashboard-overview.png)

Copilot uses AI. Check for mistakes.
Comment on lines +48 to +58
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
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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

Copilot uses AI. Check for mistakes.

For update-related issues:

- Check the [troubleshooting guide](README.md#troubleshooting)
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- Check the [troubleshooting guide](README.md#troubleshooting)
- Check the [troubleshooting guide](https://github.com/kubestellar/console/blob/main/README.md#troubleshooting)

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +3
# Updates and Releases

The KubeStellar Klaude Console follows a regular release schedule with two update channels.
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@clubanderson clubanderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1195 🐛 Fix: related projects hover appears dark in light mode btwshivam

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: no Indicates the PR's author has not signed the DCO. documentation Improvements or additions to documentation needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for the console belongs in the kubestellar/docs repository

2 participants