Skip to content

Update links to deprecated domain name #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/guide_for_admins_and_devs.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,14 @@ Yet the EM Framework does not stand alone. Many of the features it provides are

As of January 2020, the repo contains 133 published modules. This large and growing collection is the database the EM Framework queries for module location and download. It allows the EM Framework to locate module upgrades suitable for a REDCap version and deliver them quickly and easily to the REDCap server.

The vetting process performed by the VUMC REDCap team adds value to the modules in the REDCap Repo. The review process covers the basics but also addresses some esoteric and essential details. Most importantly, for the immediate need, the module must _work_. It must enable without errors, have a meaningful title and description, and do what it claims to do. The source code for the module must be published for public review in a software repository at [github.com](https://github.com), and it must have an [open source software license](https://en.wikipedia.org/wiki/Open-source_license). The software must embrace coding styles that will make it reasonably easy to support as REDCap evolves. The software should also adopt REDCap's conventions for data access and data update where practicable. The module should follow the EM Framework and software industry conventions for describing its software dependencies. The module should follow REDCap and software industry conventions for securing access to data and software features, sanitizing input, and resisting attack. The full details of the current review guidelines are at [External Modules: Module Review Guidelines](https://redcap.vanderbilt.edu/consortium/modules/external_modules_review_guidelines.pdf)
The vetting process performed by the VUMC REDCap team adds value to the modules in the REDCap Repo. The review process covers the basics but also addresses some esoteric and essential details. Most importantly, for the immediate need, the module must _work_. It must enable without errors, have a meaningful title and description, and do what it claims to do. The source code for the module must be published for public review in a software repository at [github.com](https://github.com), and it must have an [open source software license](https://en.wikipedia.org/wiki/Open-source_license). The software must embrace coding styles that will make it reasonably easy to support as REDCap evolves. The software should also adopt REDCap's conventions for data access and data update where practicable. The module should follow the EM Framework and software industry conventions for describing its software dependencies. The module should follow REDCap and software industry conventions for securing access to data and software features, sanitizing input, and resisting attack. The full details of the current review guidelines are at [External Modules: Module Review Guidelines](https://redcap.vumc.org/consortium/modules/external_modules_review_guidelines.pdf)

The VUMC team's vetting process is not a guarantee of quality, but it _increases_ and _enables_ quality. The guidelines have specific details software developers can follow to improve the quality of their product. The guidelines also protect a module _user's_ ability and right to review module code, provide feedback to the developer, make improvements, and publish those improvements.


## Where to find modules

The REDCap Repo contains the most popular REDCap modules. The web interface for the repo is publicly accessible at [https://redcap.vanderbilt.edu/consortium/modules/index.php](https://redcap.vanderbilt.edu/consortium/modules/index.php). The repo's interface allows you to search the database of modules and sort the search results. It provides links to each module's git repo on github.com, which can give details on the state and history of the module.
The REDCap Repo contains the most popular REDCap modules. The web interface for the repo is publicly accessible at [https://redcap.vumc.org/consortium/modules/index.php](https://redcap.vumc.org/consortium/modules/index.php). The repo's interface allows you to search the database of modules and sort the search results. It provides links to each module's git repo on github.com, which can give details on the state and history of the module.

The REDCap Repo is also accessible from the REDCap Control Center's _External Module_ page. While all the features of the public page are also available from the Control Center link, the REDCap Repo will add links to download modules to the REDCap host when accessed via the Control Center.

Expand Down Expand Up @@ -177,7 +177,7 @@ Eventually, your work needs to be released, deployed, and published. Releasing i

Once you have a release, it needs to be _deployed_. You should deploy the new version at your site in a test instance and then in Production. These are the final steps to make sure the release is right.

If the deployments go well and you think you have something of interest to the REDCap community, you can share it via the [REDCap Repo](https://redcap.vanderbilt.edu/consortium/modules/index.php). There's a submission form by which you describe your module, its requirements, and where to find it. The VUMC REDCap Team will review your module. If the module passes review, VUMC will move it into the Repo. If VUMC finds any issues, they will send you feedback on how to improve your module. The REDCap Repo is the easiest way for members of the REDCap community to find, download, and enable your work.
If the deployments go well and you think you have something of interest to the REDCap community, you can share it via the [REDCap Repo](https://redcap.vumc.org/consortium/modules/index.php). There's a submission form by which you describe your module, its requirements, and where to find it. The VUMC REDCap Team will review your module. If the module passes review, VUMC will move it into the Repo. If VUMC finds any issues, they will send you feedback on how to improve your module. The REDCap Repo is the easiest way for members of the REDCap community to find, download, and enable your work.

While the REDCap Repo is the best way to manage the technical sharing of a module within the REDCap community, this doesn't quite meet the requirements of the academic community. Academics value publications and citations. Fortunately, there are tools to bridge the gap between a software repository and a citation. A digital object identifier or _DOI_ is a unique identifier for a document, dataset, image, software package, or other data type. Typically DOIs identify online objects. They are well-respected in the academic, scientific, and governmental communities. There are online service providers that will generate, register, and curate DOIs for your creative works. One of these providers, [zenodo.org](https://zenodo.org/), has excellent integration with GitHub. Once you make the linkage between a GitHub repo and Zenodo, Zenodo will make a DOI and citation for the repo. Future GitHub releases will automatically get a new citable DOI in Zenodo. Cite these DOIs in academic articles, posters, grant applications, and sponsor reports, as you would with any other publication.

Expand Down
2 changes: 1 addition & 1 deletion docs/guide_for_devs.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You will likely find it helpful to keep Vanderbilt's [official External Module d

### REDCap Repo

Vanderbilt publishes modules submitted by the REDCap Community in the [REDCap Repo](https://redcap.vanderbilt.edu/consortium/modules/index.php). The source code for each module is accessible in GitHub and linked from the entries in the REDCap Repo. These modules provide fully functional code examples. As each module in the REDCap Repo must have an open-source license, you are free to use their code in other modules.
Vanderbilt publishes modules submitted by the REDCap Community in the [REDCap Repo](https://redcap.vumc.org/consortium/modules/index.php). The source code for each module is accessible in GitHub and linked from the entries in the REDCap Repo. These modules provide fully functional code examples. As each module in the REDCap Repo must have an open-source license, you are free to use their code in other modules.


### GitHub
Expand Down