Skip to content

Improve the documentation of the starters #5267

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

Closed
wilkinsona opened this issue Feb 27, 2016 · 3 comments
Closed

Improve the documentation of the starters #5267

wilkinsona opened this issue Feb 27, 2016 · 3 comments
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@wilkinsona
Copy link
Member

Via some feedback from @dcoxall, we could do a better job of documenting the starters. I think we're guilty of assuming that people will look in the poms to figure out what each starter does.

A couple of ideas to improve the documentation:

  • List each starter with a description of what it contains and when you'd use it
  • Add an opinionated section that says if you are building X then you should use starter Y
@dcoxall
Copy link

dcoxall commented Feb 27, 2016

👍 This would be incredibly helpful!

@wilkinsona wilkinsona added the type: documentation A documentation update label Feb 27, 2016
@wilkinsona wilkinsona added this to the 1.4.0.M2 milestone Feb 27, 2016
@wilkinsona wilkinsona self-assigned this Feb 27, 2016
@snicoll
Copy link
Member

snicoll commented Feb 29, 2016

I wonder if we couldn't do something about that on start.spring.io as well.

@wilkinsona
Copy link
Member Author

I wonder if we couldn't do something about that on start.spring.io as well

+1

@wilkinsona wilkinsona reopened this Mar 30, 2016
wilkinsona added a commit that referenced this issue Apr 11, 2016
The instructions should have been updated as part of the work on
gh-5267 so that the zip of all of the starter poms is available to
the documentation's build. With that fixed, the current instructions
still fail as the javadoc fails to generated as a result of
org.springframework.boot:spring-boot:test-jar:tests being unavailable.
This can be avoid by simply not trying to build the javadoc, i.e.
by running generate-resources rather than install.

Closes gh-5633
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

3 participants