From ac00df79f14486378f01343d99ff8ac78cc17292 Mon Sep 17 00:00:00 2001 From: Madhura Bhave Date: Mon, 20 Sep 2021 16:10:37 -0700 Subject: [PATCH] Add what's next to new sections This commit also moves hazelcast from core features to IO Closes gh-27132 --- .../src/docs/asciidoc/container-images.adoc | 2 ++ .../src/docs/asciidoc/container-images/whats-next.adoc | 5 +++++ .../spring-boot-docs/src/docs/asciidoc/data.adoc | 4 +++- .../src/docs/asciidoc/data/whats-next.adoc | 4 ++++ .../spring-boot-docs/src/docs/asciidoc/features.adoc | 2 -- .../spring-boot-docs/src/docs/asciidoc/io.adoc | 8 ++++++-- .../spring-boot-docs/src/docs/asciidoc/io/caching.adoc | 4 ++-- .../src/docs/asciidoc/io/{mail.adoc => email.adoc} | 0 .../src/docs/asciidoc/{features => io}/hazelcast.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/io/whats-next.adoc | 6 ++++++ .../spring-boot-docs/src/docs/asciidoc/messaging.adoc | 2 ++ .../src/docs/asciidoc/messaging/whats-next.adoc | 4 ++++ .../spring-boot-docs/src/docs/asciidoc/upgrading.adoc | 4 +++- .../src/docs/asciidoc/upgrading/whats-next.adoc | 5 +++++ .../spring-boot-docs/src/docs/asciidoc/web.adoc | 2 ++ .../src/docs/asciidoc/web/whats-next.adoc | 5 +++++ 16 files changed, 50 insertions(+), 9 deletions(-) create mode 100644 spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/whats-next.adoc create mode 100644 spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/whats-next.adoc rename spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/{mail.adoc => email.adoc} (100%) rename spring-boot-project/spring-boot-docs/src/docs/asciidoc/{features => io}/hazelcast.adoc (98%) create mode 100644 spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/whats-next.adoc create mode 100644 spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/whats-next.adoc create mode 100644 spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading/whats-next.adoc create mode 100644 spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/whats-next.adoc diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images.adoc index 04fe1a7801..651b15a4e7 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images.adoc @@ -9,3 +9,5 @@ include::container-images/efficient-images.adoc[] include::container-images/dockerfiles.adoc[] include::container-images/cloud-native-buildpacks.adoc[] + +include::container-images/whats-next.adoc[] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/whats-next.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/whats-next.adoc new file mode 100644 index 0000000000..9d0645f4a5 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/whats-next.adoc @@ -0,0 +1,5 @@ +[[container-images.whats-next]] +== What to Read Next +Once you've learned how to build efficient container images, you can read about <>, such as Kubernetes. + + diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data.adoc index b80aa7306d..0ff5e60b96 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data.adoc @@ -6,4 +6,6 @@ Spring Boot integrates with a number of data technologies, both SQL and NoSQL. include::data/sql.adoc[] -include::data/nosql.adoc[] \ No newline at end of file +include::data/nosql.adoc[] + +include::data/whats-next.adoc[] \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/whats-next.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/whats-next.adoc new file mode 100644 index 0000000000..ea4701dd2a --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/whats-next.adoc @@ -0,0 +1,4 @@ +[[data.whats-next]] +== What to Read Next +You should now have a feeling for how to use Spring Boot with various data technologies. +From here, you can read about Spring Boot's support for various <> and how to enable them in your application. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features.adoc index 6b26fa98c9..221f7e34b6 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features.adoc @@ -22,8 +22,6 @@ include::features/internationalization.adoc[] include::features/json.adoc[] -include::features/hazelcast.adoc[] - include::features/task-execution-and-scheduling.adoc[] include::features/testing.adoc[] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io.adoc index fe62790709..e96e715912 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io.adoc @@ -9,9 +9,11 @@ We'll also cover calling remote REST or SOAP services and sending email. include::io/caching.adoc[] +include::io/hazelcast.adoc[] + include::io/quartz.adoc[] -include::io/mail.adoc[] +include::io/email.adoc[] include::io/validation.adoc[] @@ -19,4 +21,6 @@ include::io/rest-client.adoc[] include::io/webservices.adoc[] -include::io/jta.adoc[] \ No newline at end of file +include::io/jta.adoc[] + +include::io/whats-next.adoc[] \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/caching.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/caching.adoc index 8239674132..70c23af5e1 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/caching.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/caching.adoc @@ -98,7 +98,7 @@ Even if the JSR-107 standard does not enforce a standardized way to define the l NOTE: When a cache library offers both a native implementation and JSR-107 support, Spring Boot prefers the JSR-107 support, so that the same features are available if you switch to a different JSR-107 implementation. -TIP: Spring Boot has <>. +TIP: Spring Boot has <>. If a single `HazelcastInstance` is available, it is automatically reused for the `CacheManager` as well, unless the configprop:spring.cache.jcache.config[] property is specified. There are two ways to customize the underlying `javax.cache.cacheManager`: @@ -130,7 +130,7 @@ An alternate configuration file can be provided as well, as shown in the followi [[io.caching.provider.hazelcast]] ==== Hazelcast -Spring Boot has <>. +Spring Boot has <>. If a `HazelcastInstance` has been auto-configured, it is automatically wrapped in a `CacheManager`. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/mail.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/email.adoc similarity index 100% rename from spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/mail.adoc rename to spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/email.adoc diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/hazelcast.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/hazelcast.adoc similarity index 98% rename from spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/hazelcast.adoc rename to spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/hazelcast.adoc index 67c53fe6a6..513153899a 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/hazelcast.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/hazelcast.adoc @@ -1,4 +1,4 @@ -[[features.hazelcast]] +[[io.hazelcast]] == Hazelcast If https://hazelcast.com/[Hazelcast] is on the classpath and a suitable configuration is found, Spring Boot auto-configures a `HazelcastInstance` that you can inject in your application. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/whats-next.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/whats-next.adoc new file mode 100644 index 0000000000..8c7ccefb26 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/whats-next.adoc @@ -0,0 +1,6 @@ +[[io.whats-next]] +== What to Read Next +You should now have a good understanding of Spring Boot's <> and the various technologies that Spring Boot provides support for via auto-configuration. + +The next few sections go into detail about deploying applications to cloud platforms. +You can read about <> in the next section or skip to the <> section. \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging.adoc index e5648eaed9..b4a17262ec 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging.adoc @@ -19,6 +19,8 @@ include::messaging/rsocket.adoc[] include::messaging/spring-integration.adoc[] +include::messaging/whats-next.adoc[] + diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/whats-next.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/whats-next.adoc new file mode 100644 index 0000000000..32bc01327e --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/whats-next.adoc @@ -0,0 +1,4 @@ +[[messaging.whats-next]] +== What to Read Next +The next section describes how to enable <> in your applicaiton. +You can read about <>, <>, <>, <> and more in this section. \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading.adoc index a7d72ccb79..305da05330 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading.adoc @@ -12,4 +12,6 @@ include::upgrading/from-1x.adoc[] include::upgrading/to-feature.adoc[] -include::upgrading/cli.adoc[] \ No newline at end of file +include::upgrading/cli.adoc[] + +include::upgrading/whats-next.adoc[] \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading/whats-next.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading/whats-next.adoc new file mode 100644 index 0000000000..5f377b9341 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading/whats-next.adoc @@ -0,0 +1,5 @@ +[[upgrading.whats-next]] +== What to Read Next +Once you've decided to upgrade your application, you can find detailed information regarding specific features in the rest of the document. + +Spring Boot's documentation is specific to that version, so any information that you find in here will contain the most up-to-date changes that are in that version. \ No newline at end of file diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web.adoc index 07944f56e7..dc98318881 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web.adoc @@ -20,3 +20,5 @@ include::web/spring-security.adoc[] include::web/spring-session.adoc[] include::web/spring-hateoas.adoc[] + +include::web/whats-next.adoc[] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/whats-next.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/whats-next.adoc new file mode 100644 index 0000000000..94ddb16080 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/whats-next.adoc @@ -0,0 +1,5 @@ +[[web.whats-next]] +== What to Read Next +You should now have a good understanding of how to develop web applications with Spring Boot. +The next few sections describe how Spring Boot integrates with various <>, <>, and other IO capabilities. +You can pick any of these based on your application's needs.