Generate unique type headers
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go, kubernetes
- Domain
- documentation
Research direction
Start by reading the markdown template and the RenderTypeLink function mentioned in the issue, then trace how type headings and links are generated. Done means headings include the version so repeated types have unique anchors, and links from other markdown files resolve to the intended version.
Written by the indexing model from the issue text.
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.
- Dominant language
- Go
- Stars
- 174
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/crd-ref-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
elastic/crd-ref-docs#204 ·
-
Support for +kubebuilder:validation:Required and omitemptyPossibly taken @swathinsankaran claimed this 110 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
elastic/crd-ref-docs#198 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#191 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#188 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#182 ·
All issues in elastic/crd-ref-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
duplication
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
openvibely/openvibely#1443 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 60/100
canonical/service-mesh#845 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
keyxmakerx/Chronicle#1179 ·
Maintainers usually reply within 1 day