From 146b47d8b6725a3c1f4cb54c540452eb029b359c Mon Sep 17 00:00:00 2001
From: Christian Berendt <berendt@osism.tech>
Date: Thu, 12 Sep 2024 19:12:00 +0200
Subject: [PATCH] configuration-guide: custom horizon themes

Signed-off-by: Christian Berendt <berendt@osism.tech>
---
 .../openstack/{horizon.md => horizon.mdx}     | 34 +++++++++++++++++++
 docs/release-notes/osism-8.md                 |  3 ++
 2 files changed, 37 insertions(+)
 rename docs/guides/configuration-guide/openstack/{horizon.md => horizon.mdx} (62%)

diff --git a/docs/guides/configuration-guide/openstack/horizon.md b/docs/guides/configuration-guide/openstack/horizon.mdx
similarity index 62%
rename from docs/guides/configuration-guide/openstack/horizon.md
rename to docs/guides/configuration-guide/openstack/horizon.mdx
index 68c10eab5d..941a75eb06 100644
--- a/docs/guides/configuration-guide/openstack/horizon.md
+++ b/docs/guides/configuration-guide/openstack/horizon.mdx
@@ -2,6 +2,9 @@
 sidebar_label: Horizon
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Horizon
 
 * [Horizon admin guide](https://docs.openstack.org/horizon/latest/admin/index.html)
@@ -43,3 +46,34 @@ USER_MENU_LINKS = [
    }
 ]
 ```
+
+## Custom themes
+
+1. Place the files and directories of the custom theme in
+   `environments/kolla/files/overlays/horizon/themes/custom_theme`.
+   Examples of custom themes can be found in the [osism/openstack-themes](https://github.com/osism/openstack-themes)
+   repository.
+
+2. Add the custom theme to the `horizon_custom_themes` dictionary.
+
+   ```yaml title="environments/kolla/configuration.yml"
+   horizon_custom_themes:
+     - name: custom_theme
+       label: CustomTheme
+   ```
+
+3. If the custom theme should be the default them add the `DEFAULT_THEME` parameter.
+
+
+   <Tabs>
+   <TabItem value="osism-8" label="OSISM >= 8.0.0">
+   ```python title="environments/kolla/files/overlays/horizon/_9999-custom-settings.py"
+   DEFAULT_THEME = 'custom_theme'
+   ```
+   </TabItem>
+   <TabItem value="osism-8" label="OSISM < 8.0.0">
+   ```python title="environments/kolla/files/overlays/horizon/custom_local_settings"
+   DEFAULT_THEME = 'custom_theme'
+   ```
+   </TabItem>
+   </Tabs>
diff --git a/docs/release-notes/osism-8.md b/docs/release-notes/osism-8.md
index af94a45354..89fbfa7f05 100644
--- a/docs/release-notes/osism-8.md
+++ b/docs/release-notes/osism-8.md
@@ -55,6 +55,9 @@ Release date: 11. September 2024
   designate_enable_notifications_sink: "yes"
   ```
 
+* The file containing the custom local settings of Horizon has been renamed from
+  `custom_local_settings` to `_9999-custom-settings.py`.
+
 ### Other & References
 
 OpenStack 2024.1 press announcement: https://www.openstack.org/software/openstack-caracal