From b2fd379a2a58fbf70dc83f61f30039300b9b8e43 Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Fri, 4 Feb 2022 16:02:22 +0100 Subject: [PATCH] Unify guide titles and update pinned-guides (#10007) --- docs/guides/src/main/server/caching.adoc | 2 +- ...duction-readiness.adoc => configuration-production.adoc} | 0 .../{configuration_overview.adoc => configuration.adoc} | 0 docs/guides/src/main/server/hostname.adoc | 2 +- docs/guides/src/main/server/outgoinghttp.adoc | 2 +- docs/guides/src/main/server/pinned-guides | 6 ++++-- docs/guides/src/main/server/reverseproxy.adoc | 2 +- docs/guides/src/main/server/vault.adoc | 2 +- 8 files changed, 9 insertions(+), 7 deletions(-) rename docs/guides/src/main/server/{production-readiness.adoc => configuration-production.adoc} (100%) rename docs/guides/src/main/server/{configuration_overview.adoc => configuration.adoc} (100%) diff --git a/docs/guides/src/main/server/caching.adoc b/docs/guides/src/main/server/caching.adoc index 879213d6ed..42e234221a 100644 --- a/docs/guides/src/main/server/caching.adoc +++ b/docs/guides/src/main/server/caching.adoc @@ -3,7 +3,7 @@ <#import "/templates/options.adoc" as opts> <@tmpl.guide -title="Configure distributed caches" +title="Configuring distributed caches" summary="Understand how to configure the caching layer" includedOptions="cache cache-*"> diff --git a/docs/guides/src/main/server/production-readiness.adoc b/docs/guides/src/main/server/configuration-production.adoc similarity index 100% rename from docs/guides/src/main/server/production-readiness.adoc rename to docs/guides/src/main/server/configuration-production.adoc diff --git a/docs/guides/src/main/server/configuration_overview.adoc b/docs/guides/src/main/server/configuration.adoc similarity index 100% rename from docs/guides/src/main/server/configuration_overview.adoc rename to docs/guides/src/main/server/configuration.adoc diff --git a/docs/guides/src/main/server/hostname.adoc b/docs/guides/src/main/server/hostname.adoc index 4b54a214c8..fcfb9c099c 100644 --- a/docs/guides/src/main/server/hostname.adoc +++ b/docs/guides/src/main/server/hostname.adoc @@ -3,7 +3,7 @@ <#import "/templates/links.adoc" as links> <@tmpl.guide -title="Configure the Hostname" +title="Configuring the hostname" summary="Learn how to configure the frontend and backchannel endpoints exposed by Keycloak." includedOptions="hostname-* proxy"> diff --git a/docs/guides/src/main/server/outgoinghttp.adoc b/docs/guides/src/main/server/outgoinghttp.adoc index 36c5d11471..09beacc3b9 100644 --- a/docs/guides/src/main/server/outgoinghttp.adoc +++ b/docs/guides/src/main/server/outgoinghttp.adoc @@ -2,7 +2,7 @@ <#import "/templates/kc.adoc" as kc> <@tmpl.guide -title="Configure outgoing HTTP requests" +title="Configuring outgoing HTTP requests" summary="How to configure the client used for outgoing HTTP requests." includedOptions=""> diff --git a/docs/guides/src/main/server/pinned-guides b/docs/guides/src/main/server/pinned-guides index f69253be59..7ab89fd8f0 100644 --- a/docs/guides/src/main/server/pinned-guides +++ b/docs/guides/src/main/server/pinned-guides @@ -1,3 +1,5 @@ -containers +configuration +configuration-production all-config -features \ No newline at end of file +features +containers \ No newline at end of file diff --git a/docs/guides/src/main/server/reverseproxy.adoc b/docs/guides/src/main/server/reverseproxy.adoc index eae7074361..4caf3a58c8 100644 --- a/docs/guides/src/main/server/reverseproxy.adoc +++ b/docs/guides/src/main/server/reverseproxy.adoc @@ -3,7 +3,7 @@ <#import "/templates/options.adoc" as opts> <@tmpl.guide -title="Configuring a reverse proxy" +title="Using a reverse proxy" summary="Learn how to configure Keycloak together with a reverse proxy, api gateway, or load balancer." includedOptions="proxy proxy-*"> diff --git a/docs/guides/src/main/server/vault.adoc b/docs/guides/src/main/server/vault.adoc index 7c1383781e..5d6e3b7329 100644 --- a/docs/guides/src/main/server/vault.adoc +++ b/docs/guides/src/main/server/vault.adoc @@ -2,7 +2,7 @@ <#import "/templates/kc.adoc" as kc> <@tmpl.guide -title="Using Kubernetes Secrets" +title="Using Kubernetes secrets" summary="Learn how to use Kubernetes/OpenShift secrets in Keycloak" priority=30 includedOptions="vault vault-*">