From 2e00cb6c5af677ac6c67a6e005270e47a5f78ab1 Mon Sep 17 00:00:00 2001
From: WithoutPants <53250216+WithoutPants@users.noreply.github.com>
Date: Wed, 28 Feb 2024 11:07:31 +1100
Subject: [PATCH] Document plugin settings

---
 ui/v2.5/src/docs/en/Manual/Plugins.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/ui/v2.5/src/docs/en/Manual/Plugins.md b/ui/v2.5/src/docs/en/Manual/Plugins.md
index 18afdff33..86193de06 100644
--- a/ui/v2.5/src/docs/en/Manual/Plugins.md
+++ b/ui/v2.5/src/docs/en/Manual/Plugins.md
@@ -99,6 +99,16 @@ ui:
     connect-src:
       - http://alloweddomain.com
 
+  # map of setting names to be displayed in the plugins page in the UI
+  settings:
+    # internal name
+    foo:
+      # name to display in the UI
+      displayName: Foo
+      # type of the attribute to show in the UI
+      # can be BOOLEAN, NUMBER, or STRING
+      type: BOOLEAN
+
 # the following are used for plugin tasks only
 exec:
   - ...
@@ -112,6 +122,8 @@ The `name`, `description`, `version` and `url` fields are displayed on the plugi
 
 The `exec`, `interface`, `errLog` and `tasks` fields are used only for plugins with tasks.
 
+The `settings` field is used to display plugin settings on the plugins page. Plugin settings can also be set using the graphql mutation `configurePlugin` - the settings set this way do _not_ need to be specified in the `settings` field unless they are to be displayed in the stock plugin settings UI.
+
 ## UI Configuration
 
 The `css` and `javascript` field values may be relative paths to the plugin configuration file, or