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

Remove stale link to jar-to-war getting started guide #42691

Closed
wants to merge 3 commits into from

Conversation

IMWoo94
Copy link
Contributor

@IMWoo94 IMWoo94 commented Oct 15, 2024

Version : Spring Boot 3.3.4 Reference Doc.

Changed the Not Found link provided in the Reference Doc to a link covering the Build Plugin.

The reference Doc already provides a direct content to Jar and War. I think it would create better synergy if you provided a link to the Build Tool rather than providing a removed guide.

Reference Doc : https://docs.spring.io/spring-boot/how-to/deployment/traditional-deployment.html#howto.traditional-deployment.convert-existing-application

Not Found Link : Getting Started Guide on Converting a jar to a war.

Suggest Link : Build Tool Plugins

스크린샷 2024-10-15 오후 8 41 11

Spring Boot 3.3.4 Reference Doc.

Changed the Not Found link provided in the Reference Doc to a link covering the Build Plugin.

Reference Doc : https://docs.spring.io/spring-boot/how-to/deployment/traditional-deployment.html#howto.traditional-deployment.convert-existing-application

Not Found Link : Getting Started Guide on Converting a jar to a war. ( https://spring.io/guides/gs/convert-jar-to-war/ )
@pivotal-cla
Copy link

@IMWoo94 Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 15, 2024
@pivotal-cla
Copy link

@IMWoo94 Thank you for signing the Contributor License Agreement!

@snicoll
Copy link
Member

snicoll commented Oct 15, 2024

Thanks for the PR.

The guide has been dropped so this looks like an oversight, see #42110

@IMWoo94
Copy link
Contributor Author

IMWoo94 commented Oct 15, 2024

Thank you for finding the issue

The current PR provides a new link, but can I delete it and rewrite it with the code that's been removed?

@philwebb
Copy link
Member

Thanks for the PR. I don't think we should reproduce the code from the old guide, but we should update the link when we merge this. It should be xref:build-tool-plugin:index.adoc[]

@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Oct 15, 2024
@philwebb philwebb modified the milestones: 3.3.x, 3.2.x Oct 15, 2024
@philwebb philwebb added the for: merge-with-amendments Needs some changes when we merge label Oct 15, 2024
@IMWoo94
Copy link
Contributor Author

IMWoo94 commented Oct 15, 2024

Update can be carried out in two ways.

1. "See the Getting Started Guide on Converting a jar to a war." comment delete
스크린샷 2024-10-16 오전 7 20 19


2. Modify links using xref:build-tool-plugin:index.adoc[]
스크린샷 2024-10-16 오전 7 19 16


#42110 and the comments
Number 2 provides the same link using xref:build-tool-plugin:index.adoc[] at the top.
This is overlapping, and I think option 2 is ambiguous because it is located not far away.

I think option 1 is correct so current PR option 1 apply.
Which of the two options do you think is more correct?

Spring Boot 3.3.4 Reference Doc.

Not Found link(See the Getting Started Guide on Converting a jar to a war.) remove in the Reference Doc
@philwebb
Copy link
Member

Thanks @IMWoo94

@wilkinsona wilkinsona changed the title Similar guide links related to not found guide links Remove stale link to jar-to-war getting starter guide Oct 17, 2024
@wilkinsona wilkinsona changed the title Remove stale link to jar-to-war getting starter guide Remove stale link to jar-to-war getting started guide Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants