Skip to content

Only link to the two alternative formats from each format of the reference documentation #27737

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 1 commit into from

Conversation

Buzzardo
Copy link

And some small editing changes.

And some small editing changes.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Aug 17, 2021
@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Aug 17, 2021
@philwebb philwebb added this to the 2.6.x milestone Aug 17, 2021
@philwebb
Copy link
Member

We should double check the condition works because I'm not sure if the new backend sets the same property name.

@wilkinsona
Copy link
Member

@Buzzardo For future reference, we try to keep individual commits focussed on a single change. This PR's mixing improvements to the links to the other forms of the documentation with some general editing of the multi-page documentation's index. I'll split things up while merging this and have happened #27805 to track the editorial changes.

@wilkinsona
Copy link
Member

We should double check the condition works because I'm not sure if the new backend sets the same property name.

Good catch, Phil. As proposed, the changes remove the sentence beginning "This document is also available as …" from both the single-page documentation and from the PDF.

@wilkinsona wilkinsona changed the title Made the alternate format links be conditional Only link to the two alternative formats from each format of the reference documentation Aug 23, 2021
@wilkinsona wilkinsona modified the milestones: 2.6.x, 2.6.0-M3 Aug 23, 2021
@wilkinsona
Copy link
Member

Thanks, @Buzzardo. I've merged these changes into main.

For future reference, it'd be greatly appreciated if you could build your changes (./gradlew spring-boot-project:spring-boot-docs:build should do the trick) before submitting them and double-check that they're rendered as expected.

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.

4 participants