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

Improve consistency of documentation guidelines for packaging and running applications #40977

Closed
abelsromero opened this issue Jun 3, 2024 · 1 comment
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@abelsromero
Copy link
Contributor

It's not the best to run Spring Boot as JAR applications directly. However, the documentation is inconsistent in this message and depends on what page you land from a web search. I think it could be improved.

  • Dockerfiles is fine imo.
  • Cloud Native Buildpacks is vague is the improvements it provides, someone unfamiliar with the other page may assume that when the text says "Dockerfiles are just one way to build docker images", it means any Dockerfile is fine. No need to include all, but something could be added from the Dockerfiles page.
  • Packaging Your Application for Production says Executable jars can be used for production deployment which I think should be removed and the doc could include some info about how to extract the JAR. Also Running Your Application could get some disclaimers also.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 3, 2024
@sdeleuze
Copy link
Contributor

sdeleuze commented Jun 3, 2024

I think that's mainly Packaging Your Application for Production that could take advantage of links to https://docs.spring.io/spring-boot/reference/deployment/efficient.html#deployment.efficient.unpacking and related refinements.

@wilkinsona wilkinsona changed the title (docs) Consistent guidelines on running the unpacked Jar on production Consistent guidelines on running the unpacked jar in production Jun 3, 2024
@philwebb philwebb added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Jun 3, 2024
@philwebb philwebb added this to the 3.3.x milestone Jun 3, 2024
@scottfrederick scottfrederick added the for: team-meeting An issue we'd like to discuss as a team to make progress label Jun 3, 2024
@scottfrederick scottfrederick self-assigned this Jun 4, 2024
@scottfrederick scottfrederick removed the for: team-meeting An issue we'd like to discuss as a team to make progress label Jun 4, 2024
@scottfrederick scottfrederick changed the title Consistent guidelines on running the unpacked jar in production Improve consistency of documentation guidelines for packaging and running applications Jun 6, 2024
@scottfrederick scottfrederick modified the milestones: 3.3.x, 3.3.1 Jun 6, 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

No branches or pull requests

5 participants