-
Notifications
You must be signed in to change notification settings - Fork 384
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Escape Markdown pipes #3332
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, both those files are generated from the values, you could modify the comment there or fix the genrator.
Signed-off-by: Kaita Nakamura <[email protected]>
b883533
to
49c9f24
Compare
@@ -124,15 +124,15 @@ tetragon: | |||
# As a concrete example, the following will redact all passwords passed to | |||
# processes with the "--password" argument: | |||
# | |||
# {"redact": ["--password(?:\\s+|=)(\\S*)"]} | |||
# {"redact": ["--password(?:\\s+\|=)(\\S*)"]} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well this is not ideal since it eventually modify these regex (binary_regex) so that docs looks better but the direct docs on values isn't exact anymore. I'm afraid you'll have to fix the thing we use for the generation, it seems the issue already exists :/. This is a complete different task than just fixing this docs so don't feel like you have to fix this!
See:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! You are right.
Should I add this to the Issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as you wish! if you don't consider fixing this other project's issue I might take a look eventually, tell me
Description
There is a display problem because pipe is used in the Markdown table. 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
Fix it by escaping pipe.
Also, if you escape pipe, the second half of the string will be recognized, and asterisk will make the following part bold.
So escape asterisk.