Developed by the Digital Research Alliance of Canada (the Alliance) in collaboration with host institution University of Alberta, DMP Assistant repo is a fork of the current state of the main DMP Roadmap codebase, which is management and developed jointly provided by the Digital Curation Centre (DCC) and the University of California Curation Center (UC3).
- DMP Assistant will upgrade to Version 3 in Q1 2022
The DMP Assistant is a national, online, bilingual data management planning tool developed by the Digital Research Alliance of Canada (the Alliance) in collaboration with host institution University of Alberta to assist researchers in preparing data management plans (DMPs). This tool is freely available to all researchers, and develops a DMP through a series of key data management questions, supported by best-practice guidance and examples.
The DMP Assistant was adapted from the Digital Curation Centre (DCC)’s DMPonline tool, and uses the DMP Roadmap codebase developed by DCC and the University of California Curation Center (UC3).
See the Installation Guide on the Wiki.
DMP Assistant is a Ruby on Rails application and you will need to have:
- Ruby = 2.7.6
- Rails = 6.1
- MySQL >= 5.0 OR PostgreSQL
Further detail on how to install Ruby on Rails applications are available from the Ruby on Rails site: http://rubyonrails.org.
Further details on how to install MySQL and create your first user and database. Be sure to follow the instructions for your particular environment.
- Install: http://dev.mysql.com/downloads/mysql/
- Create a user: http://dev.mysql.com/doc/refman/5.7/en/create-user.html
- Create the database: http://dev.mysql.com/doc/refman/5.7/en/creating-database.html
You may also find the following resources handy:
- The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
- Ruby on Rails Tutorial Book: http://www.railstutorial.org/
See the Troubleshooting Guide on the Wiki.
-
Any question about DMP Assistant can be emailed to dmp-assistant@tech.alliancecan.ca. A team member will follow-up with you soon.
-
Issues should be reported here on Github Issues. Please be advised though that we can only provide limited support for your local installations. Any security patches and bugfixes will be applied to the most recent version, and we will endeavour to support migrations to the current release.
DMP Roadmap is a Data Management Planning tool. Management and development of DMP Roadmap is jointly provided by the Digital Curation Centre (DCC), http://www.dcc.ac.uk/, and the University of California Curation Center (UC3), http://www.cdlib.org/services/uc3/.
The tool has four main functions:
- To help create and maintain different versions of Data Management Plans;
- To provide useful guidance on data management issues and how to meet research funders' requirements;
- To export attractive and useful plans in a variety of formats;
- To allow collaborative work when creating Data Management Plans.
If you would like to contribute to the project. Please follow these steps to submit a contribution:
- Comment on the Github issue (or create one if one does not exist) and let us know that you're working on it.
- Fork the project (if you have not already) or rebase your fork so that it is up to date with the current repository's 'integration' branch
- Create a new branch in your fork. This will ensure that you are able to work at your own pace and continue to pull in any updates made to this project.
- Make your changes in the new branch
- When you have finished your work, make sure that your version of the 'integration' branch is still up to date with this project. Then merge your new branch into your 'integration' branch.
- Then create a new Pull Request (PR) from your branch to this project's 'integration' branch in GitHub
- The project team will then review your PR and communicate with you to convey any additional changes that would ensure that your work adheres to our guidelines.
See the Contribution Guide for more information.
