Repository navigation
Remove outdated warnings in docs for @Counted/@Timed - #5736
Conversation
|
Thanks for the pull request. For what it's worth, the note (if I remember correctly) was for Spring Boot's support of Micrometer's annotations without using the corresponding aspect ( With all that said, I still agree it makes sense to remove this outdated note which probably didn't belong in the Micrometer docs to begin with (except to the extent it applied to the spring legacy module we used to have). |
I thought I opened an issue related to this, but maybe not. In general, yes it would be better to not document a third-party library's (Spring Boot's) configuration properties in our documentation. However, it is a nice compact way to document the Config class methods indirectly. So I would ideally like to come up with a way to generate that automatically or at least ensure it is up-to-date with the current version of the Config class. A cheap and lazy way might be to link to the JavaDoc for the Config type instead of the Spring Boot configuration properties. A link is easier to miss and moves the info one more hop away from the documentation users are looking at, though. So I'm not sure what will be best or feasible/easy to do in the short term, but I agree it's definitely not ideal how it is now.
We can, but we do have a bit of a dependency cycle type of issue since Spring Boot depends on us and not the other way around. What version of the Spring Boot docs do we link to from our docs? I guess it isn't an issue once we release our first patch release after the corresponding Spring Boot release goes GA. |
|
@shakuzen Thanks for the feedback! "Micrometer's Spring Boot configuration" (not "Spring Boot's Micrometer configuration") or "Micrometer's Spring Boot support" (not "Spring Boot's Micrometer support") made me think that it's for the legacy Spring Boot support module. I guess they have been updated for Spring Boot's Micrometer support after its release.
I just thought that it's just an example of configuration binding, so it's okay to use links to the current version of Spring Boot. |
Perhaps, but those links could become broken in new versions of the Spring Boot docs (e.g. when section headers are renamed or moved or removed), which is the inherent danger in linking to a non-specific version of the docs. |
This PR removes outdated warnings in docs for
@Countedand@Timedas they seem to be for the removed Spring Boot legacy module.I can see some more related to Spring Boot application properties for meter registries (ex. AppOptics). I think we can replace them with links to Spring Boot reference docs for them (ex. AppOptics). I can try this with another PR if you agree with this direction.