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

HELP.md contains broken links to reference docs #1541

Closed
wants to merge 2 commits into from
Closed

HELP.md contains broken links to reference docs #1541

wants to merge 2 commits into from

Conversation

ngocnhan-tran1996
Copy link
Contributor

I update reference links in HELP.md. Please tell me if I miss something

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jul 27, 2024
@mhalbritter mhalbritter self-assigned this Jul 29, 2024
@mhalbritter mhalbritter added type: bug and removed status: waiting-for-triage An issue we've not yet triaged labels Jul 29, 2024
@mhalbritter mhalbritter changed the title Update reference links in HELP.md HELP.md contains broken links to reference docs Jul 29, 2024
mhalbritter pushed a commit that referenced this pull request Jul 29, 2024
mhalbritter added a commit that referenced this pull request Jul 29, 2024
@mhalbritter
Copy link
Contributor

Thank you very much and congratulations on your first contribution 🎉!

@ngocnhan-tran1996
Copy link
Contributor Author

@mhalbritter

Thanks for your review.

I also find some old link in application.yml. Is there any way to add new item with same id or it will be changed when Spring 3.2.x goes to End of Support?

- name: Web
content:
- name: Spring Web
id: web
description: Build web, including RESTful, applications using Spring MVC. Uses Apache Tomcat as the default embedded container.
facets:
- web
- json
links:
- rel: guide
href: https://spring.io/guides/gs/rest-service/
description: Building a RESTful Web Service
- rel: reference
href: https://docs.spring.io/spring-boot/docs/{bootVersion}/reference/htmlsingle/index.html#web
- rel: guide
href: https://spring.io/guides/gs/serving-web-content/
description: Serving Web Content with Spring MVC
- rel: guide
href: https://spring.io/guides/tutorials/rest/
description: Building REST services with Spring

@mhalbritter
Copy link
Contributor

I have to look into this. FYI: When spring-projects/spring-boot#41632 is resolved, this won't be a problem.

@mhalbritter
Copy link
Contributor

It's possible by using a custom HelpDocumentCustomizer, but there are a lot of such links in the application.yaml. I don't think it's worth the time to fix all of them for 3.2.x and 3.3.x. I hope spring-projects/spring-boot#41632 resolves soon, which solves that problem at a central place.

And when 3.4.x is released in November, 3.2.x will drop out of OSS support, and then we can remove the remaining ifs in the code.

@ngocnhan-tran1996
Copy link
Contributor Author

Thanks for your information. But I think Link.java need to be improved for multiple version document, add field comparisonRange for this purpose or something like that?

@mhalbritter
Copy link
Contributor

Yeah, if we would like to specify the version range for links in the metadata YAML. But as I said, I'd not go down that route and instead wait for Spring Boot to fix the redirects.

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

Successfully merging this pull request may close these issues.

3 participants