More detailed documentation on the relationship between host & admin

Author: ianroberts

gate-teamware/README.md

@@ -57,12 +57,12 @@ Things you will commonly need to override include:
   - `replicaCount` (default 1) - the number of replicas of the Django container to run.  Alternatively you can set `backend.autoscaling.enabled` to `true` for auto-scaling based on CPU usage
 - `staticFiles`
   - `replicaCount` (default 1) - the same for the static files nginx, though this is highly unlikely to need more than one replica as it's a simple static file server
-- `privacyPolicy` - contact details of the service's host and administrator to be rendered in the privacy policy and terms & conditions.
+- `privacyPolicy` - settings related to the privacy policy and terms & conditions.
   - `host` - the organisation or individual responsible for managing the deployment of the teamware instance.
     - `name` - host organisation/individual's name.
     - `address` - physical address.
     - `contact` - a means of contact, supports HTML for e.g. email or contact form links.
-  - `admin` - the individual or organisation responsible for managing users of the teamware instance.
+  - `admin` - the individual or organisation responsible for managing users of the teamware instance, if this is not the same as the `host`.  Any of these values that are left un-set will default to the corresponding `host` value.
     - `name` - admin organisation/individual's name.
     - `address` - physical address.
     - `contact` - a means of contact, supports HTML for e.g. email or contact form links.

gate-teamware/values.yaml

@@ -319,15 +319,24 @@ email:
 privacyPolicy:
   # Contact details of the host and administrator of the teamware instance
   host:
-    # Name of the host
+    # Name of the organization that hosts this teamware instance, e.g. "Annotation4U Ltd."
     name: ""
-    # Host's physical address
+    # Host's physical address (e.g. 123 Somewhere Street, London, SW1A 1AA, UK)
     address: ""
-    # A method of contacting the host, field supports HTML for e.g. linking to a form
+    # A method of contacting the host, field supports HTML (inline elements such as
+    # <a> or <span> only), e.g.
+    #
+    # contact: |
+    #   <a href="https://annotation4u.com/contact" target="_blank">Contact Annotation4U</a>
     contact: ""
   admin:
+    # Name of the organization that is responsible for administering this
+    # teamware instance, if not the same as the host
     name: ""
+    # Administrator's physical address, if not the same as the host
     address: ""
+    # A method of contacting the administrator, if not the same as the host.  This
+    # field supports HTML.
     contact: ""
 
 # Database settings - see the bitnami postgresql chart documentation for full