github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 19:56:01 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #12754 from eparis/gendoc-rename

Browse Source 
TYPO: fix documentation to point at update-generated-docs.sh
This commit is contained in:
Eric Paris 2015-08-14 17:56:54 -05:00
commit 03dbf6503c
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/devel/kubectl-conventions.md
View File

@ -99,7 +99,7 @@ Updated: 8/12/2015
## Documentation conventions
* Commands are documented using Cobra; docs are then auto-generated by hack/run-gendocs.sh.
* Commands are documented using Cobra; docs are then auto-generated by `hack/update-generated-docs.sh`.
* Use should contain a short usage string for the most common use case(s), not an exhaustive specification
* Short should contain a one-line explanation of what the command does
* Long may contain multiple lines, including additional information about input, output, commonly used flags, etc.