-
CLI commands name should appear with inline quotes everywhere including in page titles:
- Correct:
diff
- Incorrect:
Diff
- Incorrect:
The Diff tool
- Correct:
-
Shell commands should be in
shell
code blocks and should contain exactly one command specifing using$
:$ kpt <command> <output>
-
Links to other kpt doc pages should be absolute:
- Correct:
[pkg]: /reference/cli/pkg/get/
- Incorrect:
[pkg]: ../../../reference/cli/pkg/get
- Correct:
-
Flags must appear after positional args:
- Correct:
$ kpt fn eval my-package --image gcr.io/kpt-fn/search-replace
- Incorrect:
$ kpt fn eval --image gcr.io/kpt-fn/search-replace my-package
-
The name of the tool should always appear as small caps (even at start of sentences) and not in block quotes:
- Correct: kpt
- Incorrect:
kpt
- Incorrect: Kpt
- Incorrect: KPT
-
References to a particular KRM group, version, kind, field should appear with inline quotes:
- Correct:
ConfigMap
- Incorrect: ConfigMap
- Correct: