spring-io / start.spring.io

https://start.spring.io
Apache License 2.0
2.22k stars 905 forks source link

HELP.md contains broken links to the Maven and Gradle plugin reference docs #1529

Closed victorgawk closed 2 months ago

victorgawk commented 2 months ago

When generating code from Spring initializr using project Gradle - Groovy, language Java and version 3.3.1, inside HELP.md file there is two invalid URLs resulting in 404 Not Found error:

Error when opening these links in Google Chrome: image

Code generation example: https://start.spring.io/#!type=gradle-project&language=java&platformVersion=3.3.1&packaging=jar&jvmVersion=21&groupId=com.example&artifactId=demo&name=demo&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.demo&dependencies=

wilkinsona commented 2 months ago

There's a similar problem with Maven builds where the HELP.md contains the following links:

rishiraj88 commented 2 months ago

@wilkinsona , @victorgawk ,

3 days back I cloned the spring-boot repo to my Windows workstation, but some filenames (filepaths) were too long for the OS to handle and clone those files.

I will try to clone relevant repositories with my Ubuntu VM this Friday evening.

Let's see if the main issue may be resolved quickly.

However, this was my observation over the issue at high level: Updated link for Gradle plugin documentation notes is this.

wilkinsona commented 2 months ago

@rishiraj88 this issue doesn't require changes to Spring Boot. It should be fixed by making changes in this repository. That said, in case you need to clone the Spring Boot repo in the future, please see https://github.com/spring-projects/spring-boot/wiki/Working-with-the-Code#cloning-the-git-repository-on-windows.

philwebb commented 2 months ago

The correct URLs are https://docs.spring.io/spring-boot/maven-plugin/index.html and https://docs.spring.io/spring-boot/gradle-plugin/index.html. We should fix the redirects.

mhalbritter commented 2 months ago

Superseded by https://github.com/spring-io/start.spring.io/pull/1541.