kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

TYPO: fix documentation to point at update-generated-docs.sh

This commit is contained in:
Eric Paris 2015-08-14 18:50:03 -04:00
parent bc21d6f1f4
commit 0eb6b6ec3d
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
kubectl-conventions.md
View File

@ -99,7 +99,7 @@ Updated: 8/12/2015
## Documentation conventions ## 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 * 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 * 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. * Long may contain multiple lines, including additional information about input, output, commonly used flags, etc.