Skip to content

📖 docs: add cross-reference from users.md to k3d.md#678

Open
VignanNallani wants to merge 1 commit into
kubestellar:mainfrom
VignanNallani:docs/k3d-crossref
Open

📖 docs: add cross-reference from users.md to k3d.md#678
VignanNallani wants to merge 1 commit into
kubestellar:mainfrom
VignanNallani:docs/k3d-crossref

Conversation

@VignanNallani

Copy link
Copy Markdown

Summary

Adds a cross-reference link in the "Installing on k3d" section of
docs/users.md pointing to the dedicated docs/k3d.md guide.

Problem

Users who find the brief k3d section in users.md have no way to
discover the full k3d documentation page added in PR #676.

Changes

  • Added one line in docs/users.md under ### Installing on k3d
    linking to ./k3d.md for the complete setup guide.

Closes #677

…ar#677)

Signed-off-by: Vignan Nallani <vignanchowdarytilt@gmail.com>
Copilot AI review requested due to automatic review settings May 18, 2026 01:38
@kubestellar-prow kubestellar-prow Bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label May 18, 2026
@kubestellar-prow

Copy link
Copy Markdown
Contributor

[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 clubanderson 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 18, 2026
@kubestellar-prow

Copy link
Copy Markdown
Contributor

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

@kubestellar-prow kubestellar-prow Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 18, 2026
@VignanNallani

Copy link
Copy Markdown
Author

Closes #677

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a cross-reference in the k3d installation section of docs/users.md to help users discover the dedicated k3d setup guide.

Changes:

  • Added a short sentence/link under “### Installing on k3d” pointing readers to ./k3d.md.

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

Comment thread docs/users.md

### Installing on k3d

For a complete guide to using KubeFlex with k3d, including prerequisites, cluster setup, and control plane creation, see the [k3d documentation](./k3d.md).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

The docs/k3d.md file is being added in the companion PR #676, which is currently open and awaiting review. This PR is intentionally a follow-up — the link will be valid once #676 is merged. Happy to merge this after #676 if that's preferred.

@VignanNallani

Copy link
Copy Markdown
Author

Hi @clubanderson — small follow-up to PR #676. Adds a cross-reference link so users can discover the full k3d guide from the users.md page. Would appreciate your review!

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. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📖 docs: add cross-reference from users.md to k3d.md for better discoverability

2 participants