Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Broken Micrometer links in documentation #40916

Closed
Seungpang opened this issue May 27, 2024 · 5 comments
Closed

Broken Micrometer links in documentation #40916

Seungpang opened this issue May 27, 2024 · 5 comments
Labels
type: documentation A documentation update
Milestone

Comments

@Seungpang
Copy link
Contributor

Seungpang commented May 27, 2024

Hi Team,

The documentation for Spring Boot contains several references to Micrometer's documentation using the {url-micrometer-docs}, {url-micrometer-docs-implementations}, and {url-micrometer-docs-concepts} placeholders.

These links are currently broken because the URL structure of Micrometer's documentation now includes a version number.

Affected Files

  • metrics.adoc
  • observability.adoc

스크린샷 2024-05-27 오후 11 28 54

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label May 27, 2024
@mhalbritter
Copy link
Contributor

Thanks for the report! One such link can be found on the Metrics page for example:

Micrometer’s capabilities, see its reference documentation

@mhalbritter mhalbritter added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels May 28, 2024
@mhalbritter mhalbritter added this to the 3.3.x milestone May 28, 2024
@mhalbritter mhalbritter changed the title Broken Links in Documentation Due to Versioned URL Broken Micrometer links in documentation May 28, 2024
@philwebb
Copy link
Member

I think we should ask Micrometer to fix this, otherwise we have no way of providing links for the version we actually use. I've raised micrometer-metrics/micrometer#5152

@Seungpang
Copy link
Contributor Author

Seungpang commented May 29, 2024

I agree. Thank you!
In the meantime, should I replace the existing https://micrometer.io/docs/ links with {url-micrometer-docs}, or were those intentional?

@philwebb
Copy link
Member

@Seungpang Those aren't intentional so we'd happily accept a PR to fix them.

@mhalbritter mhalbritter added the status: blocked An issue that's blocked on an external project change label Jun 12, 2024
@philwebb philwebb removed the status: blocked An issue that's blocked on an external project change label Jun 20, 2024
@philwebb philwebb modified the milestones: 3.3.x, 3.3.1 Jun 20, 2024
@philwebb
Copy link
Member

For now I'm going to drop the version part

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

4 participants