From 03b5ba3462af61e7381571cecbbbf2536fdad049 Mon Sep 17 00:00:00 2001 From: Steven Hawkins Date: Tue, 8 Oct 2024 09:46:24 -0400 Subject: [PATCH] fix: linking within getting started on horizontal scaling closes: #29390 Signed-off-by: Steve Hawkins Signed-off-by: Alexander Schwartz Co-authored-by: Alexander Schwartz --- docs/guides/getting-started/getting-started-kube.adoc | 3 +++ docs/guides/getting-started/getting-started-openshift.adoc | 5 ++++- docs/guides/templates/links.adoc | 1 + 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/guides/getting-started/getting-started-kube.adoc b/docs/guides/getting-started/getting-started-kube.adoc index 53ce341cdd..968288958b 100644 --- a/docs/guides/getting-started/getting-started-kube.adoc +++ b/docs/guides/getting-started/getting-started-kube.adoc @@ -1,4 +1,5 @@ <#import "/templates/guide.adoc" as tmpl> +<#import "/templates/links.adoc" as links> <@tmpl.guide title="Kubernetes" @@ -41,6 +42,8 @@ kubectl create -f https://raw.githubusercontent.com/keycloak/keycloak-quickstart This command starts {project_name} on Kubernetes and creates an initial admin user with the username `admin` and password `admin`. +NOTE: If you will eventually want more than one server replica, please see the <@links.gettingstarted id="getting-started-scaling-and-tuning" anchor="horizontal-scaling" /> {section}. + === Access {project_name} with Ingress addon enabled Now create an Ingress for {project_name} by entering the following command: diff --git a/docs/guides/getting-started/getting-started-openshift.adoc b/docs/guides/getting-started/getting-started-openshift.adoc index 7aac267397..6985cf43ae 100644 --- a/docs/guides/getting-started/getting-started-openshift.adoc +++ b/docs/guides/getting-started/getting-started-openshift.adoc @@ -1,4 +1,5 @@ <#import "/templates/guide.adoc" as tmpl> +<#import "/templates/links.adoc" as links> <@tmpl.guide title="OpenShift" @@ -11,7 +12,7 @@ summary="Get started with {project_name} on OpenShift"> include::templates/hw-requirements.adoc[] -. Install https://code-ready.github.io/crc/[Red Hat Code Ready Containers] and follow the steps in the documentation to install a +. Install https://code-ready.github.io/crc/[Red Hat Code Ready Containers] and follow the steps in the documentation to install a local OpenShift cluster. . Make sure the cluster is functional by entering the following command: @@ -99,6 +100,8 @@ echo "{project_name} Account Console: $KEYCLOAK_URL/realms/myrealm/account" && echo "" ---- +NOTE: If you will eventually want more than one server replica, please see the <@links.gettingstarted id="getting-started-scaling-and-tuning" anchor="horizontal-scaling" /> {section}. + Remember these URLs as you will need them throughout this {section}. The URL for the account console won't work right now as you will need to create the realm first. diff --git a/docs/guides/templates/links.adoc b/docs/guides/templates/links.adoc index 9d35fe0624..d2ba5df5a1 100644 --- a/docs/guides/templates/links.adoc +++ b/docs/guides/templates/links.adoc @@ -2,3 +2,4 @@ <#macro operator id anchor="">link:{links_operator_${id}_url}<#if anchor != "">#${anchor}[{links_operator_${id}_name}] <#macro ha id anchor="">link:{links_high-availability_${id}_url}<#if anchor != "">#${anchor}[{links_high-availability_${id}_name}] <#macro securingapps id anchor="">link:{links_securing-apps_${id}_url}<#if anchor != "">#${anchor}[{links_securing-apps_${id}_name}] +<#macro gettingstarted id anchor="">link:{links_getting-started_${id}_url}<#if anchor != "">#${anchor}[{links_getting-started_${id}_name}]