1025 Commits

Author SHA1 Message Date
Andy Wilkinson
1c6f2af475 Clarify how to configure a Filter's order
Closes gh-18266
2019-11-05 10:06:17 +00:00
Andy Wilkinson
987a5f8103 Recommend overriding licences and developers when using starter parent
Publishing to Maven Central requires spring-boot-starter-parent to
declare its license and developers. When a user then uses
spring-boot-starter-parent as their project's parent, these values
are inherited and this is almost certainly unwanted.

This commit updates the documentation to recommend and demonstrate
overriding the license and developers that are inherited from the
starter parent.

Closes gh-18532
2019-11-05 09:39:59 +00:00
Andy Wilkinson
89e050d722 Document security risks of DevTools' remote support more clearly
Previously, the security risks and our recommendations on how to
mitigate them were not documented as clearly as they could have been.
This commit makes some changes to try to address this:

1. The security risk is now noted at the beginning of the section
2. The recommendation to use SSL is now documented more prominently
   and an alternative recommendation to only use remote support on
   a trusted network has been added.
3. The example secret has been removed to prevent copy and paste
4. A recommendation to use a secret that is unique and strong has been
   added

Closes gh-18825
2019-11-05 09:22:39 +00:00
Stephane Nicoll
5863a75c3c Polish "Document Settings as jooq supported auto-configuration type"
See gh-18870
2019-11-05 09:18:32 +01:00
Jens Teglhus Møller
c34516cd9e Document Settings as jooq supported auto-configuration type
See gh-18870
2019-11-05 09:17:25 +01:00
wwjay9
bd77c170f2 Fix OAuth2 Client redirect-uri references
See gh-18752
2019-10-27 08:42:48 +01:00
Madhura Bhave
593eca7998 Emphasize need for quotes around YAML bracket notation
Closes gh-18690
2019-10-24 17:00:54 -07:00
Madhura Bhave
e59a643e20 Emphasize the need of @Valid on nested configuration properties
Closes gh-18198
2019-10-24 16:02:59 -07:00
Andy Wilkinson
d4cd03ebd8 Document need for micrometer-jersey2 dependency to get Jersey metrics
Closes gh-18622
2019-10-24 10:46:18 +01:00
nkjackzhang
6ef39d6b91 Fix typos
See gh-18705
2019-10-23 18:16:24 +02:00
Brian Clozel
e4fa9ce8c6 Deprecate server.connection-timeout property
Prior to this commit, all supported servers would share the same
configuration property `server.connection-timeout`. Unfortunately, in
many cases the behavior of this timeout changes depending on the server.
From actual connection setup timeout, to detecting and closing idle
connections, this property cannot be properly translated from one server
implementation to another.

This commit deprecates this configuration property and introduces server
specific properties:

* `server.jetty.connection-idle-timeout`
(Time that the connection can be idle before it is closed.)
* `server.netty.connection-timeout`
(Connection timeout of the Netty channel.)
* `server.tomcat.connection-timeout`
(Amount of time the connector will wait, after accepting a connection,
for the request URI line to be presented.)
* `server.undertow.no-request-timeout`
(Amount of time a connection can sit idle without processing a request,
before it is closed by the server.)

`server.connection-timeout` is now deprecated and will be removed in a
future release.

Fixes gh-18473
2019-10-16 13:48:48 +02:00
Stephane Nicoll
22f44917ca Polish "Add metadata entry for spring.main.register-shutdown-hook"
See gh-18581
2019-10-15 08:41:07 +02:00
leoli
9b781449cf Add metadata entry for spring.main.register-shutdown-hook
See gh-18581
2019-10-15 08:37:08 +02:00
Stephane Nicoll
f05d7902e2 Polish "Clarify formatting recommendations for configuration property javadoc"
See gh-18578
2019-10-15 08:32:48 +02:00
Rafiullah Hamedy
1f9b68707f Clarify formatting recommendations for configuration property javadoc
This commit adds a note to spring-boot-features.adoc to clarify that
using javadoc tags to format configuration property descriptions is not
supported.

See gh-18578
2019-10-15 08:29:51 +02:00
Ted M. Young
f553784ebc Fix incorrect backslash escape in documentation sample
See gh-18546
2019-10-13 08:10:14 +02:00
Johnny Lim
3a63179d81 Fix a broken Asciidoctor syntax
Along the way, this commit also fixes a typo.

Closes gh-18325
2019-10-01 18:32:01 +02:00
dreis2211
208fb8f1ef Add Mustache to 'Customize ViewResolvers' docs section
See gh-18378
2019-09-29 16:21:49 +02:00
Johnny Lim
7319908b40 Polish
See gh-18347
2019-09-27 16:57:09 +02:00
leoli
09cf1e6791 Fix property name in "Task Execution and Scheduling" example
See gh-18331
2019-09-24 09:16:17 +02:00
Alessandro Falappa
b1750defde Fix typo in configuration metadata appendix
See gh-18289

Closes gh-18289
2019-09-21 13:28:43 +01:00
Madhura Bhave
3c4449bf0e Polish "Fix typo in logback example"
See gh-18295
2019-09-20 14:38:57 -07:00
Harald Brabenetz
0091c04720 Fix typo in logback example
See gh-18295
2019-09-20 14:36:01 -07:00
Madhura Bhave
f9d94c6ed0 Remove duplicate word in docs 2019-09-19 16:30:25 -07:00
Alessandro Falappa
6dab9bb224 Fix pre-defined logging group documentation
See gh-18270
2019-09-19 09:19:24 +02:00
Peter Sauer
dba18ce778 Fix minor typo
The phrase `We have you covered.` is a sentence and so it should start
with a capital `W`.

See gh-18216
2019-09-13 09:05:54 +02:00
Andy Wilkinson
4f21b51a2b Polish one sentence per line in the reference docs 2019-09-09 14:00:12 +01:00
Andy Wilkinson
8882c532cd Correct attribute references in reference documentation
Fixes gh-18163
2019-09-06 12:45:35 +01:00
Phillip Webb
a3cde7fd8d Fix typo 2019-09-04 22:20:14 -07:00
Phillip Webb
a0a204ae6a Clarify devtools trigger file documentation
Closes gh-17775
2019-09-04 22:09:33 -07:00
Phillip Webb
f1bbb2a017 Fix documentation typos
See gh-16718
2019-09-04 13:52:10 -07:00
Andy Wilkinson
7f62c5a283 Provide a How-To for customizing Reactor Netty's TcpClient
Closes gh-17856
2019-09-04 09:49:56 +01:00
Phillip Webb
624c118cdf Polish "Document the pros and cons of MockMvc"
See gh-16718
2019-09-03 21:03:46 -07:00
Tetsuya Hasegawa
8f8a4af001 Document the pros and cons of MockMvc
Update the MockMvc documentation to provide more details about the
pros and cons of such an approach, specifically calling out the
difference with error page handling.

See gh-16718
2019-09-03 21:01:44 -07:00
Phillip Webb
158e25c00f Extend documentation on logback include files
Expand the Logback "How To" to provide further clarifications on
the different include files available.

See gh-16901
2019-09-03 18:18:09 -07:00
michal
1f97a60d16 Clarify documentation on logback include files
Update documentation and comments on Logback to show the correct
use of `default.xml` rather than `base.xml`.

See gh-16901
2019-09-03 18:15:59 -07:00
Phillip Webb
e07889b092 Document that Filter beans are eagerly initialized
Closes gh-17814
2019-08-31 08:41:34 -07:00
Phillip Webb
7e60f4b32a Clarify "YAML Shortcomings" documentation
Closes gh-17933
2019-08-31 08:29:03 -07:00
Phillip Webb
ffbd11caba Document logger environment variable restrictions
Update the reference guide with a note about using environment variables
to configure logging.

Closes gh-17958
2019-08-31 07:43:42 -07:00
Phillip Webb
6ca92418b5 Document need to exactly JPA property names
Closes gh-17975
2019-08-30 21:56:18 -07:00
Phillip Webb
e4dfb74629 Polish 2019-08-30 21:29:54 -07:00
Phillip Webb
1ff784ff54 Remove MBean shutdown warning from documentation
Closes gh-17988
2019-08-30 21:27:51 -07:00
Phillip Webb
368eb566fb Use versioned links in documentation
Update the reference documentation to use versioned links rather then
`/current/` whenever possible.

Closes gh-18000
2019-08-30 21:19:33 -07:00
Phillip Webb
348d65b4fe Polish documentation 2019-08-30 19:13:12 -07:00
Phillip Webb
7f9d143e01 Polish documentation
Update reference documentation source to use consistent attribute names
and fix a few formatting issues.
2019-08-30 17:11:14 -07:00
Phillip Webb
572e491465 Remove Gemfire starter details from documentation
Closes gh-18002
2019-08-30 14:57:17 -07:00
Phillip Webb
dbccb705a8 Clarify "Web Application Conditions" documentation
Update the reference documentation so that "Web Application Conditions"
also covers reactive contexts.

Closes gh-18005
2019-08-30 14:52:27 -07:00
dreis2211
b6fff67f6e Remove reference to non-existent --edit option in CLI docs
See gh-18015
2019-08-30 09:52:24 +01:00
Phillip Webb
64d4bf823a Reformat documentation to one sentence per line
Update reference documentation to use one sentence per line formatting
as recommended by the Asciidoctor team.

Closes gh-12445
2019-08-29 14:58:48 -07:00
leoli
34d28f48ca Fix Undertow access log dir property name in doc
See gh-17968
2019-08-27 11:06:16 +02:00