Skip to content

Make cross-references more consistent in the docs#6915

Merged
jonatan-ivanov merged 2 commits intomicrometer-metrics:1.14.xfrom
ngocnhan-tran1996:add-anchor-id
Nov 26, 2025
Merged

Make cross-references more consistent in the docs#6915
jonatan-ivanov merged 2 commits intomicrometer-metrics:1.14.xfrom
ngocnhan-tran1996:add-anchor-id

Conversation

@ngocnhan-tran1996
Copy link
Copy Markdown
Contributor

Missing anchor id pause-detection from the reference: https://docs.micrometer.io/micrometer/reference/concepts.html

@jonatan-ivanov
Copy link
Copy Markdown
Member

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?

@jonatan-ivanov jonatan-ivanov added the waiting for feedback We need additional information before we can continue label Nov 24, 2025
@ngocnhan-tran1996
Copy link
Copy Markdown
Contributor Author

@jonatan-ivanov

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.

@jonatan-ivanov
Copy link
Copy Markdown
Member

Yes, that's what I called implicit id above.
I'm still confused, why should we do this and if it is important enough, why shouldn't we do this everywhere?

@ngocnhan-tran1996
Copy link
Copy Markdown
Contributor Author

ngocnhan-tran1996 commented Nov 26, 2025

My bad, I forgot to answer your question.

1/ About the pause-detection

The current documentation at https://docs.micrometer.io/micrometer/reference/concepts.html
does not point to pause-detection because the timers documentation does not have the pause-detection anchor ID.

We should add the pause-detection ID to avoid broken link.

2/ About tag-naming

I just think that the tag naming section should have a predefined ID. This is optional, and I can revert it.

ngocnhan-tran1996 and others added 2 commits November 26, 2025 14:54
Signed-off-by: Tran Ngoc Nhan <ngocnhan.tran1996@gmail.com>
@jonatan-ivanov jonatan-ivanov changed the base branch from main to 1.14.x November 26, 2025 23:18
@jonatan-ivanov jonatan-ivanov changed the title Add anchor id Make cross-references more consistent in the docs Nov 26, 2025
@jonatan-ivanov jonatan-ivanov added doc-update A documentation update and removed waiting for feedback We need additional information before we can continue labels Nov 26, 2025
@jonatan-ivanov jonatan-ivanov added this to the 1.14.14 milestone Nov 26, 2025
@jonatan-ivanov
Copy link
Copy Markdown
Member

Oh, I see the broken link now.
I found a few other inconsistencies and I think we should fix this starting from 1.14.x so I:

  • rebased the PR on top of 1.14.x
  • repurposed a little bit and also fixed paths in cross-references (so they are consistent and navigable from IDEs)
  • fixed the anchor of "pause detection"

Thank you very much for the PR!

@jonatan-ivanov jonatan-ivanov enabled auto-merge (squash) November 26, 2025 23:24
@jonatan-ivanov jonatan-ivanov merged commit daab96e into micrometer-metrics:1.14.x Nov 26, 2025
6 checks passed
jonatan-ivanov added a commit that referenced this pull request Nov 26, 2025
@ngocnhan-tran1996 ngocnhan-tran1996 deleted the add-anchor-id branch November 27, 2025 02:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-update A documentation update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants