From b59b9f651ef207b30513dee1ff3fb43728ec6776 Mon Sep 17 00:00:00 2001 From: sgibb Date: Mon, 11 Sep 2023 16:12:20 -0400 Subject: [PATCH] Enable Section Summary TOC for small pages --- docs/modules/ROOT/pages/appendix.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-gateway.adoc | 1 + .../pages/spring-cloud-gateway/aot-and-native-image-support.adoc | 1 + .../pages/spring-cloud-gateway/configuration-properties.adoc | 1 + .../ROOT/pages/spring-cloud-gateway/gatewayfilter-factories.adoc | 1 + .../gatewayfilter-factories/default-filters.adoc | 1 + .../gatewayfilter-factories/the-prefixpath-factory.adoc | 1 + .../gatewayfilter-factories/the-preservehostheader-factory.adoc | 1 + .../gatewayfilter-factories/the-removerequestheader-factory.adoc | 1 + .../the-removerequestparameter-factory.adoc | 1 + .../gatewayfilter-factories/the-requestheadersize-factory.adoc | 1 + .../the-rewriteresponseheader-factory.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-gateway/glossary.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-gateway/how-it-works.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-gateway/starter.adoc | 1 + .../modules/ROOT/pages/spring-cloud-gateway/troubleshooting.adoc | 1 + 16 files changed, 16 insertions(+) diff --git a/docs/modules/ROOT/pages/appendix.adoc b/docs/modules/ROOT/pages/appendix.adoc index 75d477a9..b37f8ec1 100644 --- a/docs/modules/ROOT/pages/appendix.adoc +++ b/docs/modules/ROOT/pages/appendix.adoc @@ -2,6 +2,7 @@ [appendix] [[common-application-properties]] = Common application properties +:page-section-summary-toc: 1 Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway.adoc index 3657f62b..a9c6a23c 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway.adoc @@ -1,5 +1,6 @@ [[spring-cloud-gateway]] = Spring Cloud Gateway +:page-section-summary-toc: 1 *{spring-cloud-version}* diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/aot-and-native-image-support.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/aot-and-native-image-support.adoc index 5663a22e..c7d01c71 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/aot-and-native-image-support.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/aot-and-native-image-support.adoc @@ -1,5 +1,6 @@ [[aot-and-native-image-support]] = AOT and Native Image Support +:page-section-summary-toc: 1 Since `4.0.0`, Spring Cloud Gateway supports Spring AOT transformations and native images. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/configuration-properties.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/configuration-properties.adoc index d8f06ccb..1aed5173 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/configuration-properties.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/configuration-properties.adoc @@ -1,4 +1,5 @@ [[configuration-properties]] = Configuration properties +:page-section-summary-toc: 1 To see the list of all Spring Cloud Gateway related configuration properties, see link:appendix.html[the appendix]. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories.adoc index c1664116..76c6951f 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories.adoc @@ -1,5 +1,6 @@ [[gatewayfilter-factories]] = `GatewayFilter` Factories +:page-section-summary-toc: 1 Route filters allow the modification of the incoming HTTP request or outgoing HTTP response in some manner. Route filters are scoped to a particular route. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/default-filters.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/default-filters.adoc index 7938506d..3e27cd28 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/default-filters.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/default-filters.adoc @@ -1,5 +1,6 @@ [[default-filters]] = Default Filters +:page-section-summary-toc: 1 To add a filter and apply it to all routes, you can use `spring.cloud.gateway.default-filters`. This property takes a list of filters. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-prefixpath-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-prefixpath-factory.adoc index 14bc87cf..5e6a7f8a 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-prefixpath-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-prefixpath-factory.adoc @@ -1,5 +1,6 @@ [[the-prefixpath-gatewayfilter-factory]] = The `PrefixPath` `GatewayFilter` Factory +:page-section-summary-toc: 1 The `PrefixPath` `GatewayFilter` factory takes a single `prefix` parameter. The following example configures a `PrefixPath` `GatewayFilter`: diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-preservehostheader-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-preservehostheader-factory.adoc index 0cbe1a0f..445346a7 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-preservehostheader-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-preservehostheader-factory.adoc @@ -1,5 +1,6 @@ [[the-preservehostheader-gatewayfilter-factory]] = The `PreserveHostHeader` `GatewayFilter` Factory +:page-section-summary-toc: 1 The `PreserveHostHeader` `GatewayFilter` factory has no parameters. This filter sets a request attribute that the routing filter inspects to determine if the original host header should be sent rather than the host header determined by the HTTP client. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestheader-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestheader-factory.adoc index c1fafbfb..11489680 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestheader-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestheader-factory.adoc @@ -1,5 +1,6 @@ [[the-removerequestheader-gatewayfilter-factory]] = The `RemoveRequestHeader` GatewayFilter Factory +:page-section-summary-toc: 1 The `RemoveRequestHeader` `GatewayFilter` factory takes a `name` parameter. It is the name of the header to be removed. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestparameter-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestparameter-factory.adoc index 6b155ddd..1b93333a 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestparameter-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-removerequestparameter-factory.adoc @@ -1,5 +1,6 @@ [[the-removerequestparameter-gatewayfilter-factory]] = The `RemoveRequestParameter` `GatewayFilter` Factory +:page-section-summary-toc: 1 The `RemoveRequestParameter` `GatewayFilter` factory takes a `name` parameter. It is the name of the query parameter to be removed. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestheadersize-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestheadersize-factory.adoc index d47d1383..b964cfee 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestheadersize-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-requestheadersize-factory.adoc @@ -1,5 +1,6 @@ [[the-requestheadersize-gatewayfilter-factory]] = The `RequestHeaderSize` `GatewayFilter` Factory +:page-section-summary-toc: 1 The `RequestHeaderSize` `GatewayFilter` factory takes `maxSize` and `errorHeaderName` parameters. The `maxSize` parameter is the maximum data size allowed by the request header (including key and value). The `errorHeaderName` parameter sets the name of the response header containing an error message, by default it is "errorMessage". diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-rewriteresponseheader-factory.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-rewriteresponseheader-factory.adoc index d6a42e9e..17a324ba 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-rewriteresponseheader-factory.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/gatewayfilter-factories/the-rewriteresponseheader-factory.adoc @@ -1,5 +1,6 @@ [[the-rewriteresponseheader-gatewayfilter-factory]] = The `RewriteResponseHeader` `GatewayFilter` Factory +:page-section-summary-toc: 1 The `RewriteResponseHeader` `GatewayFilter` factory takes `name`, `regexp`, and `replacement` parameters. It uses Java regular expressions for a flexible way to rewrite the response header value. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/glossary.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/glossary.adoc index 297b8af1..95cfd17f 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/glossary.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/glossary.adoc @@ -1,5 +1,6 @@ [[glossary]] = Glossary +:page-section-summary-toc: 1 * *Route*: The basic building block of the gateway. It is defined by an ID, a destination URI, a collection of predicates, and a collection of filters. A route is matched if the aggregate predicate is true. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/how-it-works.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/how-it-works.adoc index 2f883976..da60d42e 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/how-it-works.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/how-it-works.adoc @@ -1,5 +1,6 @@ [[gateway-how-it-works]] = How It Works +:page-section-summary-toc: 1 The following diagram provides a high-level overview of how Spring Cloud Gateway works: diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/starter.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/starter.adoc index 9b91af6f..7bc6f3f1 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/starter.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/starter.adoc @@ -1,5 +1,6 @@ [[gateway-starter]] = How to Include Spring Cloud Gateway +:page-section-summary-toc: 1 To include Spring Cloud Gateway in your project, use the starter with a group ID of `org.springframework.cloud` and an artifact ID of `spring-cloud-starter-gateway`. See the https://projects.spring.io/spring-cloud/[Spring Cloud Project page] for details on setting up your build system with the current Spring Cloud Release Train. diff --git a/docs/modules/ROOT/pages/spring-cloud-gateway/troubleshooting.adoc b/docs/modules/ROOT/pages/spring-cloud-gateway/troubleshooting.adoc index 6b3d333c..b8c2b509 100644 --- a/docs/modules/ROOT/pages/spring-cloud-gateway/troubleshooting.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-gateway/troubleshooting.adoc @@ -1,5 +1,6 @@ [[troubleshooting]] = Troubleshooting +:page-section-summary-toc: 1 This section covers common problems that may arise when you use Spring Cloud Gateway.