Fix code examples in docs #5182
Conversation
tnqn
commented
Jun 28, 2023
tnqn
commented
- Remove "..." from yaml examples, otherwise the examples are displayed in a weird way in website.
- Remove leading "$" from bash examples which contain only commands, to make the example to be copied and executed easier.
- Insert a space between "$" and command for bash examples which contain both commands and outputs, to avoid ambiguity of dollar sign.
- Remove the random suffix of Antrea ConfigMap name which is no longer used.
- Fix a few wrong examples.
| ``` | ||
|
|
||
| ```yaml | ||
| antrea-controller.conf: | |
There was a problem hiding this comment.
@luolanzone I assume this is wrong as I don't find enablePodToPodConnectivity option in antrea-controller config.
There was a problem hiding this comment.
You are right, it should be antrea-agent's configuration instead of antrea-controller.
| @@ -51,11 +51,9 @@ Below is a sample of needed changes in the Antrea deployment YAML: | |||
|
|
|||
| ```yaml | |||
| antrea-controller.conf: | | |||
| ... | |||
There was a problem hiding this comment.
It is not a big deal, but no way to express "..."?
There was a problem hiding this comment.
I don't know a good way. And a ConfigMap including this content only is also correct. The options that are not displayed will just use their defaults. Having "..." in-between the configurations will just make it harder to copy and paste, e.g. https://github.com/antrea-io/antrea/blob/main/docs/antrea-ipam.md#enable-antreaipam-feature-gate-and-bridging-mode
1. Remove "..." from yaml examples, otherwise the examples are displayed in a weird way in website. 2. Remove leading "$" from bash examples which contain only commands, to make the example to be copied and executed easier. 3. Insert a space between "$" and command for bash examples which contain both commands and outputs, to avoid ambiguity of dollar sign. 4. Remove the random suffix of Antrea ConfigMap name which is no longer used. 5. Fix a few wrong examples. Signed-off-by: Quan Tian <[email protected]>
|
/skip-all |
