Boards - help links

isw-kudos · Nov 5, 2024 · f579efd · f579efd
1 parent c80eea2
commit f579efd
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 0 deletions.
diff --git a/docs/assets/config/kubernetes/boards-cp.yaml b/docs/assets/config/kubernetes/boards-cp.yaml
@@ -25,6 +25,10 @@ webfront:
     hosts:
       - "connections.example.com"
       # - "*.example.com"
+  env:
+    # DOCUMENTATION_URL: https://docs.huddo.com/boards/howto/knowledgebase/
+    # PRODUCT_INFO_URL: https://huddo.com/boards
+    # SUPPORT_EMAIL: support@example.com
 
 events:
   env:

diff --git a/docs/boards/cp/index.md b/docs/boards/cp/index.md
@@ -79,6 +79,10 @@ Download our [config file](../../assets/config/kubernetes/boards-cp.yaml) and up
 
 Are [detailed here](../env/common.md).
 
+**Customising Help menu links**:
+
+The help menu links can be [customised](../env/help-links.md).
+
 **Customising Boards notifications**:
 
 Some elements of the Boards notifications that are sent out [can be customised](../env/notifications.md).

diff --git a/docs/boards/env/help-links.md b/docs/boards/env/help-links.md
@@ -0,0 +1,19 @@
+# Customise Help Links
+
+You can customise the help links that appear in the header of the Boards application.
+
+![Boards Help Links](./help.png)
+
+---
+
+The following `webfront` environment variables are used to customise the help links:
+
+| Variable            | Default                                              | Description                          |
+| ------------------- | ---------------------------------------------------- | ------------------------------------ |
+| `DOCUMENTATION_URL` | `https://docs.huddo.com/boards/howto/knowledgebase/` | URL of the documentation             |
+| `PRODUCT_INFO_URL`  | `https://huddo.com/boards`                           | URL of the product information page  |
+| `SUPPORT_EMAIL`     | `support@example.com`                                | Email address of the support contact |
+
+For example:
+
+![Customise Help Links](./help-yaml.png)
diff --git a/docs/boards/env/help-yaml.png b/docs/boards/env/help-yaml.png
diff --git a/docs/boards/env/help.png b/docs/boards/env/help.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -43,6 +43,7 @@ nav:
           - Configuration: boards/env/common.md
           - Compatibility: boards/compatibility.md
           - Customise Emails: boards/env/notifications.md
+          - Customise Help Links: boards/env/help-links.md
           - Helm Charts: boards/helm-charts.md
           - Proxy (nginx): boards/proxy/nginx.md
           - Integrations: