From 2a3f90df3ac794c73c8c9346f71d9683a8174d5e Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Mon, 25 Mar 2024 14:34:57 -0400 Subject: [PATCH 01/10] Add MIT Lincense --- scripts/api/data/licenses/licenseMIT.json | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 scripts/api/data/licenses/licenseMIT.json diff --git a/scripts/api/data/licenses/licenseMIT.json b/scripts/api/data/licenses/licenseMIT.json new file mode 100644 index 00000000000..ac00b9aac0e --- /dev/null +++ b/scripts/api/data/licenses/licenseMIT.json @@ -0,0 +1,8 @@ +{ + "name": "MIT License", + "uri": "https://spdx.org/licenses/MIT.html", + "shortDescription": "MIT License (MIT).", + "iconUrl": "https://licensebuttons.net/l/by/4.0/88x31.png", + "active": true, + "sortOrder": 8 +} From b9ca45445e1df416a9d272792953a586b69d4787 Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Mon, 25 Mar 2024 16:31:15 -0400 Subject: [PATCH 02/10] Release notes --- doc/release-notes/10425-add-MIT-License.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/release-notes/10425-add-MIT-License.md diff --git a/doc/release-notes/10425-add-MIT-License.md b/doc/release-notes/10425-add-MIT-License.md new file mode 100644 index 00000000000..2e468fefbe0 --- /dev/null +++ b/doc/release-notes/10425-add-MIT-License.md @@ -0,0 +1 @@ +A new file has been added to import the MIT License to Dataverse on licenseMIT.json \ No newline at end of file From a0b29394fd532a2e99fd4cbb5768f3eee1b1d45f Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Mon, 25 Mar 2024 16:36:05 -0400 Subject: [PATCH 03/10] Icon removed --- scripts/api/data/licenses/licenseMIT.json | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/api/data/licenses/licenseMIT.json b/scripts/api/data/licenses/licenseMIT.json index ac00b9aac0e..7f2aa086df2 100644 --- a/scripts/api/data/licenses/licenseMIT.json +++ b/scripts/api/data/licenses/licenseMIT.json @@ -2,7 +2,6 @@ "name": "MIT License", "uri": "https://spdx.org/licenses/MIT.html", "shortDescription": "MIT License (MIT).", - "iconUrl": "https://licensebuttons.net/l/by/4.0/88x31.png", "active": true, "sortOrder": 8 } From 8ef7c6e680e84ee7b766622a1146b55a43f1a7b6 Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Mon, 25 Mar 2024 16:52:15 -0400 Subject: [PATCH 04/10] Description change and guide section --- doc/sphinx-guides/source/installation/config.rst | 7 +++++++ scripts/api/data/licenses/licenseMIT.json | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 41388f7aa33..9c70c91916c 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -1786,6 +1786,13 @@ JSON files for `Creative Commons licenses ` + Adding Custom Licenses ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/scripts/api/data/licenses/licenseMIT.json b/scripts/api/data/licenses/licenseMIT.json index 7f2aa086df2..b02d7d39994 100644 --- a/scripts/api/data/licenses/licenseMIT.json +++ b/scripts/api/data/licenses/licenseMIT.json @@ -1,7 +1,7 @@ { "name": "MIT License", "uri": "https://spdx.org/licenses/MIT.html", - "shortDescription": "MIT License (MIT).", + "shortDescription": "Massachusetts Institute of Technology License (MIT).", "active": true, "sortOrder": 8 } From 9d75f1ace66b79862d894347899599a1af4edd16 Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Mon, 25 Mar 2024 16:56:05 -0400 Subject: [PATCH 05/10] Fix license name --- doc/sphinx-guides/source/installation/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 9c70c91916c..b5bce6b870d 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -1791,7 +1791,7 @@ Adding Software Licenses JSON files for Software Licenses are provided below. -- :download:`licenseCC0-1.0.json <../../../../scripts/api/data/licenses/licenseMIT.json>` +- :download:`licenseMIT.json <../../../../scripts/api/data/licenses/licenseMIT.json>` Adding Custom Licenses ^^^^^^^^^^^^^^^^^^^^^^ From 5e0c73fd5d620ebc67315d7625a1f5b30f2452c3 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Thu, 11 Apr 2024 12:42:21 -0400 Subject: [PATCH 06/10] update MIT license and add guidance #10425 #8512 --- doc/release-notes/10425-add-MIT-License.md | 4 +++- .../source/installation/config.rst | 19 ++++++++++++++++++- scripts/api/data/licenses/licenseMIT.json | 6 +++--- 3 files changed, 24 insertions(+), 5 deletions(-) diff --git a/doc/release-notes/10425-add-MIT-License.md b/doc/release-notes/10425-add-MIT-License.md index 2e468fefbe0..95d6fb38ded 100644 --- a/doc/release-notes/10425-add-MIT-License.md +++ b/doc/release-notes/10425-add-MIT-License.md @@ -1 +1,3 @@ -A new file has been added to import the MIT License to Dataverse on licenseMIT.json \ No newline at end of file +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. diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index b5bce6b870d..4e08ee6c845 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -1789,10 +1789,27 @@ JSON files for `Creative Commons licenses ` +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 ``MIT``, you should name your file ``licenseMIT.json``. +- For the ``name`` field, use the "short identifier" from the SPDX landing page (e.g. ``MIT``). +- For the ``description`` field, use the "full name" from the SPDX landing page (e.g. ``MIT License``). +- For the ``uri`` field, go to the SPDX landing page for the license and click on the link under "other web pages for this license". Let any redirection happen and then copy the URL (e.g. ``https://opensource.org/license/mit``) into the ``uri`` field. +- 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/*``. + +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 + Adding Custom Licenses ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/scripts/api/data/licenses/licenseMIT.json b/scripts/api/data/licenses/licenseMIT.json index b02d7d39994..8a5ea485201 100644 --- a/scripts/api/data/licenses/licenseMIT.json +++ b/scripts/api/data/licenses/licenseMIT.json @@ -1,7 +1,7 @@ { - "name": "MIT License", - "uri": "https://spdx.org/licenses/MIT.html", - "shortDescription": "Massachusetts Institute of Technology License (MIT).", + "name": "MIT", + "uri": "https://opensource.org/license/mit", + "shortDescription": "MIT License", "active": true, "sortOrder": 8 } From 527e6e06198e92acc22181df0602c4dde3f11115 Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Fri, 19 Apr 2024 10:37:06 -0400 Subject: [PATCH 07/10] URI change --- scripts/api/data/licenses/license-Apache-2.0.json | 8 ++++++++ scripts/api/data/licenses/licenseMIT.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 scripts/api/data/licenses/license-Apache-2.0.json diff --git a/scripts/api/data/licenses/license-Apache-2.0.json b/scripts/api/data/licenses/license-Apache-2.0.json new file mode 100644 index 00000000000..0fdd071ea6e --- /dev/null +++ b/scripts/api/data/licenses/license-Apache-2.0.json @@ -0,0 +1,8 @@ +{ + "name": "Apache-2.0", + "uri": "https://spdx.org/licenses/Apache-2.0", + "shortDescription": "Apache License 2.0", + "active": true, + "sortOrder": 9 + } + \ No newline at end of file diff --git a/scripts/api/data/licenses/licenseMIT.json b/scripts/api/data/licenses/licenseMIT.json index 8a5ea485201..d5315d42a28 100644 --- a/scripts/api/data/licenses/licenseMIT.json +++ b/scripts/api/data/licenses/licenseMIT.json @@ -1,6 +1,6 @@ { "name": "MIT", - "uri": "https://opensource.org/license/mit", + "uri": "https://spdx.org/licenses/MIT", "shortDescription": "MIT License", "active": true, "sortOrder": 8 From 5734dd198c452ab356de574aced3409354f71ac2 Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Fri, 19 Apr 2024 14:20:24 -0400 Subject: [PATCH 08/10] Update to docs --- doc/sphinx-guides/source/installation/config.rst | 9 +++++---- .../{license-Apache-2.0.json => licenseApache-2.0.json} | 0 2 files changed, 5 insertions(+), 4 deletions(-) rename scripts/api/data/licenses/{license-Apache-2.0.json => licenseApache-2.0.json} (100%) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 4e08ee6c845..fac23d49225 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -1792,6 +1792,7 @@ 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1801,10 +1802,10 @@ If you do not find the license JSON you need above, you are encouraged to contri - 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 ``MIT``, you should name your file ``licenseMIT.json``. -- For the ``name`` field, use the "short identifier" from the SPDX landing page (e.g. ``MIT``). -- For the ``description`` field, use the "full name" from the SPDX landing page (e.g. ``MIT License``). -- For the ``uri`` field, go to the SPDX landing page for the license and click on the link under "other web pages for this license". Let any redirection happen and then copy the URL (e.g. ``https://opensource.org/license/mit``) into the ``uri`` field. +- 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, go to the SPDX landing page for the license and remove the extension ``.html`` from your browser and then copy the URL (e.g. ``https://spdx.org/licenses/Apache-2.0``) into the ``uri`` field. - 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/*``. diff --git a/scripts/api/data/licenses/license-Apache-2.0.json b/scripts/api/data/licenses/licenseApache-2.0.json similarity index 100% rename from scripts/api/data/licenses/license-Apache-2.0.json rename to scripts/api/data/licenses/licenseApache-2.0.json From 86674efceabce0fb22459a044a25fa00d3bfe271 Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Tue, 7 May 2024 11:01:56 -0400 Subject: [PATCH 09/10] Changes to suggest the use of DataCite resources --- doc/sphinx-guides/source/installation/config.rst | 2 +- scripts/api/data/licenses/licenseApache-2.0.json | 2 +- scripts/api/data/licenses/licenseMIT.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index e0cde1cbd46..00d926b20d3 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -1877,7 +1877,7 @@ If you do not find the license JSON you need above, you are encouraged to contri - 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, go to the SPDX landing page for the license and remove the extension ``.html`` from your browser and then copy the URL (e.g. ``https://spdx.org/licenses/Apache-2.0``) into the ``uri`` field. +- 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. - 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/*``. diff --git a/scripts/api/data/licenses/licenseApache-2.0.json b/scripts/api/data/licenses/licenseApache-2.0.json index 0fdd071ea6e..009d73fc9c2 100644 --- a/scripts/api/data/licenses/licenseApache-2.0.json +++ b/scripts/api/data/licenses/licenseApache-2.0.json @@ -1,6 +1,6 @@ { "name": "Apache-2.0", - "uri": "https://spdx.org/licenses/Apache-2.0", + "uri": "https://www.apache.org/licenses/LICENSE-2.0", "shortDescription": "Apache License 2.0", "active": true, "sortOrder": 9 diff --git a/scripts/api/data/licenses/licenseMIT.json b/scripts/api/data/licenses/licenseMIT.json index d5315d42a28..ddadab45222 100644 --- a/scripts/api/data/licenses/licenseMIT.json +++ b/scripts/api/data/licenses/licenseMIT.json @@ -1,6 +1,6 @@ { "name": "MIT", - "uri": "https://spdx.org/licenses/MIT", + "uri": "https://opensource.org/license/mit/", "shortDescription": "MIT License", "active": true, "sortOrder": 8 From 570649f840f93459776ef0f36906de24b145787a Mon Sep 17 00:00:00 2001 From: Juan Pablo Tosca Villanueva Date: Tue, 7 May 2024 14:02:47 -0400 Subject: [PATCH 10/10] Fix the URL to fit the DataCite use --- doc/sphinx-guides/source/installation/config.rst | 4 ++-- scripts/api/data/licenses/licenseApache-2.0.json | 2 +- scripts/api/data/licenses/licenseMIT.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 00d926b20d3..887a95ef781 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -1877,9 +1877,9 @@ If you do not find the license JSON you need above, you are encouraged to contri - 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. +- 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. - 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/*``. +- For the ``sortOrder`` field, put the next sequential number after checking previous files with ``grep sortOrder scripts/api/data/licenses/*``. 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 diff --git a/scripts/api/data/licenses/licenseApache-2.0.json b/scripts/api/data/licenses/licenseApache-2.0.json index 009d73fc9c2..5b7c3cf5c95 100644 --- a/scripts/api/data/licenses/licenseApache-2.0.json +++ b/scripts/api/data/licenses/licenseApache-2.0.json @@ -1,6 +1,6 @@ { "name": "Apache-2.0", - "uri": "https://www.apache.org/licenses/LICENSE-2.0", + "uri": "http://www.apache.org/licenses/LICENSE-2.0", "shortDescription": "Apache License 2.0", "active": true, "sortOrder": 9 diff --git a/scripts/api/data/licenses/licenseMIT.json b/scripts/api/data/licenses/licenseMIT.json index ddadab45222..a879e8a5595 100644 --- a/scripts/api/data/licenses/licenseMIT.json +++ b/scripts/api/data/licenses/licenseMIT.json @@ -1,6 +1,6 @@ { "name": "MIT", - "uri": "https://opensource.org/license/mit/", + "uri": "https://opensource.org/licenses/MIT", "shortDescription": "MIT License", "active": true, "sortOrder": 8