Skip to content

Commit d21bb95

Browse files
committed
More detailed documentation on the relationship between host & admin
1 parent d15eedc commit d21bb95

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

gate-teamware/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ Things you will commonly need to override include:
5757
- `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
5858
- `staticFiles`
5959
- `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
60-
- `privacyPolicy` - contact details of the service's host and administrator to be rendered in the privacy policy and terms & conditions.
60+
- `privacyPolicy` - settings related to the privacy policy and terms & conditions.
6161
- `host` - the organisation or individual responsible for managing the deployment of the teamware instance.
6262
- `name` - host organisation/individual's name.
6363
- `address` - physical address.
6464
- `contact` - a means of contact, supports HTML for e.g. email or contact form links.
65-
- `admin` - the individual or organisation responsible for managing users of the teamware instance.
65+
- `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.
6666
- `name` - admin organisation/individual's name.
6767
- `address` - physical address.
6868
- `contact` - a means of contact, supports HTML for e.g. email or contact form links.

gate-teamware/values.yaml

+12-3
Original file line numberDiff line numberDiff line change
@@ -319,15 +319,24 @@ email:
319319
privacyPolicy:
320320
# Contact details of the host and administrator of the teamware instance
321321
host:
322-
# Name of the host
322+
# Name of the organization that hosts this teamware instance, e.g. "Annotation4U Ltd."
323323
name: ""
324-
# Host's physical address
324+
# Host's physical address (e.g. 123 Somewhere Street, London, SW1A 1AA, UK)
325325
address: ""
326-
# A method of contacting the host, field supports HTML for e.g. linking to a form
326+
# A method of contacting the host, field supports HTML (inline elements such as
327+
# <a> or <span> only), e.g.
328+
#
329+
# contact: |
330+
# <a href="https://annotation4u.com/contact" target="_blank">Contact Annotation4U</a>
327331
contact: ""
328332
admin:
333+
# Name of the organization that is responsible for administering this
334+
# teamware instance, if not the same as the host
329335
name: ""
336+
# Administrator's physical address, if not the same as the host
330337
address: ""
338+
# A method of contacting the administrator, if not the same as the host. This
339+
# field supports HTML.
331340
contact: ""
332341

333342
# Database settings - see the bitnami postgresql chart documentation for full

0 commit comments

Comments
 (0)