crd-ref-docs icon indicating copy to clipboard operation
crd-ref-docs copied to clipboard

Published 20 hours ago • verified publisher icon elastic

Minor markdown improvements

Open olensmar opened this issue 1 year ago • 2 comments

This fixes three issues I bumped into when trying to generate our docs:

  1. adds version to generated file names in group-mode - to avoid files overwriting each-other
  2. escapes html-tags in descriptions
  3. escapes curly-braces in link labels for mdx (docusaurus) compatibility

I'm in no way a go programmer so I apologize in advance if I haven't solved these problems in the correct way and/or made some newbie mistakes.. happy to learn and adjust from you reviewers!

olensmar avatar Aug 05 '24 14:08 olensmar

❌ Author of the following commits did not sign a Contributor Agreement: 8b3fd1cd089f89fdcb76175e509ac16ab1d36de0, b2bfbbcf6c73858bd8728d259d3d0096db47bf4a

Please, read and sign the above mentioned agreement if you want to contribute to this project

cla-checker-service[bot] avatar Aug 05 '24 14:08 cla-checker-service[bot]

sorry - i've signed the CLA now..

olensmar avatar Aug 05 '24 14:08 olensmar