mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-07-15 01:07:30 +08:00
Clarified the naming scheme for starters
Initial update to the documentation to mention how a 3rd party starter should be named. The current doc sends a completely inconsistent message to what we actually intend. See gh-2537
This commit is contained in:
parent
fa0a2f39c5
commit
adaf175273
@ -205,11 +205,16 @@ running quickly and with a consistent, supported set of managed transitive depen
|
||||
|
||||
.What's in a name
|
||||
****
|
||||
All starters follow a similar naming pattern; `+spring-boot-starter-*+`, where `+*+` is
|
||||
a particular type of application. This naming structure is intended to help when you need
|
||||
to find a starter. The Maven integration in many IDEs allow you to search dependencies by
|
||||
name. For example, with the appropriate Eclipse or STS plugin installed, you can simply
|
||||
hit `ctrl-space` in the POM editor and type ''spring-boot-starter'' for a complete list.
|
||||
All **official** starters follow a similar naming pattern; `+spring-boot-starter-*+`,
|
||||
where `+*+` is a particular type of application. This naming structure is intended to
|
||||
help when you need to find a starter. The Maven integration in many IDEs allow you to
|
||||
search dependencies by name. For example, with the appropriate Eclipse or STS plugin
|
||||
installed, you can simply hit `ctrl-space` in the POM editor and type
|
||||
''spring-boot-starter'' for a complete list.
|
||||
|
||||
Third party starters should not start with `spring-boot-starter` as it is reserved for
|
||||
official starters. A third-party starter for `acme` will be typically named
|
||||
`acme-spring-boot-starter`.
|
||||
****
|
||||
|
||||
The following application starters are provided by Spring Boot under the
|
||||
|
@ -14,9 +14,20 @@ http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#us
|
||||
If you create a starter for a technology that is not already in the standard list we can
|
||||
list it here. Just send a pull request for this page.
|
||||
|
||||
WARNING: While the
|
||||
http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-starter-poms[reference documentation]
|
||||
mentions that 3rd party starters should not start with `spring-boot-starter`, some starters
|
||||
do as they were designed before this was clarified.
|
||||
|
||||
|===
|
||||
| Name | Location
|
||||
|
||||
| https://vaadin.com/[Vaadin]
|
||||
| https://github.com/vaadin/spring/tree/master/vaadin-spring-boot-starter
|
||||
|
||||
| http://camel.apache.org/spring-boot.html[Apache Camel]
|
||||
| https://github.com/apache/camel/tree/master/components/camel-spring-boot
|
||||
|
||||
| https://code.google.com/p/wro4j/[WRO4J]
|
||||
| https://github.com/sbuettner/spring-boot-autoconfigure-wro4j
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user