From 6b15aac5b4a0006579c552db8321de7442ba88c8 Mon Sep 17 00:00:00 2001
From: Harpal <harpal.singh@kaleyra.com>
Date: Wed, 15 Dec 2021 16:44:12 +0100
Subject: [PATCH] Documentation improvement

Fixes gh-2463
---
 .../main/asciidoc/spring-cloud-gateway.adoc   | 28 +++++++++----------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/docs/src/main/asciidoc/spring-cloud-gateway.adoc b/docs/src/main/asciidoc/spring-cloud-gateway.adoc
index eee1fd10..4cc84917 100644
--- a/docs/src/main/asciidoc/spring-cloud-gateway.adoc
+++ b/docs/src/main/asciidoc/spring-cloud-gateway.adoc
@@ -15,7 +15,7 @@ If you include the starter, but you do not want the gateway to be enabled, set `
 
 IMPORTANT: Spring Cloud Gateway is built on https://spring.io/projects/spring-boot#learn[Spring Boot 2.x], 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 know may not apply when you use 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.
+If you are unfamiliar with these projects, we suggest you begin by reading their documentation to familiarize yourself with some 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 when built as a WAR.
@@ -808,8 +808,8 @@ You can find more information on doing so in  the <<fallback-headers, FallbackHe
 
 In some cases you might want to trip a circuit breaker based on the status code
 returned from the route it wraps.  The circuit breaker config object takes a list of
-status codes that if returned will cause the the circuit breaker to be tripped.  When setting the
-status codes you want to trip the circuit breaker you can either use a integer with the status code
+status codes that if returned will cause the circuit breaker to be tripped.  When setting the
+status codes you want to trip the circuit breaker you can either use an integer with the status code
 value or the String representation of the `HttpStatus` enumeration.
 
 .application.yml
@@ -1620,7 +1620,7 @@ You must use `$\` to mean `$` because of the YAML specification.
 === The `SaveSession` `GatewayFilter` Factory
 
 The `SaveSession` `GatewayFilter` factory forces a `WebSession::save` operation _before_ forwarding the call downstream.
-This is of particular use when using something like https://projects.spring.io/spring-session/[Spring Session] with a lazy data store and you need to ensure the session state has been saved before making the forwarded call.
+This is of particular use when using something like https://projects.spring.io/spring-session/[Spring Session] with a lazy data store, and you need to ensure the session state has been saved before making the forwarded call.
 The following example configures a `SaveSession` `GatewayFilter`:
 
 .application.yml
@@ -1729,7 +1729,7 @@ spring:
 ====
 
 This `GatewayFilter` replaces (rather than adding) all headers with the given name.
-So, if the downstream server responded with a `X-Request-Red:1234`, this would be replaced with `X-Request-Red:Blue`, which is what the downstream service would receive.
+So, if the downstream server responded with `X-Request-Red:1234`, it will be replaced with `X-Request-Red:Blue`, which is what the downstream service would receive.
 
 `SetRequestHeader` is aware of URI variables used to match a path or host.
 URI variables may be used in the value and are expanded at runtime.
@@ -1773,7 +1773,7 @@ spring:
 ====
 
 This GatewayFilter replaces (rather than adding) all headers with the given name.
-So, if the downstream server responded with a `X-Response-Red:1234`, this is replaced with `X-Response-Red:Blue`, which is what the gateway client would receive.
+So, if the downstream server responded with `X-Response-Red:1234`, it will be replaced with `X-Response-Red:Blue`, which is what the gateway client would receive.
 
 `SetResponseHeader` is aware of URI variables used to match a path or host.
 URI variables may be used in the value and will be expanded at runtime.
@@ -1876,7 +1876,7 @@ The `Retry` `GatewayFilter` factory supports the following parameters:
 * `backoff`: The configured exponential backoff for the retries.
 Retries are performed after a backoff interval of `firstBackoff * (factor ^ n)`, where `n` is the iteration.
 If `maxBackoff` is configured, the maximum backoff applied is limited to `maxBackoff`.
-If `basedOnPreviousValue` is true, the backoff is calculated byusing `prevBackoff * factor`.
+If `basedOnPreviousValue` is true, the backoff is calculated by using `prevBackoff * factor`.
 
 The following defaults are configured for `Retry` filter, if enabled:
 
@@ -1918,7 +1918,7 @@ NOTE: When using the retry filter with a `forward:` prefixed URL, the target end
 For example, if the target endpoint is an annotated controller, the target controller method should not return `ResponseEntity` with an error status code.
 Instead, it should throw an `Exception` or signal an error (for example, through a `Mono.error(ex)` return value), which the retry filter can be configured to handle by retrying.
 
-WARNING: When using the retry filter with any HTTP method with a body, the body will be cached and the gateway will become memory constrained. The body is cached in a request attribute defined by `ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR`. The type of the object is a `org.springframework.core.io.buffer.DataBuffer`.
+WARNING: When using the retry filter with any HTTP method with a body, the body will be cached and the gateway will become memory constrained. The body is cached in a request attribute defined by `ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR`. The type of the object is `org.springframework.core.io.buffer.DataBuffer`.
 
 A simplified "shortcut" notation can be added with a single `status` and `method`.
 
@@ -1993,7 +1993,7 @@ NOTE: The default request size is set to five MB if not provided as a filter arg
 
 === The `SetRequestHostHeader` `GatewayFilter` Factory
 
-There are certain situation when the host header may need to be overridden. In this situation, the `SetRequestHostHeader` `GatewayFilter` factory can replace the existing host header with a specified vaue.
+There are certain situation when the host header may need to be overridden. In this situation, the `SetRequestHostHeader` `GatewayFilter` factory can replace the existing host header with a specified value.
 The filter takes a `host` parameter.
 The following listing configures a `SetRequestHostHeader` `GatewayFilter`:
 
@@ -2287,7 +2287,7 @@ or check if an exchange has already been routed.
 
 == HttpHeadersFilters
 
-HttpHeadersFilters are applied to requests before sending them downstream, such as in the `NettyRoutingFilter`.
+`HttpHeadersFilters` are applied to the requests before sending them downstream, such as in the `NettyRoutingFilter`.
 
 === Forwarded Headers Filter
 The `Forwarded` Headers Filter creates a `Forwarded` header to send to the downstream service. It adds the `Host` header, scheme and port of the current request to any existing `Forwarded` header.
@@ -2308,7 +2308,7 @@ The `RemoveHopByHop` Headers Filter removes headers from forwarded requests. The
 To change this, set the `spring.cloud.gateway.filter.remove-hop-by-hop.headers` property to the list of header names to remove.
 
 === XForwarded Headers Filter
-The `XForwarded` Headers Filter creates various a `X-Forwarded-*` headers to send to the downstream service. It users the `Host` header, scheme, port and path of the current request to create the various headers.
+The `XForwarded` Headers Filter creates various `X-Forwarded-*` headers to send to the downstream service. It uses the `Host` header, scheme, port and path of the current request to create the various headers.
 
 Creating of individual headers can be controlled by the following boolean properties (defaults to true):
 
@@ -2805,7 +2805,7 @@ To retrieve the <<global-filters,global filters>> applied to all routes, make a
 ====
 
 The response contains the details of the global filters that are in place.
-For each global filter, there is a string representation of the filter object (for example, `org.springframework.cloud.gateway.filter.ReactiveLoadBalancerClientFilter@77856cc5`) and the corresponding <<gateway-combined-global-filter-and-gatewayfilter-ordering,order>> in the filter chain.}
+For each global filter, there is a string representation of the filter object (for example, `org.springframework.cloud.gateway.filter.ReactiveLoadBalancerClientFilter@77856cc5`) and the corresponding <<gateway-combined-global-filter-and-gatewayfilter-ordering,order>> in the filter chain.
 
 [[gateway-route-filters]]
 ==== Route Filters
@@ -2941,7 +2941,7 @@ To delete a route, make a `DELETE` request to `/gateway/routes/{id_route_to_dele
 
 === Recap: The List of All endpoints
 
-The folloiwng table below summarizes the Spring Cloud Gateway actuator endpoints (note that each endpoint has `/actuator/gateway` as the base-path):
+The following table below summarizes the Spring Cloud Gateway actuator endpoints (note that each endpoint has `/actuator/gateway` as the base-path):
 
 [cols="2,2,5"]
 |===
@@ -3128,7 +3128,7 @@ name to be compliant.
 To write a custom global filter, you must implement `GlobalFilter` interface as a bean.
 This applies the filter to all requests.
 
-The following examples show how to set up global pre and post filters, respectively:
+The following examples show how to set up global pre- and post-filters, respectively:
 
 ====
 [source,java]