kubernetes / kubernetes/website

Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_apply/

Open Beginner friendly
#55,784 4 comments 0 reactions 0 assignees View on GitHub
language/en needs-triage sig/cli
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

Does not list a default value for the `--wait` field in the documentation for the apply command, whereas it does in documentations for other commands such as `--delete`.

Could be extra confusing as the value in those cases defaults to `true` and according the the output of the cli docs, the `--wait` value in this case faults to `false`

Contributor guide

Open the contributing guide

Research direction

Start with k8s.io/docs/reference/kubectl/generated/kubectl_apply/ and compare the --wait entry with the documentation for --delete and the kubectl CLI docs. Done means the apply reference clearly lists the correct default value for --wait and no longer conflicts with the CLI output.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.