Skip to content
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

guide does not work - missing link refs? #55

Closed
FerretDave opened this issue Jan 9, 2024 · 1 comment
Closed

guide does not work - missing link refs? #55

FerretDave opened this issue Jan 9, 2024 · 1 comment

Comments

@FerretDave
Copy link

The guide at https://github.com/spring-guides/gs-serving-web-content
doesnt seem to pull in the info for the 'what you need' section, nor the code example in 'Create a web controller', this shows:
link:complete/src/main/resources/templates/greeting.html[]
and the 'run the application' code link also just shows the link:
link:complete/src/main/java/com/example/servingwebcontent/ServingWebContentApplication.java[]

Followed by links to 'getting-started' sections that perhaps should be displayed rather than just linked?
code sample from 'add a home page' also just shows a link.

Compared to the guide at: https://spring.io/guides/gs/serving-web-content/
which does show the relevant sections.

Lastly - the 'pre-initialised project' link needs updating, as the start.spring.io page warns:
The following attributes could not be handled:
11 is not a valid Java version, 17 has been selected.

@robertmcnees
Copy link
Contributor

Hi @FerretDave. You are correct that GitHub's support for Asciidoc's include functionality does not render when viewing on GitHub. We render the included files before publishing on spring.io/guides, so that is why you see a difference in GitHub vs spring.io. It does make the documentation difficult to read when you land directly on the GitHub page.

The main reason behind the difference is security and is explained in a few GitHub issues. It's a complex discussion and the resolution is out of our hands.

There are a few things we could do and I created this issue in the repository that is the template for all spring-guides. Since the issue about include files not rendering is relevant to all of our guides, I think it's better to have the discussion at a higher level. Feel free to comment on that issue if you'd like.

Your point about the pre-initialized project link is valid. A lot of the links had the Java version specified in the URL, which is difficult to maintain and often overlooked. The solution is to simply remove the parameter &jvmVersion=11 so that start.spring.io defaults to the latest Java version available. This URL should be updated soon.

I'll close this issue as I think the main point can be tracked in the parent issue here.

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

No branches or pull requests

2 participants