-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs: add note referencing kind load image-archive --help
#4057
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
base: main
Are you sure you want to change the base?
docs: add note referencing kind load image-archive --help
#4057
Conversation
Adds a short note pointing users to the CLI help output for additional flags, as suggested in issue kubernetes-sigs#4051.
|
Hi @AnjaliMishra1st. Thanks for your PR. I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
|
Hi @BenTheElder and @aojea, |
Co-authored-by: Sean McGinnis <[email protected]>
|
Hi @stmcginnis @BenTheElder @aojea, |
Added example workflow for loading image archives.
|
Fixed the backticks and updated the formatting. |
|
Sort of on the fence about documenting to use /ok-to-test |
|
Hi @aojea, @BenTheElder, |
| Additionally, image archives can be loaded with: | ||
| `kind load image-archive /my-image-archive.tar` | ||
|
|
||
| For additional usage details and available flags, you can run: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe instead we should document somewhere that kind help exists.
That recursively documents --help and using it for subcommands. I don't think we want to add an entry like this to the docs for every command.
Updated documentation to include command help options for 'kind'.
|
New changes are detected. LGTM label has been removed. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: AnjaliMishra1st The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Hi @BenTheElder, Please take a look when convenient. Thank you! |
stmcginnis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do like this better than just referencing --help.
Now my concern is placement. It kind of feels like it is just dropped in the middle of a different context. I don't know the best place for it, but what do folks think about it being a subsection at the end of the Installation section? That sort of seems logical to me because that section is about getting started with the CLI itself, then the rest of the sections are about performing specific tasks with it.
| ```bash | ||
| kind load docker-image my-app:latest --name test-cluster | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: extra line not needed, so remove this if you do another update.
| Additionally, image archives can be loaded with: | ||
| `kind load image-archive /my-image-archive.tar` | ||
|
|
||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here. If you use a markdown linter, they typically only want one blank line between elements.
Adds a short note pointing users to the CLI help output for additional flags, as suggested in issue #4051.