📖 fix escaped html in markdown code segments

[typeid]

Issue #3534

• we are using markerdocs as mdBook preprocessor to generate most of our References section (e.g. CRD Validation)
• this preprocessor writes HTML but the text fields also contain markdown (e.g. this line)
• we call html.EscapeString() on the output of the preprocessor (see here)
• the preprocessed output is then parsed as markdown by mdBook

Basically, mdBook handles the content as raw strings (code block) thus quotation marks and other HTML escaped symbols are not escaped

1. Raw text:

 object: `{policy: "delete"}`

2. Preprocessor wraps it with HTML in escaped format

object: `{policy: "delete"}`

3. mdBook picks up on the markdown backticks and further wraps it in the according HTML for the markdown format without interpreting the escaped characters:

<code class="hljs">{policy: &#34;delete&#34;}</code>

This PR aims to fix this issue by not HTML escaping the markdown code segments contained in the text, leaving the behavior up to mdBook.

Fixes #3540

[k8s-ci-robot]

Hi @typeid. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[typeid]

./install-and-build.sh works locally.
I saw that there was a fix on the netlify/kubebuilder/deploy-preview, and the deploy preview works on another PR. So I'm wondering if this error could be sporadic. Could we re-trigger the netlify job?

[camilamacedo86]

Can you please rebase this PR with the latest changes merged in the master so that we can check the change via the preview ?

[typeid]

@camilamacedo86 Ah indeed, forgot to rebase. Done and the deploy-preview works now :)

[camilamacedo86]

Thank you for the amazing contribution 🥇

It is possible to check that it is fixed now:

/approved

/lgtm

/ok-to-test

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, typeid

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[typeid]

/retest