search

spring-projects / spring-framework

Spring Framework
https://spring.io/projects/spring-framework
Apache License 2.0
56.14k stars 37.95k forks source link

Reintroduce single-page HTML version of the reference manual #26722

Closed Buzzardo closed 2 years ago

Buzzardo commented 3 years ago

We get requests (and just got another one) for a single-page HTML version of the Spring Framework documentation. People want it so that they can search the whole thing with Ctrl-F. Since we have no other functionality that offers searching across the multiple document files, that seems like a reasonable approach.

My other concern is that we set the expectation of having a single-page HTML file in other projects that have multi-page output (both Batch and Boot having both multi- and single-page HTML). Readers may reasonably ask why we have that arrangement in those places and not in Framwork.

vpavic commented 3 years ago

People want it so that they can search the whole thing with Ctrl-F.

I find myself quite often in this situation when looking something up in the Framework docs. I'm also quite sure that single-page variant did exist in the past (pre-5.x?).

The consistency between the different Spring projects is also something that would be nice to achieve.

vpavic commented 2 years ago

Any updates on this? The Ctrl-F approach to searching the docs is really a common one and without a singe-page variant that's a bit painful. Thanks.

sbrannen commented 2 years ago

@vpavic, as far as I understand, several Spring portfolio projects are considering migrating to an Antora-based reference manual as has already been done for Spring Security. Depending on the outcome of that effort, Spring Framework may also migrate to Antora-based docs. In light of that, I don't believe there are any plans to reintroduce a single-page HTML version of the reference manual.

vpavic commented 2 years ago

Hey @sbrannen, I'm aware of the initiative to move the portfolio to Antora-based docs but I didn't think of that as something that would happen anytime soon. I don't think there's a ticket tracking that effort in the Spring Framework.

In the mid-term, I thought it would be a reasonable compromise to reintroduce the single-page version.

Buzzardo commented 2 years ago

As @sbrannen says, we're moving toward Antora now. I'll close this issue.

vpavic commented 2 years ago

Is there an issue tracking the move to Antora based docs? Searching the project for antora returns only one hit and that's this issue.

rwinch commented 1 year ago

@vpavic You are right there wasn't an issue tracking it. I've created one here gh-29705