Skip to content

Commit 506b0ed

Browse files
pdurbinpdurbin
authored
Merge pull request #11522 from philippconzett/11521-add-new-standard-licenses
Add EUPL-1.2, ODbL-1.0, ODC-By-1.0, PDDL-1.0, and OGL-UK-3.0 to the list of standard licenses, clarify add license docs
2 parents 2dcf3ff + 1699c01 commit 506b0ed

7 files changed

Lines changed: 101 additions & 8 deletions

File tree

‎doc/release-notes/11522-licenses-added.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Additional licenses
2+
3+
The following Open Data Commons licenses have been added:
4+
5+
- Open Database License (ODbL)
6+
- Open Data Commons Attribution License (ODC-By)
7+
- Open Data Commons Public Domain Dedication and License (PDDL))
8+
9+
The following software license has been added:
10+
11+
- European Union Public License (EUPL)
12+
13+
The following country-specific license has been added:
14+
15+
- Open Government Licence (OGL UK)
16+
17+
The licenses above are widely recognized and used in Europe and beyond to promote data and software sharing. See [the guides](https://dataverse-guide--11522.org.readthedocs.build/en/11522/installation/config.html#configuring-licenses) and #11522.

‎doc/sphinx-guides/source/installation/config.rst‎

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2132,35 +2132,56 @@ JSON files for `Creative Commons licenses <https://creativecommons.org/about/ccl
21322132

21332133
.. _adding-custom-licenses:
21342134

2135+
Adding Open Data Commons Licenses
2136+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2137+
2138+
JSON files for `Open Data Commons licenses <https://opendatacommons.org/licenses/>`_ are provided below.
2139+
2140+
- :download:`licenseODbL-1.0.json <../../../../scripts/api/data/licenses/licenseODbL-1.0.json>`
2141+
- :download:`licenseODC-By-1.0.json <../../../../scripts/api/data/licenses/licenseODC-By-1.0.json>`
2142+
- :download:`licensePDDL-1.0.json <../../../../scripts/api/data/licenses/licensePDDL-1.0.json>`
2143+
21352144
Adding Software Licenses
21362145
^^^^^^^^^^^^^^^^^^^^^^^^
21372146

21382147
JSON files for software licenses are provided below.
21392148

2140-
- :download:`licenseMIT.json <../../../../scripts/api/data/licenses/licenseMIT.json>`
21412149
- :download:`licenseApache-2.0.json <../../../../scripts/api/data/licenses/licenseApache-2.0.json>`
2150+
- :download:`licenseMIT.json <../../../../scripts/api/data/licenses/licenseMIT.json>`
2151+
- :download:`licenseEUPL-1.2.json <../../../../scripts/api/data/licenses/licenseEUPL-1.2.json>`
21422152

21432153
Adding Country-Specific Licenses
21442154
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
21452155

21462156
- :download:`licenseEtalab-2.0.json <../../../../scripts/api/data/licenses/licenseEtalab-2.0.json>` used in France (Etalab Open License 2.0, CC-BY 2.0 compliant).
2157+
- :download:`licenseOGL-UK-3.0.json <../../../../scripts/api/data/licenses/licenseOGL-UK-3.0.json>`
21472158

21482159
Contributing to the Collection of Standard Licenses Above
21492160
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
21502161

2151-
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:
2162+
If you do not find the license JSON you need above, you are encouraged to contribute it to this documentation. Following the Dataverse 6.9 release, we have standardized on the following procedure:
21522163

2153-
- Look for the license at https://spdx.org/licenses/
2154-
- ``cd scripts/api/data/licenses``
2164+
- Look for the license at https://spdx.org/licenses/ and https://github.com/datacite/bracco/blob/main/app/spdx.js.
2165+
- ``cd scripts/api/data/licenses``.
21552166
- Copy an existing license as a starting point.
21562167
- 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``.
21572168
- For the ``name`` field, use the "short identifier" from the SPDX landing page (e.g. ``Apache-2.0``).
2158-
- For the ``description`` field, use the "full name" from the SPDX landing page (e.g. ``Apache License 2.0``).
2159-
- For the ``uri`` field, we encourage you to use the same resource that DataCite uses, which is often the same as the first "Other web pages for this license" on the SPDX page for the license. When these differ, or there are other concerns about the URI DataCite uses, please reach out to the community to see if a consensus can be reached.
2169+
- For the ``shortDescription`` field, use the "full name" from the SPDX landing page (e.g. ``Apache License 2.0``) followed by a period (full-stop) (e.g. ``Apache License 2.0.``).
2170+
- For the ``uri`` field, use the same resource that DataCite uses, which is often the same as the first "Other web pages for this license" on the SPDX page for the license. Look at the ``seeAlso`` array for the license at https://github.com/datacite/bracco/blob/main/app/spdx.js to be sure. When these differ, or there are other concerns about the URI DataCite uses, please reach out to the community to see if a consensus can be reached. See :ref:`support`.
21602171
- For the ``active`` field, put ``true``.
21612172
- For the ``sortOrder`` field, put the next sequential number after checking previous files with ``grep sortOrder scripts/api/data/licenses/*``.
2162-
2163-
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
2173+
- For the ``rightsIdentifier`` field, use the "short identifier" from the SPDX landing page (e.g. ``Apache-2.0``).
2174+
- For the ``rightsIdentifierScheme`` field, use "SPDX".
2175+
- For the ``schemeUri`` field, use "https://spdx.org/licenses/".
2176+
- For the ``languageCode`` field, use "en".
2177+
- For all of the fields above, resist the urge to change the spelling of words like license/licence, center/centre, etc. SPDX is the upstream authority, and they have the following `varietal word spelling policy <https://github.com/spdx/license-list-XML/blob/v3.27.0/DOCS/license-matching-guidelines-and-templates.md#8-varietal-word-spelling->`_: "The words in each line of the text file available at https://spdx.org/licenses/equivalentwords.txt are considered equivalent and interchangeable."
2178+
2179+
In the past, licenses have been added that do not adhere perfectly with the procedure above. Here are known inconsistencies:
2180+
2181+
- The ``name`` for the CC licenses don't have a dash as their SPDX short identifiers do (e.g. CC-BY-4.0, CC-BY-NC-4.0, CC-BY-NC-ND-4.0, CC-BY-NC-SA-4.0, CC-BY-ND-4.0, CC-BY-SA-4.0, CC0-1.0). 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 without dashes for backward compatibility.
2182+
- The ``uri`` for Creative Commons licenses comes from the Creative Commons website rather than SPDX or DataCite. As with ``name``, we are keeping ``uri`` the as-is for these licenses for backward compatibility. For more on our attempts to standardize license configuration, see https://github.com/IQSS/dataverse/issues/8512 and https://github.com/IQSS/dataverse/pull/11522.
2183+
- The ``uri`` for Etalab is https://spdx.org/licenses/etalab-2.0 rather than a link listed in SPDX or DataCite.
2184+
- The ``shortDescription`` doesn't have a trailing period for Apache-2.0, Etalab, and MIT.
21642185

21652186
Adding Custom Licenses
21662187
^^^^^^^^^^^^^^^^^^^^^^

‎scripts/api/data/licenses/licenseEUPL-1.2.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "EUPL-1.2",
3+
"uri": "https://joinup.ec.europa.eu/page/eupl-text-11-12",
4+
"shortDescription": "European Union Public License 1.2.",
5+
"active": true,
6+
"sortOrder": 14,
7+
"rightsIdentifier": "EUPL-1.2",
8+
"rightsIdentifierScheme": "SPDX",
9+
"schemeUri": "https://spdx.org/licenses/",
10+
"languageCode": "en"
11+
}

‎scripts/api/data/licenses/licenseODC-By-1.0.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "ODC-By-1.0",
3+
"uri": "https://opendatacommons.org/licenses/by/1.0/",
4+
"shortDescription": "Open Data Commons Attribution License v1.0.",
5+
"active": true,
6+
"sortOrder": 12,
7+
"rightsIdentifier": "ODC-By-1.0",
8+
"rightsIdentifierScheme": "SPDX",
9+
"schemeUri": "https://spdx.org/licenses/",
10+
"languageCode": "en"
11+
}

‎scripts/api/data/licenses/licenseODbL-1.0.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "ODbL-1.0",
3+
"uri": "http://www.opendatacommons.org/licenses/odbl/1.0/",
4+
"shortDescription": "Open Data Commons Open Database License v1.0.",
5+
"active": true,
6+
"sortOrder": 11,
7+
"rightsIdentifier": "ODbL-1.0",
8+
"rightsIdentifierScheme": "SPDX",
9+
"schemeUri": "https://spdx.org/licenses/",
10+
"languageCode": "en"
11+
}

‎scripts/api/data/licenses/licenseOGL-UK-3.0.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "OGL-UK-3.0",
3+
"uri": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3",
4+
"shortDescription": "Open Government Licence v3.0.",
5+
"active": true,
6+
"sortOrder": 15,
7+
"rightsIdentifier": "OGL-UK-3.0",
8+
"rightsIdentifierScheme": "SPDX",
9+
"schemeUri": "https://spdx.org/licenses/",
10+
"languageCode": "en"
11+
}

‎scripts/api/data/licenses/licensePDDL-1.0.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "PDDL-1.0",
3+
"uri": "http://opendatacommons.org/licenses/pddl/1.0/",
4+
"shortDescription": "Open Data Commons Public Domain Dedication & License 1.0.",
5+
"active": true,
6+
"sortOrder": 13,
7+
"rightsIdentifier": "PDDL-1.0",
8+
"rightsIdentifierScheme": "SPDX",
9+
"schemeUri": "https://spdx.org/licenses/",
10+
"languageCode": "en"
11+
}

0 commit comments

Comments
 (0)