docs: Pipes in Markdown tables are not handled correctly

[z63d]

What happened?

There is a display problem because pipe is used in the Markdown tables. The string after pipe is not displayed.
https://tetragon.io/docs/reference/helm-chart/
https://github.com/cilium/tetragon/blob/main/install/kubernetes/tetragon/README.md

For example, this part

tetragon/docs/content/en/docs/reference/helm-chart.md

Line 133 in 4a6643e

| tetragon.redactionFilters | string | `""` | Filters to redact secrets from the args fields in Tetragon events. To perform redactions, redaction filters define RE2 regular expressions in the `redact` field. Any capture groups in these RE2 regular expressions are redacted and replaced with "*****". For more control, you can select which binary or binaries should have their arguments redacted with the `binary_regex` field. NOTE: This feature uses RE2 as its regular expression library. Make sure that you follow RE2 regular expression guidelines as you may observe unexpected results otherwise. More information on RE2 syntax can be found [here](https://github.com/google/re2/wiki/Syntax). NOTE: When writing regular expressions in JSON, it is important to escape backslash characters. For instance `\Wpasswd\W?` would be written as `{"redact": "\\Wpasswd\\W?"}`. As a concrete example, the following will redact all passwords passed to processes with the "--password" argument: {"redact": ["--password(?:\\s+|=)(\\S*)"]} Now, an event which contains the string "--password=foo" would have that string replaced with "--password=*****". Suppose we also see some passwords passed via the -p shorthand for a specific binary, foo. We can also redact these as follows: {"binary_regex": ["(?:^|/)foo$"], "redact": ["-p(?:\\s+|=)(\\S*)"]} With both of the above redaction filters in place, we are now redacting all password arguments. |

I'm hoping for it to be like this:

Filters to redact secrets from the args fields in Tetragon events. To perform redactions, redaction filters define RE2 regular expressions in the `redact` field. Any capture groups in these RE2 regular expressions are redacted and replaced with "*****". For more control, you can select which binary or binaries should have their arguments redacted with the `binary_regex` field. NOTE: This feature uses RE2 as its regular expression library. Make sure that you follow RE2 regular expression guidelines as you may observe unexpected results otherwise. More information on RE2 syntax can be found [here](https://github.com/google/re2/wiki/Syntax). NOTE: When writing regular expressions in JSON, it is important to escape backslash characters. For instance `\Wpasswd\W?` would be written as `{"redact": "\\Wpasswd\\W?"}`. As a concrete example, the following will redact all passwords passed to processes with the "--password" argument: {"redact": ["--password(?:\\s+|=)(\\S*)"]} Now, an event which contains the string "--password=foo" would have that string replaced with "--password=*****". Suppose we also see some passwords passed via the -p shorthand for a specific binary, foo. We can also redact these as follows: {"binary_regex": ["(?:^|/)foo$"], "redact": ["-p(?:\\s+|=)(\\S*)"]} With both of the above redaction filters in place, we are now redacting all password arguments.

But in reality it will be displayed as follows:

Filters to redact secrets from the args fields in Tetragon events. To perform redactions, redaction filters define RE2 regular expressions in the `redact` field. Any capture groups in these RE2 regular expressions are redacted and replaced with "*****". For more control, you can select which binary or binaries should have their arguments redacted with the `binary_regex` field. NOTE: This feature uses RE2 as its regular expression library. Make sure that you follow RE2 regular expression guidelines as you may observe unexpected results otherwise. More information on RE2 syntax can be found [here](https://github.com/google/re2/wiki/Syntax). NOTE: When writing regular expressions in JSON, it is important to escape backslash characters. For instance `\Wpasswd\W?` would be written as `{"redact": "\\Wpasswd\\W?"}`. As a concrete example, the following will redact all passwords passed to processes with the "--password" argument: {"redact": ["--password(?:\\s+

ref

• fix: Escape Markdown pipes #3332

Same bug

• can helm-docs handle | in comments properly? norwoodj/helm-docs#118
• Pipe | breaks table output of values.yml norwoodj/helm-docs#171

Tetragon Version

Not required

Kernel Version

Not required

Kubernetes Version

Bugtool

No response

Relevant log output

Anything else?

No response

[mtardy]

So this is not really a Tetragon issue I would say since we cannot fix it here, but more of an issue from helm-docs that seems abandoned: you could add a comment in norwoodj/helm-docs#118 that you bumped into this.