elastic / elastic/crd-ref-docs

Generate unique type headers

Open
#30 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

The current headers in the markdown template are not guaranteed to be unique since they do not include the version. For my use case I have multiple versions of a CRD with the same types in each version. Since the output is all in one file, when I want to link to a type from another markdown file (like `out.md#typename`), it will only ever link to the first heading matching the link, which could be an out of date reference. I tried creating my own template for this but the issue is the markdown `RenderTypeLink` function will no longer create accurate links with the change.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.