DX Portlet

isw-kudos · Feb 29, 2024 · e60ab8c · e60ab8c
1 parent 6c047e6
commit e60ab8c
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 3 deletions.
diff --git a/docs/boards/dx/index.md b/docs/boards/dx/index.md
@@ -4,15 +4,15 @@
 
 1.  HCL DX environment
 1.  Kubernetes environment
-1.  kubectl installed & authenticated
+1.  `kubectl` installed & authenticated
 
 ## WebSphere OAuth Config
 
-Please follow the instructions in [WebSphere OAuth Config](./websphere-oauth.md)
+Please follow the instructions in [WebSphere OAuth Config](./oauth/websphere.md)
 
 ## Install Boards portlet
 
-Coming soon
+Please follow the instructions in [Install Boards portlet](./portlet/index.md)
 
 ### Allow SSO inside Boards frame
 

diff --git a/docs/boards/dx/OAuthConfig.xml → docs/boards/dx/oauth/OAuthConfig.xml b/docs/boards/dx/OAuthConfig.xml → docs/boards/dx/oauth/OAuthConfig.xml
diff --git a/docs/boards/dx/websphere-oauth.md → docs/boards/dx/oauth/websphere.md b/docs/boards/dx/websphere-oauth.md → docs/boards/dx/oauth/websphere.md
diff --git a/docs/boards/dx/portlet/applications.png b/docs/boards/dx/portlet/applications.png
diff --git a/docs/boards/dx/portlet/boards-for-page.png b/docs/boards/dx/portlet/boards-for-page.png
diff --git a/docs/boards/dx/portlet/boards-portlets.war b/docs/boards/dx/portlet/boards-portlets.war
diff --git a/docs/boards/dx/portlet/configure.png b/docs/boards/dx/portlet/configure.png
diff --git a/docs/boards/dx/portlet/index.md b/docs/boards/dx/portlet/index.md
@@ -0,0 +1,43 @@
+# Boards Portlet
+
+## Overview
+
+The steps below install the Boards Portlet as an application in DX.
+
+![outcome](./outcome.png)
+
+![boards-for-page](./boards-for-page.png)
+
+## Steps
+
+To install the Huddo Boards portlet, follow these steps:
+
+1. Download the [Boards Portlet WAR file](./boards-portlets.war)
+
+1. Open the DX `Administration` => `Web Modules`. Select the war file and click `Next`
+
+    ![select war](./web-modules-browse.png)
+
+1. Click `Finish` to complete the installation
+
+    ![click finish](./web-modules-finish.png)
+
+1. Open the `Portlets` page, find Huddo Boards, click `Configure Portlet`
+
+    ![configure portlet](./manage-portlet.png)
+
+1. Edit the cfg.BaseURL to `https://<BOARDS_URL`.
+
+    For example `https://boards.company.com` or `https://company.example.com/Boards`
+
+    ![edit base url](./configure.png)
+
+    Click OK
+
+1. The `Huddo Boards` Portlet should now be accessible under `Edit mode` => `Add` => `Applications`
+
+    ![applications](./applications.png)
+
+1. Add it to any page to get started!
+
+    ![widget-settings](./widget-settings.png)
diff --git a/docs/boards/dx/portlet/manage-portlet.png b/docs/boards/dx/portlet/manage-portlet.png
diff --git a/docs/boards/dx/portlet/outcome.png b/docs/boards/dx/portlet/outcome.png
diff --git a/docs/boards/dx/portlet/web-modules-browse.png b/docs/boards/dx/portlet/web-modules-browse.png
diff --git a/docs/boards/dx/portlet/web-modules-finish.png b/docs/boards/dx/portlet/web-modules-finish.png
diff --git a/docs/boards/dx/portlet/widget-settings.png b/docs/boards/dx/portlet/widget-settings.png