IATI / ckanext-iati

CKAN extension for the IATI Registry
http://iatiregistry.org
9 stars 6 forks source link

User experience enhancement - Simplify Publisher registration form #350

Closed andreaszenasidi closed 2 years ago

andreaszenasidi commented 3 years ago

One of the user experience enhancement recommendations was to simplify/dummy-proof the Publisher registration form.

Requirements:

1. Clearly indicate which fields are required.

2. Do not pre-select choice for fields with multiple-choice options.

3. Regroup fields meaningfully; name groups and fields meaningfully. Group name: Publisher Information Fields (required fields should come first): Publisher ID Publisher Name IATI Organisation Identifier Type -> rename to Publisher Type License -> rename to: Data License
Country Image URL -> rename to Publisher Logo URL State (should not be visible when you create a new publisher, only when you edit - except for sysadmins) Description Group name: Contact Information Fields (required fields should come first): Email Website Address Group name: Data Publishing Additional Information
Fields (required fields should come first): Source
First Published Date Implementation Schedule Organisations / agencies covered Timeliness of Data Frequency of publication Frequency of publication (extra comments) Units of Aid Segmentation of Published Data Data Definitions and References Field Exclusions Record Exclusions Thresholds Other Constraints Data Quality User Interface User Interface URL -> rename to: User Interface Website

4. Limit the number of optional sections. (Used fields: https://github.com/IATI/ckanext-iati/issues/291)

5. Update left side panel to include the following text

ss-bhat commented 3 years ago

@andreaszenasidi

  1. Clearly indicate which fields are required. - 2 days
  2. Do not pre-select choice for fields with multiple-choice options. - 0.5 day
  3. Regroup fields meaningfully; name groups and fields meaningfully. - 1.5 days
  4. Limit the number of optional sections. (Used fields: #291) - 0.5 day
  5. Update left side panel to include the following text - 0 day

Total: 4.5 days

ss-bhat commented 3 years ago

@andreaszenasidi

This is done please refer to the staging site. Please let me know if you have any questions or need any changes on UI.

For further details please refer to ticket: https://github.com/IATI/ckanext-iati/issues/349

andreaszenasidi commented 3 years ago

@gtkChop I completed the testing and found a few issues:

1. Remove the (required) from all fields where is currently added. Only the red asterisk should mark the required fields.

2. When you try to submit a new publisher account without filling any fields only 1 field is highlighted as missing Steps to reproduce:

3. When you fill in missing required fields the Missing value error message doesn't disappear Steps to reproduce:

4. 'Missing value' error message should be changed to 'Please fill required field'

5. All group header names are misaligned, should be inside the coloured box image

6. When an incorrect email address is entered the error message is not attached to the textbox and it's not marked with red, please see the screenshot below. image

7. Add 'Please Select' as the first option in the Type drop-down and mark this field required

8. The order of the fields do not follow the order from '3. Regroup fields meaningfully; name groups and fields meaningfully.'

9. The fields should be renamed according to the requirements from '3. Regroup fields meaningfully; name groups and fields meaningfully.' e.g. Type should be renamed Publisher Type

10. Update help text of the 'Frequency of publication' field from 'How often is IATI data refreshed?' to 'How often is IATI data refreshed? IATI recommends refreshing the data at least quarterly.'

11. Update the help text of the field Publisher Name from 'The Name of the Organisation publishing the data. to 'The Name of the organisation publishing the data.'

ss-bhat commented 3 years ago

@andreaszenasidi

Updated as per the above feeback. Please let me know if anything else needs to be changed. Thanks

andreaszenasidi commented 3 years ago

@gtkChop I am unable to test on staging. When I click 'Create Publisher Account' I get an Internal Server Error

image

ss-bhat commented 3 years ago

@andreaszenasidi Sorry my bad. Fixed it.

andreaszenasidi commented 3 years ago

@gtkChop thanks for fixing the issues. There is one small issue remaining, please rename the field Image URL to Publisher Logo URL

ss-bhat commented 3 years ago

@andreaszenasidi Fixed.

andreaszenasidi commented 3 years ago

@gtkChop Looks good. Thanks!

The deployment date for all 6 UX Enhancement tickets is set for January 26th.