Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Clarify node create help text about cluster reference #808

Merged
merged 2 commits into from
Oct 22, 2021

Conversation

losinggeneration
Copy link
Contributor

What

An attempt to make it more clear that node create can be used for both k3d cluster names and external clusters by URL.

Why

When I first looked at k3d node create, I didn't realize the cluster argument was for more than a k3d created cluster. I tried a few things before I searched the issues and found #549 & the PR that fixed it, #734 It might save some users some time if this is more clear in the help & documentation. I initially thought of adding a new section it the guides for this, but I'm not sure how common the use-case is.

Implications

Since it's documentation only, it's unlikely to be a breaking changes. A potential caveat would be a tool inspecting & expecting exact strings from the help: k3d node create -h. Since that's typically a pretty naive implementation, it's unlikely to cause any real world issues.

* An attempt to make it more clear that node create can be used for
  both k3d cluster names and external clusters by URL.
Copy link
Member

@iwilltry42 iwilltry42 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for clarifying this :)

@iwilltry42
Copy link
Member

Thanks for your contribution @losinggeneration :)

I initially thought of adding a new section it the guides for this, but I'm not sure how common the use-case is.

This would be very welcome, e.g. paired with an example on how to setup a "distributed" cluster 🤔

@iwilltry42 iwilltry42 changed the title Clarify the node create help a bit [Docs] Clarify node create help text about cluster reference Oct 22, 2021
@iwilltry42 iwilltry42 merged commit 376f037 into k3d-io:main Oct 22, 2021
@iwilltry42 iwilltry42 added this to the v5.0.2 milestone Oct 22, 2021
@iwilltry42 iwilltry42 added the docs Documentation label Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants