v2.1.7

• Bug fix for Shibboleth logins that were creating an empty record in the user_identifiers table

v2.1.6

Upgrade Process

• Run bundle install to update your rubygems dependancies
• Run rake assets:precomipile to update your webpack assets and dependancies
• The content of statistics objects has been restructured, and will need to be re-run for all previous months. Use rake stat:build or rake stat:build_parallel to update these. NOTE: this can take a long time to run if not parallel. See comments below around connection pooling if you hit issues with the parallel tasks

Changes

Researchers

• The option to create a copy of an existing DMP is now called "Copy". #2418

Org-admins

• It's now possible to select a comma ,, pipe, |, or hash # characters as your delimiter for CSV exports from the usage dashboard. #2375
• It's no longer possible to download an overview of tool usage from the usage dashboard. #2345
• It's possible to download a CSV with statistics on your New Plans, New Users, Downloads, and Plans Shared broken down by month from the usage dashboard. #2345
• There is an additional accordion on the usage dashboard to show statistics on how your templates are used (by all organisations) #1682
• Admins from Funder orgs have their usage-dashboard replaced with the statistics on their template usage (detailed above). #1682
• The CSV export of users now includes the School/Department field. #2213

Bugfixes

• Headers now follow hierarchical order, fixes an accessibility issue for screen-readers. #1451
• Org-admins can now view plans shared by users of different organisations. #2415
• The super-admin list of plans no longer throws an error when a plan's owner does not exist. #2428
• The 'Opens in a new Window' tool-tip is no longer truncated on links within guidance. #2305
• tinymce content css no longer fails to load. #2379

Security

• Update nokogiri to 1.10.8
• Fix for XSS vulnerability. #2437
• Update Karma to 4.4.1

Developer Notes

• Lots of changes to ensure GitHub workflows/tests are working correctly
• Removed the feedjira Gem as it was un-used by the DMPRoadmap project. If your customization depended on the gem, see the suggested fix by @benjaminfaure in #2411
• The statistics rake-tasks are now able to be run in parallel to reduce the runtime. Use rake stat:build_parallel and rake stat:build_last_month_parallel. NOTE: there must be as many database connections available to Rails as total threads attempting to make connection, as such, you may need to increase your pool size in config/database.yml. The default in config/database.yml.sample has been changed to 16
• It's now possible to use js.erb files from the asset-pipeline. See PR #2379 for an example of usage

v2.1.5

Release Notes V2.1.5

​

Upgrade Process

A few dependencies were updated so you will need to run a bundle install and a yarn install to update your assets
​

Changes

​

Researchers

• When exporting a DMP, the coversheet will separately list the template and funder names #2371
• Browser-spellcheck is now enabled in all text boxes #2169
• You can now create a plan from the Funder Requirements or Public DMPs tab #2296
• Copied plans now behave like normal plans when requesting feedback #2180
  ​

Org-admins

Usage Dashboard

• The plans_by_template chart counts now add up to the monthly plans chart counts. There was a bug where non-customised funder-templates would not be included. #2083
• Fixed a bug where the 9 and 12 month views of the plans by template chart would sometimes fail to display #2119

​

API

• Test-plans are now flagged in the API output of the /api/v0/plans and /api/statistics/plans endpoints #2388
• Test-plans can now be filtered from the output of the same two endpoints by passing emove_tests=true as a parameter #2388
• The API now handles empty and invalid dates #2116
  ​

Bugfixes

• Users language no longer defaults to the first language returned by the database upon editing their profile for the first time #2362
• TinyMCE labels now display properly for screenreaders #1449
• Users must now accept the Terms and Conditions when signing up to the tool #2341
  ​

Security

Gem dependency updates: rack, excon
Yarn dependency updates: tinymce, js-yaml

v2.1.4

General

• All of the text area fields will now provide spellcheck (browser dependent) #2169
• We moved the 'Request Feedback' button to its own tab #2234
• Fixed a bug with the progress bars on the write plan page for plans with multiple phases (e.g. Horizon2020) #2095
• Updated Português (Brasil) translations #2303
• Template published date now shows the date the template was published #2199
• Fixed a bug that was preventing some users from updating their profile #2208
• Clicking your institution's logo no longer brings you to your institution's website #2173
• You can now create a plan for a specific public template by clicking on the icon in the public templates page instead of going through the create plan page (you can also copy the link to do this) #2284

Accessibility

• Links, buttons, table cells and fields now show a visible cue when they have focus #2206, #2230
• A new 'Opens in a new window' tooltip appears when selecting or hovering over a link that goes to a different site #2211
• Now providing alternate text as well as tooltips for assistive technologies like screen readers #2222
• Addressed some issues encountered when using zoomText or Windows Magnifier #2223
• Fixed some accessibility issues with tables #2253
• Fixed an issue where radio button labels were not correctly associated with their radio buttons #2273
• The Guidance and Comments tabs when editing a plan are now accessible by keyboard #2283

PDF Downloads

• Fixed an issue with long plan title's #2251
• Fixed an issue with non-latin characters #2249
• Fixed an issue with the display of some bullet points #2147

Org Admins

• You can now define departments for your Organization (e.g. 'School of Engineering')
• Added user's 'department' and their 'number of plans' to the Users table #2266
• You can now export your own templates #2091
• Fixed some issues with searching on table #2236
• Fixed a bug that was causing errors when sorting guidance #2207
• Fixed a bug when changing a template's visibility (only effected organizations that are both a funder and an organization) #2264

Super Admins

• You can now merge user accounts on the Admin -> Users page #2245, #2224
• You can now archive a user account. The account is anonymized so that all personal information for the user is no longer available. Their plans and comments remain. #2224
• Fixed an issue with updating an organization's shibboleth entityID (only applicable to installations that filter the list of organizations that can use institutional login) #2289

API

• The full text API is now filterable by user ids, template ids or plan ids #2293

Developers

• Updated gem and JS dependencies
• Cleaned up deprecated methods in the Rspec tests #2258
• Fixed an issue where annotations were being added to removed questions #2216
• Updated cookie serialization from hybrid to JSON #2256 Note this may invalidate any very old user cookies
• New branding.yml attribute for the suffix to use when 'anonymizing' a user account. Make sure you update your copy of the branding.yml file (e.g. archived_accounts_email_suffix: '@removed_accounts-dmproadmap.org'). Rather than an account being deleted from the system, it will be anonymized using the email domain you enter here. This prevents records from being orphaned in the DB.
• There is a new JS variable called OPENS_IN_A_NEW_WINDOW_TEXT that you should ensure is part of your views/layouts/application.html.erb file (if you have replaced the default with your own)

V2.1.3

v2.1.3

Upgrade Process:

• add the api_max_page_size key to your config/branding.yml, see config/branding.yml.sample
• run rake upgrade:v2_1_3 to:
  • fill blank plan_identifier fields with the ID for the plan
  • add the Reviewer permission to the database
  • Make all org-admins into reviewers
  • Remove the old reviewer Roles
• Make sure you bundle install and yarn install to get all dependancies up-to-date
• Run rake db:migrate to add the new table and fields for the departments

Changes:

Researchers

• Updated date-format in footer of PDF Export to be unambigious
• Pre-fill the plan's Identifier with it's ID
• Horison 2020 plan now lets you select your grant-id via a typeahead, pre-filled with active projects
• Edit-times on comments are now in 'time-ago' instead of displaying in UCT
• You can now add a school or department to your profile

Org-Admins

• Reviewer is now an admin permission, you should now have this permission
• You can now add schools or departments (and set a label for your organisation's sub-divisions) for your users to select & add to their profile
• To publish, Templates now must have phases; phases, a section; sections a question
• 'Share Plan' page now viewable for your org's plans

Super-admins

• 'Share Plan' page now visible
• Reviewer now a permission, you will see the organisation you are associated with's plans, changing when you change organisation.

Bugfixes

• RDA Metadata Standards question now working
• Users with capital letters in their emails can be invited to plans
• Template export shows error messaging for bad IDs
• blank answer.text no longer causes csv and text export to throw an error

Security

• Updated versions for gems and JS dependancies to patch security issues
• Added gem to patch Omniauth vunlerability CVE-2015-9284

v2.1.2

Upgrade Process

• Update the text of config/branding.yml to set the following (see #2059):

preferences:
      email:
          users:
              new_comment: false

• Run rake upgrade:v2_1_2 to add the Date question type
• Run rake stat:build to update your generated statistics

Changes

Researchers

• Long links in Guidances now wrap in all browsers #1876
• Clarified error messaging when updating user profile #1749
• Improved formatting of Question/Answer in plan downloads #1893
• Updated Request feedback text to show user/plan name, instead of placeholders #2047
• Only show Guidance selections on Project Details page when the Plan has applicable Guidance #2020
• Updated CSV download formatting to include comments and strip text formatting instead of representing line-breaks as semicolons #2058
• Expand/collapse all links only show on the guidance tab when there are multiple guidances #2049
• Updated preferences to not notify of new comments by default #2059
• Comment notification text updated to link-out to plan tab, and list question and section #1872
• Improved Table Formatting in Example Answers, Questions, Default Answers, Guidance, Answers, and Comments #2071
• Searches over tables are now case-insensitive #2080

Org-Admins

• Org-admins cannot become reviewers of their own plans #2009
• When reviewing a plan, Answers are rendered in HTML, so always display in full #1683
• Template names in tables are now a link to the template details page #1182
• Themed guidance displays on all template previews #1209
• Added missing Date question type #1158
• Usage Dashboard report now shows the number of plans, grouped by template used (also available via the API) #1679

Accessibility

• Request feedback confirmation now accessible to screen-readers #1447

Bugfixes

• UTF no longer breaking PDF footer, solution contributed by @benjaminfaure #73
• Tables Default sorting is no longer removed by clicking 'View All' or 'View Less' #2027
• Javascript now compiles to work in IE

v2.1.1

This release includes some significant restructuring of the codebase's stylesheets. Please review your local customizations before deploying to your production environment. Information on the new Stylesheet organization can be found in the Branding wiki.

Also please note that assets have been moved from the lib/assets/ directory to app/assets directory. We are no longer using nom and webpack directly but instead are now using the Webpacker gem. Please use the standard rake assets:precompile to compile your assets.

You should also run rake upgrade:v2_1_0 which will make sure that any plans in your system that do not have at least one owner/co-owner/editor are set to 'private' visibility and any remaining reviewer/commenter roles are deactivated.

Admins:

• Fixed an issue when viewing a plan in read-only mode that prevented you from seeing the entire answer #1683
• Fixed an issue with the sorts on the admin's Users page #2016
• Fixed an inconsistency between the number of plans reported on the Usage Statistics page #1703
• The text field is now required when creating or editing a template question #1725
• The remove plan function will now deactivate the plan if it no longer has any owner, co-owner or editor. This will also remove it from the organizational plans list #1663

Researchers:

• Tooltips on the Create Plan page now appear below the textboxes instead of to the right where they hid the checkboxes from view #1161
• Guidance selection options are no longer displayed if the plan you are working with has no applicable themed guidance that would be relevant #2020
• Fixed an issue with the way the feedback request button appeared on the Share Plan page #2012
• Fixed an issue with account creation via Shibboleth (Institutional credentials) #2014
• All external links now open in a new tab/window #2005
• Fixed an issue when downloading institutional plans as a PDF #2001
• Fixed an issue that was preventing users from creating an account when a plan had been shared with them #1986
• The links to download plans and templates are now icons #1164

Developers:

• Updated the wiki Branding, Installation and Troubleshooting pages to reflect changes to asset management
• Added support for storing organizational logos in an S3 bucket instead of on disk #1976

v2.1.0

Please refer to release v2.1.1 which addresses a minor bug found in the upgrade:v2_1_0 script

v2.0.0

Upgrade Process

This release introduces so major changes to the way we ensure our data is valid. The upgrade process is detailed on the wiki: https://github.com/DMPRoadmap/roadmap/wiki/Upgrading-from-v1.x-to-2.0.0

Changes

OrgAdmins

• Template Sections can now be re-organised via drag-and-drop
• Changed message text for flash notice when removing User permissions (#1880)
• Added button to download list of CSV users (#1754)
• Added status for total org users and plans (#1760)

Researchers

• Comments are now visible by default, without having to click "Show" (#1873)
• Updated text labels on form buttons for better clarity (#1781)
• Removed multi-select box as an answer format (#1771)

Developers

• Normalised asset compilation. Now you can use rake assets:precompile to build JS and CSS assets.
• Consolodated and simplified JS code.
  This commit removes duplication in the JS code, making it simpler and easier to manage (#1752)
• Added new System-wide configuration for plan readability. Developers can now set whether org admins may view each plan within their org or not, via branding.yml
• Added Bullet gem to identify sub-optimal database queries in development mode #1675
• Replaced MiniTest suite with RSpec (#1664)
• Installed Capybara and Selenium for integration tests #1668
• Removed unused methods from models #1572
• Add additional validations to ActiveRecord models
  NOTE: This will require you to run some rake tasks to ensure your own data is valid. Please view this README for more information (#1572)
• Installed Annotate gem for automated comments in Gemfile and models (#1672)
• Renamed deprecated deliver methods to deliver_now (#1695)
• Replaced fixtures with FactoryBot factories for tests (#1651)
• Added Faker gem for better factory test data (#1666)
• Added Shoulda gem for cleaner tests
• Removed attr_accessible from models and added strong params to controllers (#100)
• The BetterSpecs.org is now our standard guide for writing tests (#1665)
• Replaced instances of raw method with sanitize for safer HTML escaping (#532)
• Removed unused accessibility link from layout footer (#1734)
• Removed number field from sections form (#1371)

Bug fixes

• Fixed bug preventing users from adding new questions (#1723)
• Fixed CSS bug causing page footer to overlap when page content is long (#1300)
• Fixed bug on plan downloads that was ignoring the user-defined configurations (#1730)
• Fixed bug when downloading a public or org DMP (#1841, #1785)
• Fixed bug on user org change that ensures other_organization column is reset (#1736)
• Fixed bug preventing super-admin from switching orgs (#1835)
• Fixed the layout of annotations within questions (#1833)
• Fixed bug preventing users from requesting feedback on a plan (#1845)
• Fixed bug affecting the display order of sections within templates (#1371)
• Fixed instances where TinyMCE would not load when added by Ajax (#1777)
• Fixed bug showing the wrong value for "Not customised" templates (#1815)
• Fixed bug showing guidance with multiple themes multiple times (#1755)
• Fixed bug showing incorrect display name for guidance subgroups (#1409)
• Fixed bug causing org dropdown on sign-up form to be empty when is_other is false (#1809)
• Fixed bug breaking autosave on TinyMCE forms (#1878)
• Fixed bug preventing org admin from turning on feedback (#1877)

v1.1.4

Researchers

• When a user shares a plan with a colleague the email will now display the user's name #1587

Org Admins

• Option based template questions (e.g. select box, radio buttons, etc.) now allow for an unlimited number of choices #1640
• You can now associate guidance with multiple themes again #1742
• Updates to the 'Request Expert Feedback' functionality:
  • Improved tooltip language to help clarify the purpose of items on the Admin -> Organization details -> Request Feedback tab #1722
  • The system now displays the 'Request Feedback Message' to your users on-screen instead of sending them an email #1163
  • Updated the 'Request Feedback complete' email to include clearer instructions on how the user can find your comments and a direct link to the appropriate page #1431 & #1492

Bug Fixes

• Addressed an issue that some users were encountering when trying to change their email address #1714
• Addressed an issue that caused Shibboleth IdP information to be lost when editing an Org's request feedback options #1732
• Fixed an issue with Guidance page form validations #1629
• Users can now click the 'Show password' checkbox on the create account form #1702
• Theme selections are no longer deleted when an admin adds annotations/customizations to a question #1684
• Fixed issue preventing users from submitting the create account form #1680

Accessibility

• Groups of Check boxes and Radio buttons are now properly nested within <fieldset> tags #1448

General Improvements

• Decreased vertical white space between themes on the Guidance and Question editing sections #1708
• Updated Tinymce calls so that they all us a standard set of toolbar options #1632