Skip to content

Conversation

@AnjaliMishra1st
Copy link

Adds a short note pointing users to the CLI help output for additional flags, as suggested in issue #4051.

Adds a short note pointing users to the CLI help output for additional flags, as suggested in issue kubernetes-sigs#4051.
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 25, 2025
@k8s-ci-robot
Copy link
Contributor

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 /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.

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.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 25, 2025
@AnjaliMishra1st
Copy link
Author

Hi @BenTheElder and @aojea,
This is a small documentation update based on the guidance in issue #4051.
Whenever you have time, could you please review and trigger /ok-to-test?
Thanks!

@AnjaliMishra1st
Copy link
Author

Hi @stmcginnis @BenTheElder @aojea,
I have applied the suggested fix.
Could you please take another look and add /ok-to-test and /lgtm when possible?
Thank you!

Added example workflow for loading image archives.
@AnjaliMishra1st
Copy link
Author

Fixed the backticks and updated the formatting.
@stmcginnis @BenTheElder @aojea
Please review and add /ok-to-test and /lgtm when possible. Thanks!

@stmcginnis
Copy link
Contributor

Sort of on the fence about documenting to use --help since that's sort of a common CLI thing that in general should be used everywhere. But doesn't harm anything, and this might give some users a breadcrumb to help figure out what to do if they get stuck.

/ok-to-test
/lgtm

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 1, 2025
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 1, 2025
@AnjaliMishra1st
Copy link
Author

Hi @aojea, @BenTheElder,
This PR now has /lgtm and all tests have passed.
Could you please review and add /approve when you get time?
Thank you!

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:
Copy link
Member

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'.
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 12, 2025
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: AnjaliMishra1st
Once this PR has been reviewed and has the lgtm label, please ask for approval from stmcginnis. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 12, 2025
@AnjaliMishra1st
Copy link
Author

Hi @BenTheElder,
I have updated the PR according to your suggestion and added a general help
section instead of referencing --help for the specific command.

Please take a look when convenient. Thank you!

Copy link
Contributor

@stmcginnis stmcginnis left a 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
```

Copy link
Contributor

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`


Copy link
Contributor

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.

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

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants