Skip to content

Commit e2ae1d7

Browse files
pdurbinpdurbin
committed
claify "add license" procedure and make incoming licenses comply #11521 
1 parent 0a215c5 commit e2ae1d7

File tree

6 files changed

+17
-11
lines changed

6 files changed

+17
-11
lines changed

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2159,23 +2159,29 @@ Adding Country-Specific Licenses
21592159
Contributing to the Collection of Standard Licenses Above
21602160
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
21612161

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.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:
21632163

2164-
- Look for the license at https://spdx.org/licenses/.
2164+
- Look for the license at https://spdx.org/licenses/ and https://github.com/datacite/bracco/blob/main/app/spdx.js.
21652165
- ``cd scripts/api/data/licenses``.
21662166
- Copy an existing license as a starting point.
21672167
- 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``.
21682168
- For the ``name`` field, use the "short identifier" from the SPDX landing page (e.g. ``Apache-2.0``).
21692169
- 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, 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.
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`.
21712171
- For the ``active`` field, put ``true``.
21722172
- For the ``sortOrder`` field, put the next sequential number after checking previous files with ``grep sortOrder scripts/api/data/licenses/*``.
21732173
- For the ``rightsIdentifier`` field, use the identifier from SPDX (e.g. ``Apache-2.0``).
21742174
- For the ``rightsIdentifierScheme`` field, use "SPDX".
21752175
- For the ``schemeUri`` field, use "https://spdx.org/licenses/".
21762176
- 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."
21772178

2178-
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
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.
21792185

21802186
Adding Custom Licenses
21812187
^^^^^^^^^^^^^^^^^^^^^^

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "EUPL-1.2",
33
"uri": "https://joinup.ec.europa.eu/page/eupl-text-11-12",
4-
"shortDescription": "European Union Public License 1.2",
4+
"shortDescription": "European Union Public License 1.2.",
55
"active": true,
66
"sortOrder": 14,
77
"rightsIdentifier": "EUPL-1.2",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "ODC-By-1.0",
33
"uri": "https://opendatacommons.org/licenses/by/1.0/",
4-
"shortDescription": "Open Data Commons Attribution License v1.0",
4+
"shortDescription": "Open Data Commons Attribution License v1.0.",
55
"active": true,
66
"sortOrder": 12,
77
"rightsIdentifier": "ODC-By-1.0",
88
"rightsIdentifierScheme": "SPDX",
99
"schemeUri": "https://spdx.org/licenses/",
1010
"languageCode": "en"
11-
}
11+
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "ODbL-1.0",
33
"uri": "http://www.opendatacommons.org/licenses/odbl/1.0/",
4-
"shortDescription": "Open Data Commons Open Database License v1.0",
4+
"shortDescription": "Open Data Commons Open Database License v1.0.",
55
"active": true,
66
"sortOrder": 11,
77
"rightsIdentifier": "ODbL-1.0",
88
"rightsIdentifierScheme": "SPDX",
99
"schemeUri": "https://spdx.org/licenses/",
1010
"languageCode": "en"
11-
}
11+
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "OGL UK 3.0",
2+
"name": "OGL-UK-3.0",
33
"uri": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3",
44
"shortDescription": "Open Government Licence v3.0.",
55
"active": true,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "PDDL-1.0",
33
"uri": "http://opendatacommons.org/licenses/pddl/1.0/",
4-
"shortDescription": "Open Data Commons Public Domain Dedication & License 1.0",
4+
"shortDescription": "Open Data Commons Public Domain Dedication & License 1.0.",
55
"active": true,
66
"sortOrder": 13,
77
"rightsIdentifier": "PDDL-1.0",

0 commit comments

Comments
 (0)