Skip to content

Conversation

@ParthKshirsagar7
Copy link
Contributor

Description

This PR introduces comprehensive documentation for ITS (Inventory & Transport Space) cluster management capabilities within the KubeStellar Dashboard. The documentation delivers end-to-end guidance on managing Kubernetes clusters through the Dashboard interface, covering critical workflows from cluster discovery and import through advanced labeling and filtering operations.

Related Issue

Fixes kubestellar/ui#2283

Changes Made

Documentation

  • Added its-cluster-management.md - A comprehensive guide covering:
    • Cluster Discovery & Import: Complete Quick Connect workflow enabling users to auto-discover and seamlessly onboard Kubernetes clusters into the ITS, with real-time progress monitoring and verification steps
    • Individual Cluster Labeling: Detailed instructions for applying metadata labels to clusters, enabling better organization and targeted workload distribution
    • Bulk Labeling Operations: Scalable approach for managing labels across multiple clusters simultaneously, essential for large-scale deployments
    • Label-Based Filtering: Advanced filtering capabilities allowing users to efficiently locate and manage clusters based on applied labels

Visual Assets

  • Added 26 production-quality screenshots organized by workflow type:
    • Quick Connect cluster import process (6 screenshots)
    • Individual cluster labeling workflow (7 screenshots)
    • Bulk labeling operations (6 screenshots)
    • Label-based filtering mechanisms (5 screenshots)
    • General cluster location and navigation (2 screenshots)
  • Screenshots are systematically organized in a hierarchical directory structure (docs/content/images/its/) with logical subdirectories mapping to each documented workflow

Navigation Updates

  • Updated page-map.ts to integrate the new documentation into the site's navigation structure, ensuring discoverability

Checklist

  • I have reviewed the project's contribution guidelines.
  • I have updated the documentation.
  • I have tested the documentation locally to ensure images and formatting render correctly.
  • My changes are documentation-only and follow the project’s standards.

Additional Notes

This is a documentation-only contribution with no changes to application code, UI components, or functionality. The content has been carefully crafted to align with KubeStellar's existing documentation voice while providing maximum clarity through visual aids.

Feedback, suggestions, and recommendations for improvement are welcomed and appreciated.

Copilot AI review requested due to automatic review settings January 14, 2026 06:33
@kubestellar-prow kubestellar-prow bot added the dco-signoff: no Indicates the PR's author has not signed the DCO. label Jan 14, 2026
@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 vedansh-5 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

@netlify
Copy link

netlify bot commented Jan 14, 2026

Deploy Preview for kubestellar-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit cf771b7
🔍 Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/696a3a9cb4267800083ab530
😎 Deploy Preview https://deploy-preview-649--kubestellar-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@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 documentation Improvements or additions to documentation frontend typescript pages labels Jan 14, 2026
@kubestellar-prow kubestellar-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 14, 2026
@kubestellar-prow
Copy link

Hi @ParthKshirsagar7. 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.

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 adds comprehensive ITS (Inventory and Transport Space) cluster management documentation to the KubeStellar Dashboard. The documentation provides detailed guidance for managing Kubernetes clusters through step-by-step guides with visual aids.

Changes:

  • Added new documentation file covering cluster discovery, import, labeling, and filtering workflows
  • Included 26 screenshots organized by workflow type to support the documentation
  • Updated navigation structure to create a dedicated UI section with the new ITS cluster management documentation

Reviewed changes

Copilot reviewed 2 out of 28 changed files in this pull request and generated 2 comments.

File Description
src/app/docs/page-map.ts Updated navigation structure to create a new 'UI' section with nested items for Overview and ITS cluster management
docs/content/ui-docs/its-cluster-management.md Added comprehensive ITS cluster management documentation with introduction, prerequisites, step-by-step guides, use cases, troubleshooting, and integration information

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ParthKshirsagar7 ParthKshirsagar7 changed the title [docs]: add ITS cluster management documentation Add ITS cluster management documentation Jan 14, 2026
@ParthKshirsagar7 ParthKshirsagar7 changed the title Add ITS cluster management documentation Docs/Add ITS cluster management documentation Jan 14, 2026
ParthKshirsagar7 and others added 3 commits January 14, 2026 12:36
Signed-off-by: Parth Kshirsagar <parthyk007@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Parth Kshirsagar <parthyk007@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Parth Kshirsagar <parthyk007@gmail.com>
@kubestellar-prow kubestellar-prow bot added dco-signoff: yes Indicates the PR's author has signed the DCO. and removed dco-signoff: no Indicates the PR's author has not signed the DCO. labels Jan 14, 2026
@ParthKshirsagar7 ParthKshirsagar7 changed the title Docs/Add ITS cluster management documentation 📖 Docs/Add ITS cluster management documentation Jan 14, 2026
@btwshivam
Copy link
Collaborator

@naman9271 why preview is failing

@naman9271
Copy link
Member

@naman9271 why preview is failing

merge conflict !

@ParthKshirsagar7
Copy link
Contributor Author

Hey @naman9271, I've pulled the latest changes. Could you please approve the awaiting workflows? Thank you!

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

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. documentation Improvements or additions to documentation frontend needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. pages size/L Denotes a PR that changes 100-499 lines, ignoring generated files. typescript

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Comprehensive MDX Documentation for ITS - Cluster Management Features

3 participants