Skip to content
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

Add MIT license file and guidance for more license files #10426

Merged
merged 11 commits into from
May 8, 2024
3 changes: 3 additions & 0 deletions doc/release-notes/10425-add-MIT-License.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
A new file has been added to import the MIT License to Dataverse: licenseMIT.json.

Documentation has been added to explain the procedure for adding new licenses to the guides.
25 changes: 25 additions & 0 deletions doc/sphinx-guides/source/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1858,6 +1858,31 @@ JSON files for `Creative Commons licenses <https://creativecommons.org/about/ccl

.. _adding-custom-licenses:

Adding Software Licenses
^^^^^^^^^^^^^^^^^^^^^^^^

JSON files for software licenses are provided below.

- :download:`licenseMIT.json <../../../../scripts/api/data/licenses/licenseMIT.json>`
- :download:`licenseApache-2.0.json <../../../../scripts/api/data/licenses/licenseApache-2.0.json>`

Contributing to the Collection of Standard Licenses Above
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you do not find the license JSON you need above, you are encouraged to contribute it to this documentation. Following the Dataverse 6.2 release, we have standardized on the following procedure:

- Look for the license at https://spdx.org/licenses/
- ``cd scripts/api/data/licenses``
- Copy an existing license as a starting point.
- Name your file using the SPDX identifier. For example, if the identifier is ``Apache-2.0``, you should name your file ``licenseApache-2.0.json``.
- For the ``name`` field, use the "short identifier" from the SPDX landing page (e.g. ``Apache-2.0``).
- For the ``description`` field, use the "full name" from the SPDX landing page (e.g. ``Apache License 2.0``).
- For the ``uri`` field, we encourage you to use the same resource that DataCite uses, most of the times this will be the same than the first provided resource on SPDX, but please get in contact with us if you have any questions on the cominity group.
jp-tosca marked this conversation as resolved.
Show resolved Hide resolved
- For the ``active`` field, put ``true``.
- For the ``sortOrder`` field, put the next sequention number after checking previous files with ``grep sortOrder scripts/api/data/licenses/*``.
jp-tosca marked this conversation as resolved.
Show resolved Hide resolved

Note that prior to Dataverse 6.2, various license above have been added that do not adhere perfectly with this procedure. For example, the ``name`` for the CC0 license is ``CC0 1.0`` (no dash) rather than ``CC0-1.0`` (with a dash). We are keeping the existing names for backward compatibility. For more on standarizing license configuration, see https://github.com/IQSS/dataverse/issues/8512
jp-tosca marked this conversation as resolved.
Show resolved Hide resolved

Adding Custom Licenses
^^^^^^^^^^^^^^^^^^^^^^

Expand Down
8 changes: 8 additions & 0 deletions scripts/api/data/licenses/licenseApache-2.0.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "Apache-2.0",
"uri": "https://www.apache.org/licenses/LICENSE-2.0",
jp-tosca marked this conversation as resolved.
Show resolved Hide resolved
"shortDescription": "Apache License 2.0",
"active": true,
"sortOrder": 9
}

7 changes: 7 additions & 0 deletions scripts/api/data/licenses/licenseMIT.json
jp-tosca marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "MIT",
"uri": "https://opensource.org/license/mit/",
jp-tosca marked this conversation as resolved.
Show resolved Hide resolved
"shortDescription": "MIT License",
"active": true,
"sortOrder": 8
}
Loading