From 740866eac42260558264c526ae9b3011345697ff Mon Sep 17 00:00:00 2001
From: Andrew Welch <awelch@isw.net.au>
Date: Thu, 29 Feb 2024 13:55:52 +1100
Subject: [PATCH] Boards for DX refactor

---
 .../boards/dx/{oauth => auth}/OAuthConfig.xml |   0
 docs/boards/dx/{ => auth}/haproxy.png         | Bin
 docs/boards/dx/auth/sso.md                    |  31 ++++++++++++++++
 docs/boards/dx/{oauth => auth}/websphere.md   |   0
 docs/boards/dx/index.md                       |  34 +++---------------
 docs/boards/dx/portlet/index.md               |  14 +++++---
 .../{manage-portlet.png => manage.png}        | Bin
 7 files changed, 45 insertions(+), 34 deletions(-)
 rename docs/boards/dx/{oauth => auth}/OAuthConfig.xml (100%)
 rename docs/boards/dx/{ => auth}/haproxy.png (100%)
 create mode 100644 docs/boards/dx/auth/sso.md
 rename docs/boards/dx/{oauth => auth}/websphere.md (100%)
 rename docs/boards/dx/portlet/{manage-portlet.png => manage.png} (100%)

diff --git a/docs/boards/dx/oauth/OAuthConfig.xml b/docs/boards/dx/auth/OAuthConfig.xml
similarity index 100%
rename from docs/boards/dx/oauth/OAuthConfig.xml
rename to docs/boards/dx/auth/OAuthConfig.xml
diff --git a/docs/boards/dx/haproxy.png b/docs/boards/dx/auth/haproxy.png
similarity index 100%
rename from docs/boards/dx/haproxy.png
rename to docs/boards/dx/auth/haproxy.png
diff --git a/docs/boards/dx/auth/sso.md b/docs/boards/dx/auth/sso.md
new file mode 100644
index 000000000..7beaaec7a
--- /dev/null
+++ b/docs/boards/dx/auth/sso.md
@@ -0,0 +1,31 @@
+### Allow SSO for Boards
+
+!!! tip
+
+    This task is only required if Boards is hosted on a different domain to HCL DX
+
+## Steps
+
+Edit the config to include the following,
+
+1.  haproxy.cfg
+
+    Edit the config using the following command
+
+    `kubectl edit configmap <DX_DEPLOYMENT>-haproxy -n <DX_NAMESPACE> -o yaml`
+
+    For example:
+
+    `kubectl edit configmap hcl-dx-dev1-haproxy -n hcl-dx-dev1 -o yaml`
+
+    Add the following line
+
+        http-response replace-header Set-Cookie ^(.*) \1;\ SameSite=None;\ Secure
+
+    For example:
+
+    ![outcome](./haproxy.png)
+
+1.  httpd.conf
+
+        Header edit Set-Cookie ^(.*)$ "$1; Secure; SameSite=None"
diff --git a/docs/boards/dx/oauth/websphere.md b/docs/boards/dx/auth/websphere.md
similarity index 100%
rename from docs/boards/dx/oauth/websphere.md
rename to docs/boards/dx/auth/websphere.md
diff --git a/docs/boards/dx/index.md b/docs/boards/dx/index.md
index 7f9a8aee5..06d54638a 100644
--- a/docs/boards/dx/index.md
+++ b/docs/boards/dx/index.md
@@ -6,36 +6,10 @@
 1.  Kubernetes environment
 1.  `kubectl` installed & authenticated
 
-## WebSphere OAuth Config
+## Steps
 
-Please follow the instructions in [WebSphere OAuth Config](./oauth/websphere.md)
+1. Setup [WebSphere OAuth Config](./auth/websphere.md)
 
-## Install Boards portlet
+1. Configure [SSO for Boards](./auth/sso.md)
 
-Please follow the instructions in [Install Boards portlet](./portlet/index.md)
-
-### Allow SSO inside Boards frame
-
-Edit the config to include the following,
-
-1.  haproxy.cfg
-
-    Edit the config using the following command
-
-    `kubectl edit configmap <DX_DEPLOYMENT>-haproxy -n <DX_NAMESPACE> -o yaml`
-
-    For example:
-
-    `kubectl edit configmap hcl-dx-dev1-haproxy -n hcl-dx-dev1 -o yaml`
-
-    Add the following line
-
-        http-response replace-header Set-Cookie ^(.*) \1;\ SameSite=None;\ Secure
-
-    For example:
-
-    ![outcome](./haproxy.png)
-
-1.  httpd.conf
-
-        Header edit Set-Cookie ^(.*)$ "$1; Secure; SameSite=None"
+1. Install the Boards portlet as [described here](./portlet/index.md)
diff --git a/docs/boards/dx/portlet/index.md b/docs/boards/dx/portlet/index.md
index c6b3a96ae..8a0250623 100644
--- a/docs/boards/dx/portlet/index.md
+++ b/docs/boards/dx/portlet/index.md
@@ -24,17 +24,23 @@ To install the Huddo Boards portlet, follow these steps:
 
 1. Open the `Portlets` page, find Huddo Boards, click `Configure Portlet`
 
-    ![configure portlet](./manage-portlet.png)
+    ![configure portlet](./manage.png)
 
-1. Edit the cfg.BaseURL to `https://<BOARDS_URL`.
+1. Edit the cfg.BaseURL to `https://<BOARDS_URL>`.
 
-    For example `https://boards.company.com` or `https://company.example.com/Boards`
+    For example:
+
+    - `https://boards.company.com` or
+    - `https://company.example.com/boards`
+    - `https://boards.huddo.com` (hybrid customers)
 
     ![edit base url](./configure.png)
 
     Click OK
 
-1. The `Huddo Boards` Portlet should now be accessible under `Edit mode` => `Add` => `Applications`
+1. The `Huddo Boards` Portlet should now be accessible at
+
+    `Edit mode` => `Add` => `Applications`
 
     ![applications](./applications.png)
 
diff --git a/docs/boards/dx/portlet/manage-portlet.png b/docs/boards/dx/portlet/manage.png
similarity index 100%
rename from docs/boards/dx/portlet/manage-portlet.png
rename to docs/boards/dx/portlet/manage.png