Merge branch '3604-theme-and-new-user-process' closes #3604
[arvados.git] / apps / workbench / config / application.default.yml
index 5c6d6f1377045647a0526cc6e1a3d5d670fa6d52..9443520b1443ade6b8bbad19bed8363016f33097 100644 (file)
@@ -58,6 +58,25 @@ test:
 
   site_name: Workbench:test
 
+  # Enable user profile with one required field
+  user_profile_form_fields:
+    - 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,16 +95,21 @@ 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. 
+  # Below is a sample setting of user_profile_form_fields config parameter.
+  # This configuration parameter should be set to either false (to disable) or
+  # to an array as shown below. 
+  # 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 one required and one optional form 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:
   #  - key: organization
   #    type: text
@@ -95,7 +119,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
@@ -103,3 +127,7 @@ common:
   #      - Software developer
   #      - IT
   #      - Other
+
+  # Use "user_profile_form_message" to configure the message you want to display on
+  # the profile page.
+  user_profile_form_message: Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.