update FilePIDsEnabled documentation#5395
Conversation
| ++++++++++++++++++++++++++++++ | ||
|
|
||
| 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: |
There was a problem hiding this comment.
"Out of the box, Dataverse is configured to register DOIs" is probably too strong a statement.
"Out of the box, Dataverse is configured to register fake DOIs" used to be true when EZID was used.
"Out of the box, Dataverse is configured for fake DOIs but you must obtain credentials as explained above" would be accurate, I guess.
|
|
||
| ``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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
The default is a change in behavior, which I can see as being potentially confusing.
5 participants
New Contributors
Welcome! New contributors should at least glance at CONTRIBUTING.md, especially the section on pull requests where we encourage you to reach out to other developers before you start coding. Also, please note that we measure code coverage and prefer you write unit tests. Pull requests can still be reviewed without tests or completion of the checklist outlined below. Thanks!
Related Issues
Pull Request Checklist