Skip to content

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

Closed
wants to merge 2 commits into from

Conversation

cdalexndr
Copy link
Contributor

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.

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.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Mar 3, 2021
@wilkinsona
Copy link
Member

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:

To learn more about the Actuator's endpoints and their request and response formats, please refer to the separate API documentation ({spring-boot-actuator-restapi}/html/[HTML] or {spring-boot-actuator-restapi}/pdf/spring-boot-actuator-web-api.pdf[PDF]).

Perhaps it could be made a TIP and/or moved to earlier in the section so it doesn't get lost beneath the table. Would you like to update your PR to that effect?

@wilkinsona wilkinsona added the status: waiting-for-feedback We need additional information before we can continue label Mar 3, 2021
@cdalexndr
Copy link
Contributor Author

cdalexndr commented Mar 3, 2021

@wilkinsona what about the other 2 links pointing to the same api doc?

Moving it below header and highlighting it seems a good compromise.

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Mar 3, 2021
@wilkinsona
Copy link
Member

I think the other two links are fine as they are.

@cdalexndr
Copy link
Contributor Author

@wilkinsona done

@wilkinsona wilkinsona changed the title Highlight endpoints API link Highlight link to Actuator API docs in the reference docs Mar 5, 2021
@wilkinsona wilkinsona added type: documentation A documentation update and removed status: feedback-provided Feedback has been provided status: waiting-for-triage An issue we've not yet triaged labels Mar 5, 2021
@wilkinsona wilkinsona added this to the 2.3.x milestone Mar 5, 2021
@wilkinsona wilkinsona self-assigned this Mar 5, 2021
wilkinsona pushed a commit that referenced this pull request Mar 5, 2021
@wilkinsona wilkinsona closed this in 8b5c345 Mar 5, 2021
@wilkinsona wilkinsona modified the milestones: 2.3.x, 2.3.10 Mar 5, 2021
@wilkinsona
Copy link
Member

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.

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

Successfully merging this pull request may close these issues.

3 participants