From 2e4d529f3070d4ac8a1466bd39bc8961bfa3bd1d Mon Sep 17 00:00:00 2001 From: spencergibb Date: Tue, 19 Sep 2023 13:10:01 -0400 Subject: [PATCH] Enable Section Summary TOC for small pages --- docs/modules/ROOT/pages/appendix.adoc | 1 + docs/modules/ROOT/pages/discovery-kubernetes-native.adoc | 1 + docs/modules/ROOT/pages/examples.adoc | 1 + docs/modules/ROOT/pages/info-contributor.adoc | 1 + docs/modules/ROOT/pages/other-resources.adoc | 1 + docs/modules/ROOT/pages/pod-health-indicator.adoc | 1 + docs/modules/ROOT/pages/property-source-config.adoc | 1 + .../property-source-config/order_of_configMaps_and_secrets.adoc | 1 + docs/modules/ROOT/pages/service-registry.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/discovery-kubernetes-native.adoc b/docs/modules/ROOT/pages/discovery-kubernetes-native.adoc index 747caece..a4b71645 100644 --- a/docs/modules/ROOT/pages/discovery-kubernetes-native.adoc +++ b/docs/modules/ROOT/pages/discovery-kubernetes-native.adoc @@ -1,5 +1,6 @@ [[kubernetes-native-service-discovery]] = Kubernetes native service discovery +:page-section-summary-toc: 1 Kubernetes itself is capable of (server side) service discovery (see: https://kubernetes.io/docs/concepts/services-networking/service/#discovering-services). Using native kubernetes service discovery ensures compatibility with additional tooling, such as Istio (https://istio.io), a service mesh that is capable of load balancing, circuit breaker, failover, and much more. diff --git a/docs/modules/ROOT/pages/examples.adoc b/docs/modules/ROOT/pages/examples.adoc index 89eef7c5..ca0b11ec 100644 --- a/docs/modules/ROOT/pages/examples.adoc +++ b/docs/modules/ROOT/pages/examples.adoc @@ -1,5 +1,6 @@ [[examples]] = Examples +:page-section-summary-toc: 1 Spring Cloud Kubernetes tries to make it transparent for your applications to consume Kubernetes Native Services by following the Spring Cloud interfaces. diff --git a/docs/modules/ROOT/pages/info-contributor.adoc b/docs/modules/ROOT/pages/info-contributor.adoc index 6afed635..54f62e23 100644 --- a/docs/modules/ROOT/pages/info-contributor.adoc +++ b/docs/modules/ROOT/pages/info-contributor.adoc @@ -1,5 +1,6 @@ [[info-contributor]] = Info Contributor +:page-section-summary-toc: 1 Spring Cloud Kubernetes includes an `InfoContributor` which adds Pod information to Spring Boot's `/info` Acturator endpoint. diff --git a/docs/modules/ROOT/pages/other-resources.adoc b/docs/modules/ROOT/pages/other-resources.adoc index 2e507c2a..e81bcc02 100644 --- a/docs/modules/ROOT/pages/other-resources.adoc +++ b/docs/modules/ROOT/pages/other-resources.adoc @@ -1,5 +1,6 @@ [[other-resources]] = Other Resources +:page-section-summary-toc: 1 This section lists other resources, such as presentations (slides) and videos about Spring Cloud Kubernetes. diff --git a/docs/modules/ROOT/pages/pod-health-indicator.adoc b/docs/modules/ROOT/pages/pod-health-indicator.adoc index fcd5c298..80b81284 100644 --- a/docs/modules/ROOT/pages/pod-health-indicator.adoc +++ b/docs/modules/ROOT/pages/pod-health-indicator.adoc @@ -1,5 +1,6 @@ [[pod-health-indicator]] = Pod Health Indicator +:page-section-summary-toc: 1 Spring Boot uses https://github.com/spring-projects/spring-boot/blob/master/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthEndpoint.java[`HealthIndicator`] to expose info about the health of an application. That makes it really useful for exposing health-related information to the user and makes it a good fit for use as https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/[readiness probes]. diff --git a/docs/modules/ROOT/pages/property-source-config.adoc b/docs/modules/ROOT/pages/property-source-config.adoc index 2e83518f..29f1fc65 100644 --- a/docs/modules/ROOT/pages/property-source-config.adoc +++ b/docs/modules/ROOT/pages/property-source-config.adoc @@ -1,5 +1,6 @@ [[kubernetes-propertysource-implementations]] = Kubernetes PropertySource implementations +:page-section-summary-toc: 1 The most common approach to configuring your Spring Boot application is to create an `application.properties` or `application.yaml` or an `application-profile.properties` or `application-profile.yaml` file that contains key-value pairs that provide customization values to your diff --git a/docs/modules/ROOT/pages/property-source-config/order_of_configMaps_and_secrets.adoc b/docs/modules/ROOT/pages/property-source-config/order_of_configMaps_and_secrets.adoc index c4f1a74e..6ce8b392 100644 --- a/docs/modules/ROOT/pages/property-source-config/order_of_configMaps_and_secrets.adoc +++ b/docs/modules/ROOT/pages/property-source-config/order_of_configMaps_and_secrets.adoc @@ -1,5 +1,6 @@ [[order_of_configMaps_and_secrets]] = Order of ConfigMaps and Secrets +:page-section-summary-toc: 1 If, for whatever reason, you enabled both configmaps and secrets, and there is a common property between them, the value from the ConfigMap will have a higher precedence. That is: it will override whatever values are found in secrets. diff --git a/docs/modules/ROOT/pages/service-registry.adoc b/docs/modules/ROOT/pages/service-registry.adoc index 6357e5ad..a6102d3e 100644 --- a/docs/modules/ROOT/pages/service-registry.adoc +++ b/docs/modules/ROOT/pages/service-registry.adoc @@ -1,5 +1,6 @@ [[service-registry-implementation]] = Service Registry Implementation +:page-section-summary-toc: 1 In Kubernetes service registration is controlled by the platform, the application itself does not control registration as it may do in other platforms. For this reason using `spring.cloud.service-registry.auto-registration.enabled`