From d7d6b83bd6e060c20f0b3e0629a8e6a53dc4e374 Mon Sep 17 00:00:00 2001 From: Marek Posolda Date: Mon, 22 May 2023 19:09:01 +0200 Subject: [PATCH] Fix the documentation about default themes (#20488) closes #17130 Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com> --- .../server_development/topics/custom-attributes.adoc | 1 + .../server_development/topics/locale-selector.adoc | 2 +- .../server_development/topics/themes.adoc | 11 +++++++++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/documentation/server_development/topics/custom-attributes.adoc b/docs/documentation/server_development/topics/custom-attributes.adoc index 5e0b032096..8b05e49821 100644 --- a/docs/documentation/server_development/topics/custom-attributes.adoc +++ b/docs/documentation/server_development/topics/custom-attributes.adoc @@ -1,3 +1,4 @@ + [[_custom_user_attributes]] == Custom user attributes diff --git a/docs/documentation/server_development/topics/locale-selector.adoc b/docs/documentation/server_development/topics/locale-selector.adoc index f036702769..db7849a5b8 100644 --- a/docs/documentation/server_development/topics/locale-selector.adoc +++ b/docs/documentation/server_development/topics/locale-selector.adoc @@ -12,6 +12,6 @@ The `LocaleSelectorProvider` interface has a single method, `resolveLocale`, whi Custom implementations can extend the `DefaultLocaleSelectorProvider` in order to reuse parts of the default behavior. For example to ignore the `Accept-Language` request header, a custom implementation could extend the default provider, override it's `getAcceptLanguageHeaderLocale`, and return a null value. As a result the locale selection will fall back on the realm's default language. [role="_additional-resources"] -=== Additional resources +=== Additional resources for Locale selector * For more details on creating and deploying a custom provider, see <<_providers,Service Provider Interfaces>>. diff --git a/docs/documentation/server_development/topics/themes.adoc b/docs/documentation/server_development/topics/themes.adoc index 8010ff1f20..85ab090b3e 100755 --- a/docs/documentation/server_development/topics/themes.adoc +++ b/docs/documentation/server_development/topics/themes.adoc @@ -41,10 +41,12 @@ NOTE: To set the theme for the `master` Admin Console you need to set the Admin bin/kc.[sh|bat] start --spi-theme-welcome-theme=custom-theme ---- +[[_default-themes]] === Default themes -{project_name} comes bundled with default themes in the server's root `themes` directory. To simplify upgrading you should not edit the bundled themes -directly. Instead create your own theme that extends one of the bundled themes. +{project_name} comes bundled with default themes in the JAR file `keycloak-themes-{project_versionMvn}.jar` inside the server distribution. +The server's root `themes` directory does not contain any themes by default, but it contains a README file with some additional details about the default themes. +To simplify upgrading, do not edit the bundled themes directly. Instead create your own theme that extends one of the bundled themes. === Creating a theme @@ -407,3 +409,8 @@ A single archive can contain multiple themes and each theme can support one or m To deploy the archive to {project_name}, add it to the `providers/` directory of {project_name} and restart the server if it is already running. + +[role="_additional-resources"] +=== Additional resources for Themes +* For the inspiration, see <<_default-themes,Default Themes>> bundled inside {project_name}. +* {quickstartRepo_link}[{quickstartRepo_name}] - Directory `extension` of the quickstarts repository contains some theme examples, which can be also used as an inspiration.