From a93d83a6a7e88632ce84d3bb6350ccbbbe1e6154 Mon Sep 17 00:00:00 2001 From: Ryan Baxter Date: Thu, 28 Feb 2019 11:03:28 -0500 Subject: [PATCH] Add note to documentation pointing people to Boot, WebFlux, and Reactor before working with Gateway. Fixes #813 --- docs/src/main/asciidoc/spring-cloud-gateway.adoc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/src/main/asciidoc/spring-cloud-gateway.adoc b/docs/src/main/asciidoc/spring-cloud-gateway.adoc index b3748d96..d319f13d 100644 --- a/docs/src/main/asciidoc/spring-cloud-gateway.adoc +++ b/docs/src/main/asciidoc/spring-cloud-gateway.adoc @@ -21,6 +21,14 @@ for details on setting up your build system with the current Spring Cloud Releas If you include the starter, but, for some reason, you do not want the gateway to be enabled, set `spring.cloud.gateway.enabled=false`. +IMPORTANT: Spring Cloud Gateway is built upon https://spring.io/projects/spring-boot#learn[Spring Boot 2.0], +https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html[Spring WebFlux], +and https://projectreactor.io/docs[Project Reactor]. As a consequence +many of the familiar synchronous libraries (Spring Data and Spring Security, for example) and patterns you may +not apply when using Spring Cloud Gateway. If you are unfamiliar with these projects we suggest you +begin by reading their documentation to familiarize yourself with some of the new concepts before +working with Spring Cloud Gateway. + IMPORTANT: Spring Cloud Gateway requires the Netty runtime provided by Spring Boot and Spring Webflux. It does not work in a traditional Servlet Container or built as a WAR. == Glossary