github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/docs/style-guides/docs.md (about)

     1  # kpt Docs Style Guide
     2  
     3  1. CLI commands name should appear with inline quotes everywhere including in
     4     page titles:
     5     - Correct: `diff`
     6     - Incorrect: `Diff`
     7     - Incorrect: `The Diff tool`
     8  2. Shell commands should be in `shell` code blocks and should contain exactly
     9     one command specifing using`$`:
    10  
    11     ```shell
    12     $ kpt <command>
    13     <output>
    14     ```
    15  
    16  3. Links to other kpt doc pages should be absolute:
    17     - Correct: `[pkg]: /reference/cli/pkg/get/`
    18     - Incorrect: `[pkg]: ../../../reference/cli/pkg/get`
    19  4. Flags must appear after positional args:
    20  
    21     - Correct:
    22  
    23     ```shell
    24     $ kpt fn eval my-package --image gcr.io/kpt-fn/search-replace
    25     ```
    26  
    27     - Incorrect:
    28  
    29     ```shell
    30     $ kpt fn eval --image gcr.io/kpt-fn/search-replace my-package
    31     ```
    32  
    33  5. The name of the tool should always appear as small caps (even at start of
    34     sentences) and not in block quotes:
    35     - Correct: kpt
    36     - Incorrect: `kpt`
    37     - Incorrect: Kpt
    38     - Incorrect: KPT
    39  6. References to a particular KRM group, version, kind, field should appear with
    40     inline quotes:
    41     - Correct: `ConfigMap`
    42     - Incorrect: ConfigMap