From 056c418ebc4c3bb8c7f3d38ded26f712a46a9b8a Mon Sep 17 00:00:00 2001 From: Don Sizemore Date: Wed, 12 Dec 2018 06:47:36 -0500 Subject: [PATCH 1/3] update FilePIDsEnabled documentation --- doc/sphinx-guides/source/installation/config.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 3cbc0b0757e..1d07e3d6e30 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -124,7 +124,7 @@ Once you have your DOI or Handle account credentials and a namespace, configure Configuring Dataverse for DOIs ++++++++++++++++++++++++++++++ -Out of the box, Dataverse is configured for DOIs. Here are the configuration options for DOIs: +Out of the box, Dataverse is configured to register DOIs for each dataverse, dataset, and file. Here are the configuration options for DOIs: **JVM Options:** @@ -140,6 +140,7 @@ Out of the box, Dataverse is configured for DOIs. Here are the configuration opt - :ref:`:Shoulder <:Shoulder>` - :ref:`:IdentifierGenerationStyle <:IdentifierGenerationStyle>` (optional) - :ref:`:DataFilePIDFormat <:DataFilePIDFormat>` (optional) +- :ref:`:FilePIDsEnabled <:FilePIDsEnabled>` (optional, defaults to true) Configuring Dataverse for Handles +++++++++++++++++++++++++++++++++ @@ -975,9 +976,13 @@ Note that in either case, when using the ``sequentialNumber`` option, datasets a :FilePIDsEnabled ++++++++++++++++ -Enable/disable the publishing of file based PIDs for the whole installation. This is enabled by default +Toggles publishing of file-based PIDs for the entire installation. By default this setting is absent and Dataverse assumes it to be true. -``curl -X PUT -d 'true' http://localhost:8080/api/admin/settings/:FilePIDsEnabled`` +If you don't want to register file-based PIDs for your installation, set: + +``curl -X PUT -d 'false' http://localhost:8080/api/admin/settings/:FilePIDsEnabled`` + +Note: File-level PID registration was added in 4.9 and is required until version 4.9.3. :ApplicationTermsOfUse ++++++++++++++++++++++ From 240cbaf60f9cee4483c6e98056d4da62059fec86 Mon Sep 17 00:00:00 2001 From: Don Sizemore Date: Wed, 12 Dec 2018 08:19:07 -0500 Subject: [PATCH 2/3] update DOI verbage per Phil --- doc/sphinx-guides/source/installation/config.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index 1d07e3d6e30..10c268b00ed 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -124,7 +124,9 @@ Once you have your DOI or Handle account credentials and a namespace, configure Configuring Dataverse for DOIs ++++++++++++++++++++++++++++++ -Out of the box, Dataverse is configured to register DOIs for each dataverse, dataset, and file. Here are the configuration options for DOIs: +By default Dataverse attempts to register DOIs for each dataverse, dataset, and file under a test authority, though you must register for your own credentials as explained above. + +Here are the configuration options for DOIs: **JVM Options:** From df8ef7c24dd1bc7f20d211d0cdc3e4e72cd818fe Mon Sep 17 00:00:00 2001 From: Don Sizemore Date: Wed, 12 Dec 2018 11:10:13 -0500 Subject: [PATCH 3/3] fix DOI statement thanks to Pete --- 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 10c268b00ed..e9d1a031da5 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -124,7 +124,7 @@ Once you have your DOI or Handle account credentials and a namespace, configure Configuring Dataverse for DOIs ++++++++++++++++++++++++++++++ -By default Dataverse attempts to register DOIs for each dataverse, dataset, and file under a test authority, though you must register for your own credentials as explained above. +By default Dataverse attempts to register DOIs for each dataset and file under a test authority, though you must apply for your own credentials as explained above. Here are the configuration options for DOIs: