diff --git a/docs/assets/config/kubernetes/boards-cp.yaml b/docs/assets/config/kubernetes/boards-cp.yaml index 5cb962fb0..9c9cd3276 100644 --- 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 index d739f0d98..c2944a9cc 100644 --- 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 new file mode 100644 index 000000000..6e2e31647 --- /dev/null +++ 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 new file mode 100644 index 000000000..a8ed2697a Binary files /dev/null and b/docs/boards/env/help-yaml.png differ diff --git a/docs/boards/env/help.png b/docs/boards/env/help.png new file mode 100644 index 000000000..4ed319a75 Binary files /dev/null and b/docs/boards/env/help.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 38e5526af..cb672a106 100644 --- 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: