-
Notifications
You must be signed in to change notification settings - Fork 41.2k
Highlight link to Actuator API docs in the reference docs #25486
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
Conversation
Users that fast search this doc may miss that there is another document explaining endpoints api. The api link is not accessible from main doc reference (https://docs.spring.io/spring-boot/docs/2.4.3/reference/html/), and it is scattered through this doc in 3 places. This change helps highlight the API link into a header so that it is more visible.
Thanks for the pull request. I agree that we should make the link to the Actuator API documentation more prominent, but I don't think this is how we should do it. I'd rather make the following paragraph more prominent:
Perhaps it could be made a |
@wilkinsona what about the other 2 links pointing to the same api doc? Moving it below header and highlighting it seems a good compromise. |
I think the other two links are fine as they are. |
@wilkinsona done |
Thanks very much, @cdalexndr. I moved the tip down slightly (still before the tables) so that the reader has a bit more context before coming to it. |
Users that fast search this doc may miss that there is another document explaining endpoints api.
The api link is not accessible from main doc reference (https://docs.spring.io/spring-boot/docs/2.4.3/reference/html/), and it is scattered through this doc in 3 places.
This change helps highlight the API link into a header so that it is more visible.