opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

fix bug in config_option shortcode

Open svrnm opened this issue 1 year ago • 1 comments

This addresses #4230. Note that this PR is not yet finalized, but to begin with it demonstrates the underlying issue.

There seems to be an issue with hugo "re-markdownifying" (see https://github.com/gohugoio/hugo/issues/5774#issuecomment-486425783), so this applies the same suggestions:

  1. Use {{< request >}} instead of {{% request %}}, so Hugo stops trying to re-markdownify
  2. Manually markdownify the content

cc @chalin

svrnm avatar Jun 18 '24 18:06 svrnm

Thanks, I appreciate the time you put into investigating this. I can't recall the reason why I made the shortcode an HTML file (other than it mainly contains only HTML :)). What you've implemented here feels like a workaround. I'd like to try to fix the source of the problem. The first thing that I'd try is to rename the shortcode to config_option.md and try to get it to work from there. I don't know when I'll have the time to do that.

Have you double checked that this "fix" doesn't break other invocations of config_option?

chalin avatar Jul 04 '24 16:07 chalin

Thanks, I appreciate the time you put into investigating this. I can't recall the reason why I made the shortcode an HTML file (other than it mainly contains only HTML :)). What you've implemented here feels like a workaround. I'd like to try to fix the source of the problem. The first thing that I'd try is to rename the shortcode to config_option.md and try to get it to work from there. I don't know when I'll have the time to do that.

That would be great!

Have you double checked that this "fix" doesn't break other invocations of config_option?

No, I haven't, that's why this is a draft PR, I didn't want to add this without further investigation from your site.

svrnm avatar Jul 11 '24 09:07 svrnm

@chalin I will close this PR now, since it only was a proof of concept, it's linked to the original issue

svrnm avatar Aug 01 '24 09:08 svrnm