3296: profile notification email setting is now on server
[arvados.git] / apps / workbench / config / application.default.yml
index c4de7dd5613925fb30499a773bc528320ce9c72c..b639350ba5862da5c2b661784eee95299e239073 100644 (file)
@@ -58,6 +58,26 @@ test:
 
   site_name: Workbench:test
 
+  # Enable user profile with one required field
+  user_profile_form_fields:
+    - message: Welcome to Curoverse.
+    - key: organization
+      type: text
+      form_field_title: Institution
+      form_field_description: Your organization
+      required: true
+    - key: role
+      type: select
+      form_field_title: Your role
+      form_field_description: Choose the category that best describes your role in your organization.
+      options:
+        - Bio-informatician
+        - Computational biologist
+        - Biologist or geneticist
+        - Software developer
+        - IT
+        - Other
+
 common:
   assets.js_compressor: false
   assets.css_compressor: false
@@ -76,17 +96,26 @@ common:
   send_user_setup_notification_email: true
 
   # Set user_profile_form_fields to enable and configure the user profile page.
-  # A commented setting with full description is provided below.
+  # Default is set to false. A commented setting with full description is provided below.
   user_profile_form_fields: false
 
   # Below is a sample setting of user_profile_form_fields.
-  # This sample configures two fields as represented by the attribute "key".
-  # You can specify "type" as "text" or "select".
-  # Specify "options" when using the type "select".
-  # Set "required" as "true" for any of the fields to make them required.
+  # This configuration parameter should be set to either false (to disable) or
+  # to an array as shown below. This parameter supports two types of fields,
+  # an optional "message" and an optional list of input fields.
+  # Use "message" to configure the message you want to display at the top of the
+  # profile page. If this is not provided, a default message will be displayed.
+  # Configure the list of input fields to be displayed in the profile page
+  # using the attribute "key" for each of the input fields.
+  # This sample shows configuration with message and two input fields.
+  # For each of these input fields:
+  #   You can specify "type" as "text" or "select".
+  #   List the "options" to be displayed for each of the "select" menu.
+  #   Set "required" as "true" for any of these fields to make them required.
   # If any of the required fields are missing in the user's profile, the user will be
-  # redirected to the "/profile" page before they can access any Workbench features.
+  # redirected to the profile page before they can access any Workbench features.
   #user_profile_form_fields:
+  #  - message: Welcome to Curoverse. Any fields in red are required and missing. Please fill in those fields before you can access Arvados Workbench.
   #  - key: organization
   #    type: text
   #    form_field_title: Institution/Company
@@ -95,7 +124,7 @@ common:
   #  - key: role
   #    type: select
   #    form_field_title: Your role
-  #    form_field_description: Choose the category that best describes your role in your lab.
+  #    form_field_description: Choose the category that best describes your role in your organization.
   #    options:
   #      - Bio-informatician
   #      - Computational biologist