Make cross-references more consistent in the docs#6915
Make cross-references more consistent in the docs#6915jonatan-ivanov merged 2 commits intomicrometer-metrics:1.14.xfrom
Conversation
1dbac37 to
fea448e
Compare
|
If you look around (e.g.: check the files you modified), an explicit id is "missing" from a lot of places, this is because, we have an implicit id by default, the sections you added an explicit id has an implicit one so they are already linkable:
I guess my question is: why should we do this and if it is important enough, why shouldn't we do this everywhere? |
|
By default, Asciidoctor will generate an anchor ID automatically. IMO, this is not important; it only has the advantage that when updating the documentation, a predefined ID will not be affected even if we change the title. |
|
Yes, that's what I called implicit id above. |
|
My bad, I forgot to answer your question. 1/ About the The current documentation at https://docs.micrometer.io/micrometer/reference/concepts.html We should add the 2/ About I just think that the tag naming section should have a predefined ID. This is optional, and I can revert it. |
Signed-off-by: Tran Ngoc Nhan <ngocnhan.tran1996@gmail.com>
Fix paths and anchors
fea448e to
a79c4c8
Compare
|
Oh, I see the broken link now.
Thank you very much for the PR! |
Missing anchor id
pause-detectionfrom the reference: https://docs.micrometer.io/micrometer/reference/concepts.html