From 7d62f6308d308ce1a0c8961a88b277f9d797e7b0 Mon Sep 17 00:00:00 2001 From: andymunro <48995441+andymunro@users.noreply.github.com> Date: Mon, 20 Nov 2023 07:16:35 -0500 Subject: [PATCH] Create an attribute for Getting Started (#24825) * Create an attribute for Getting Started Closes #24824 Signed-off-by: AndyMunro Signed-off-by: Alexander Schwartz Co-authored-by: Alexander Schwartz --- docs/guides/.asciidoctorconfig | 3 +++ docs/guides/attributes.adoc | 2 ++ docs/guides/getting-started/getting-started-zip.adoc | 12 +++--------- .../templates/start-keycloak-localhost.adoc | 2 +- 4 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/guides/.asciidoctorconfig b/docs/guides/.asciidoctorconfig index 3a3ad9e308..08c819d0fb 100644 --- a/docs/guides/.asciidoctorconfig +++ b/docs/guides/.asciidoctorconfig @@ -4,3 +4,6 @@ :icons: font :section: guide :sections: guides + +ifndef::asciidoctorconfigdir[:asciidoctorconfigdir: .] +include::{asciidoctorconfigdir}/attributes.adoc[] \ No newline at end of file diff --git a/docs/guides/attributes.adoc b/docs/guides/attributes.adoc index 263095e7b2..f79817e10e 100644 --- a/docs/guides/attributes.adoc +++ b/docs/guides/attributes.adoc @@ -1 +1,3 @@ :project_name: Keycloak +:archivebasename: keycloak +:archivedownloadurl: https://github.com/keycloak/keycloak/releases/download/{version}/keycloak-{version}.zip \ No newline at end of file diff --git a/docs/guides/getting-started/getting-started-zip.adoc b/docs/guides/getting-started/getting-started-zip.adoc index 41174aaa30..d1d2ed4423 100644 --- a/docs/guides/getting-started/getting-started-zip.adoc +++ b/docs/guides/getting-started/getting-started-zip.adoc @@ -11,20 +11,14 @@ summary="Get started with {project_name} on bare metal"> == Before you start -Make sure you have https://openjdk.java.net/[OpenJDK 17] installed. +Make sure you have https://openjdk.java.net/[OpenJDK 17] installed. == Download {project_name} -Download and extract https://github.com/keycloak/keycloak/releases/download/{version}/keycloak-{version}.zip[keycloak-{version}.zip] +Download and extract {archivedownloadurl}[{archivebasename}-{version}.zip] from the {project_name} website. -<@profile.ifCommunity> -After extracting this file, you should have a directory with a name that starts with `keycloak-{version}`. - - -<@profile.ifProduct> -After extracting this file, you should have a directory with a name that starts with `rhbk-{version}`. - +After extracting this file, you should have a directory that is named `{archivebasename}-{version}`. include::templates/start-keycloak-localhost.adoc[] diff --git a/docs/guides/getting-started/templates/start-keycloak-localhost.adoc b/docs/guides/getting-started/templates/start-keycloak-localhost.adoc index f0ae62fea0..15225cb9ad 100644 --- a/docs/guides/getting-started/templates/start-keycloak-localhost.adoc +++ b/docs/guides/getting-started/templates/start-keycloak-localhost.adoc @@ -2,7 +2,7 @@ == Start {project_name} -. From a terminal, open the keycloak-{version} directory. +. From a terminal, open the `{archivebasename}-{version}` directory. . Enter the following command: <@profile.ifProduct> +