Skip to content

Fix Actuator API PDF name #21054

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

Conversation

dreis2211
Copy link
Contributor

Hi,

I found another broken link in the docs pointing to the actuator api PDF. An alternative solution to what I've done in this PR is obviously renaming the link in the docs, but that is a bit inconsistent to the other PDFs we have. (And I kind of like to switch between versions in the docs, which is easier if it's the same file name, but that's just personal).

Slightly related, I've noticed that the actuator-api doesn't have a reference folder, but directly contains the pdf and html folder. I was wondering if this should be harmonized maybe. I didn't do it here because it's not part of the bug really.

Cheers,
Christoph

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Apr 21, 2020
@dreis2211
Copy link
Contributor Author

Build failure seems to be related to a missing entry in the micrometer BOM (see micrometer-metrics/micrometer#2012)

@dreis2211
Copy link
Contributor Author

I should note btw that the link in the current snapshot docs work, because there is an old file still available with the correct naming. It is broken in the latest milestone build & will be missing in the upcoming release (candidate) builds.

@philwebb philwebb added type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged labels Apr 21, 2020
@philwebb philwebb added this to the 2.3.x milestone Apr 21, 2020
@snicoll snicoll changed the title Fix link to Actuator API PDF Fix Actuator API PDF name Apr 25, 2020
@snicoll snicoll self-assigned this Apr 25, 2020
@snicoll snicoll modified the milestones: 2.3.x, 2.3.0.RC1 Apr 25, 2020
snicoll pushed a commit that referenced this pull request Apr 25, 2020
@snicoll snicoll closed this in 6d17c9f Apr 25, 2020
@snicoll
Copy link
Member

snicoll commented Apr 25, 2020

Good catch @dreis2211 and thank you so much again. I'll remove index.pdf on the build has completed.

To answer your question, I don't think an extra reference directory is warranted there. We do this when there is an extra content (typically javadoc).

@dreis2211
Copy link
Contributor Author

Thanks for updating me, @snicoll :)

@snicoll
Copy link
Member

snicoll commented Apr 27, 2020

I should note btw that the link in the current snapshot docs work, because there is an old file still available with the correct naming. It is broken in the latest milestone build & will be missing in the upcoming release (candidate) builds.

I've removed the duplicate index.pdf from 2.3.0.BUILD-SNAPSHOT and I've fixed the name of the PDF in previous milestones on the doc server so that the link works again.

@dreis2211
Copy link
Contributor Author

Thanks

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

Successfully merging this pull request may close these issues.

4 participants