Skip to content

update FilePIDsEnabled documentation #5395

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.

Sign up for GitHub

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

Merged
kcondon merged 3 commits into from
Dec 17, 2018
Merged

update FilePIDsEnabled documentation #5395

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
056c418
update FilePIDsEnabled documentation
donsizemore Dec 12, 2018
240cbaf
update DOI verbage per Phil
donsizemore Dec 12, 2018
df8ef7c
fix DOI statement thanks to Pete
donsizemore Dec 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions doc/sphinx-guides/source/installation/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 for DOIs. Here are the configuration options for DOIs:
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:

**JVM Options:**

Expand All @@ -140,6 +142,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
+++++++++++++++++++++++++++++++++
Expand Down Expand Up @@ -975,9 +978,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.

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``

``curl -X PUT -d 'true' 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.
Copy link
Member

@pdurbin pdurbin Dec 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all makes sense to me. Much more clear and a better example. We could even add a note about file PIDs under "Decisions to Make" in a future version of http://guides.dataverse.org/en/4.9.4/installation/prep.html#decisions-to-make . It sounds like you don't like the default, out of the box setting to have file PIDs on.

Copy link
Contributor Author

@donsizemore donsizemore Dec 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not that I disliked it, but rather the documentation describes the setting as optional. I found that, in its absence Dataverse assumes the setting to be true, so it's only-optional-if-you-disable-it. I was trying to make that more clear in the config page (Odum got 7 file PIDs by accident; I hadn't expected them as I hadn't purposefully set it to true)

I can update the verbage about registering DOIs, which as you point out lags behind recent changes in the DOI landscape.

Copy link
Contributor

@pameyer pameyer Dec 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default is a change in behavior, which I can see as being potentially confusing.


:ApplicationTermsOfUse
++++++++++++++++++++++
Expand Down