Skip to content

Commit adaf175

Browse files
committed
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 spring-projectsgh-2537
1 parent fa0a2f3 commit adaf175

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc

+10-5
Original file line numberDiff line numberDiff line change
@@ -205,11 +205,16 @@ running quickly and with a consistent, supported set of managed transitive depen
205205

206206
.What's in a name
207207
****
208-
All starters follow a similar naming pattern; `+spring-boot-starter-*+`, where `+*+` is
209-
a particular type of application. This naming structure is intended to help when you need
210-
to find a starter. The Maven integration in many IDEs allow you to search dependencies by
211-
name. For example, with the appropriate Eclipse or STS plugin installed, you can simply
212-
hit `ctrl-space` in the POM editor and type ''spring-boot-starter'' for a complete list.
208+
All **official** starters follow a similar naming pattern; `+spring-boot-starter-*+`,
209+
where `+*+` is a particular type of application. This naming structure is intended to
210+
help when you need to find a starter. The Maven integration in many IDEs allow you to
211+
search dependencies by name. For example, with the appropriate Eclipse or STS plugin
212+
installed, you can simply hit `ctrl-space` in the POM editor and type
213+
''spring-boot-starter'' for a complete list.
214+
215+
Third party starters should not start with `spring-boot-starter` as it is reserved for
216+
official starters. A third-party starter for `acme` will be typically named
217+
`acme-spring-boot-starter`.
213218
****
214219

215220
The following application starters are provided by Spring Boot under the

spring-boot-starters/README.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,20 @@ http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#us
1414
If you create a starter for a technology that is not already in the standard list we can
1515
list it here. Just send a pull request for this page.
1616

17+
WARNING: While the
18+
http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#using-boot-starter-poms[reference documentation]
19+
mentions that 3rd party starters should not start with `spring-boot-starter`, some starters
20+
do as they were designed before this was clarified.
21+
1722
|===
1823
| Name | Location
1924

25+
| https://vaadin.com/[Vaadin]
26+
| https://github.com/vaadin/spring/tree/master/vaadin-spring-boot-starter
27+
28+
| http://camel.apache.org/spring-boot.html[Apache Camel]
29+
| https://github.com/apache/camel/tree/master/components/camel-spring-boot
30+
2031
| https://code.google.com/p/wro4j/[WRO4J]
2132
| https://github.com/sbuettner/spring-boot-autoconfigure-wro4j
2233

0 commit comments

Comments
 (0)