Skip to content

Inconsistency in the documentation of Spring DevTools setup #39488

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
yousoumar opened this issue Feb 9, 2024 · 4 comments
Closed

Inconsistency in the documentation of Spring DevTools setup #39488

yousoumar opened this issue Feb 9, 2024 · 4 comments
Labels
status: declined A suggestion or change that we don't feel we should currently apply

Comments

@yousoumar
Copy link

The Spring DevTools doc says in its most ranked page that the package should be included this way:

dependencies {
    compileOnly("org.springframework.boot:spring-boot-devtools")
}

Which does not work as discussed in #14451. And on this page it says it should be:

dependencies {
	compile("org.springframework.boot:spring-boot-devtools")
}

While the correct one seems to be what this page says::

dependencies {
    developmentOnly("org.springframework.boot:spring-boot-devtools")
}
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Feb 9, 2024
@wilkinsona
Copy link
Member

Thanks for the report. Unfortunately, we have very little control over search page rankings. We believe that our planned move to Antora-based documentation will help with this. Until then, please double-check that you're reading the documentation that matches the version of Spring Boot that you're using.

@wilkinsona wilkinsona closed this as not planned Won't fix, can't repro, duplicate, stale Feb 9, 2024
@wilkinsona wilkinsona added status: declined A suggestion or change that we don't feel we should currently apply and removed status: waiting-for-triage An issue we've not yet triaged labels Feb 9, 2024
@yousoumar
Copy link
Author

yousoumar commented Feb 9, 2024

Hi @wilkinsona ! I see. The tricky part is that the version is only mentioned in the URL, where not meany people look, and also, some browsers like Safari do not show the full URL by default.

@wilkinsona
Copy link
Member

Unfortunately, we can't change documentation that's already been released and published as it's built from an immutable tag in this repository. The move to Antora will help with showing the version number as well. See Spring Framework's documentation for example.

@yousoumar
Copy link
Author

Thanks for the answers, and for all the effort in making this awesome framework!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: declined A suggestion or change that we don't feel we should currently apply
Projects
None yet
Development

No branches or pull requests

3 participants