From d5913b08ff76afc88a901a2d40163bf3d95cecb1 Mon Sep 17 00:00:00 2001 From: spencergibb Date: Wed, 13 Sep 2023 16:12:33 -0400 Subject: [PATCH] Enable Section Summary TOC for small pages --- docs/modules/ROOT/pages/appendix.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-consul.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc | 1 + .../ROOT/pages/spring-cloud-consul/configuration-properties.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-consul/install.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc | 1 + 9 files changed, 9 insertions(+) diff --git a/docs/modules/ROOT/pages/appendix.adoc b/docs/modules/ROOT/pages/appendix.adoc index cdf72e47..eef1c905 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-consul.adoc b/docs/modules/ROOT/pages/spring-cloud-consul.adoc index 80d7118c..0f725839 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul.adoc @@ -1,5 +1,6 @@ [[spring-cloud-consul]] = Spring Cloud Consul +:page-section-summary-toc: 1 *{spring-cloud-version}* diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc index 7e511be7..d7fec47c 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul/agent.adoc @@ -1,5 +1,6 @@ [[spring-cloud-consul-agent]] = Consul Agent +:page-section-summary-toc: 1 A Consul Agent client must be available to all Spring Cloud Consul applications. By default, the Agent client is expected to be at `localhost:8500`. See the https://consul.io/docs/agent/basics.html[Agent documentation] for specifics on how to start an Agent client and how to connect to a cluster of Consul Agent Servers. For development, after you have installed consul, you may start a Consul Agent using the following command: diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc index 1c40d16a..964e3175 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul/bus.adoc @@ -1,5 +1,6 @@ [[spring-cloud-consul-bus]] = Spring Cloud Bus with Consul +:page-section-summary-toc: 1 [[how-to-activate]] == How to activate diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc index 18578fc4..a3a01e7a 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul/configuration-properties.adoc @@ -1,4 +1,5 @@ [[configuration-properties]] = Configuration Properties +:page-section-summary-toc: 1 To see the list of all Consul related configuration properties please check link:appendix.html[the Appendix page]. diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc index 79a18330..b7696493 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul/hystrix.adoc @@ -1,5 +1,6 @@ [[spring-cloud-consul-hystrix]] = Circuit Breaker with Hystrix +:page-section-summary-toc: 1 Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: `spring-cloud-starter-hystrix`. Hystrix doesn't depend on the Netflix Discovery Client. The `@EnableHystrix` annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with `@HystrixCommand` to be protected by a circuit breaker. See https://projects.spring.io/spring-cloud/spring-cloud.html#_circuit_breaker_hystrix_clients[the documentation] for more details. diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/install.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/install.adoc index 5111b2a7..04978a07 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/install.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul/install.adoc @@ -1,5 +1,6 @@ [[spring-cloud-consul-install]] = Install Consul +:page-section-summary-toc: 1 Please see the https://www.consul.io/intro/getting-started/install.html[installation documentation] for instructions on how to install Consul. diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc index d79042e1..59e05139 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul/quick-start.adoc @@ -1,5 +1,6 @@ [[quick-start]] = Quick Start +:page-section-summary-toc: 1 include:../:quickstart.adoc[] diff --git a/docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc b/docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc index 3bd928f3..8de49a4e 100644 --- a/docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-consul/retry.adoc @@ -1,5 +1,6 @@ [[spring-cloud-consul-retry]] = Consul Retry +:page-section-summary-toc: 1 If you expect that the consul agent may occasionally be unavailable when your app starts, you can ask it to keep trying after a failure. You need to add