Skip to content

📖 Relocating The Inline Comments From Script Inside Getting Started Document#921

Open
ngvanthanggit wants to merge 1 commit intokubestellar:docs/0.29.0from
ngvanthanggit:patch-1
Open

📖 Relocating The Inline Comments From Script Inside Getting Started Document#921
ngvanthanggit wants to merge 1 commit intokubestellar:docs/0.29.0from
ngvanthanggit:patch-1

Conversation

@ngvanthanggit
Copy link
Member

@ngvanthanggit ngvanthanggit commented Jan 29, 2026

In this PR, I removed the inline comments from the script commands under the Use Core Helm chart to initialize KubeFlex and create ITS and WDS section, and relocated them to the lines outside the script.
This change helps the users to easily copy, paste, and run the script without modifying it manually.

📌 Fixes

Fixes #920 (Use "Fixes", "Closes", or "Resolves" for automatic closing)

📝 Summary of Changes

  • I removed the inline comments in some installation scripts and made the explanation for them outside the scripts instead. This will avoid any errors when new users try to copy and paste to run all the scripts.

Changes Made

  • Updated Getting Started document for KubeStellar.io

Checklist

Please ensure the following before submitting your PR:

  • I have reviewed the project's contribution guidelines.
  • I have written unit tests for the changes (if applicable).
  • I have updated the documentation (if applicable).
  • I have tested the changes locally and ensured they work as expected.
  • My code follows the project's coding standards.

Screenshots or Logs (if applicable)

image image

👀 Reviewer Notes

Add any special notes for the reviewer here

@kubestellar-prow kubestellar-prow bot added the dco-signoff: no Indicates the PR's author has not signed the DCO. label Jan 29, 2026
@kubestellar-prow
Copy link

kubestellar-prow bot commented Jan 29, 2026

[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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 29, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 29, 2026

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!

@kubestellar-prow kubestellar-prow bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 29, 2026
@netlify
Copy link

netlify bot commented Jan 29, 2026 •
edited
Loading

✅ Deploy Preview for kubestellar-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 589bbfe
🔍 Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/697baf75a8be9e0008098dc7
😎 Deploy Preview https://deploy-preview-921--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

github-actions bot commented Jan 29, 2026 •
edited
Loading

📖 Preview Links

The following documentation pages were changed in this PR:

Status Page Preview Link
📝 modified get-started View preview

🔗 Full preview site

@ngvanthanggit
Relocating The Inline Comments From Script Inside Getting Started Doc…
589bbfe 
…ument

Added explanation for verbosity.default flag and clarified context commands.

Signed-off-by: ngvanthanggit <thangitcbg@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 29, 2026
@ngvanthanggit ngvanthanggit changed the title Relocating The Inline Comments From Script Inside Getting Started Document 📖 Relocating The Inline Comments From Script Inside Getting Started Document Jan 29, 2026
@ngvanthanggit
Copy link
Member Author

ngvanthanggit commented Jan 29, 2026

Hi @clubanderson @MikeSpreitzer @KPRoche, I hope this one works!
😊🤗

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

Reviewers

No reviews

Assignees

No one assigned

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. documentation Improvements or additions to documentation size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ngvanthanggit