Documentation: DOI configuration, persistent id options, installer default need clarification.

[kcondon]

We might want to add or enhance the existing doc to alert new installers they need to separately arrange for an account with one of two available DOI providers, how to contact them, that the installer defaults to a test account at EZID that can be used in a test only config and that it needs to be a real account to be uniquely resolvable and citable. Last, list in a single place all the config parameters needed with pointer to where they are listed in the doc. This could become a separate page in the doc somewhere if someone like Eleni or the Data Management team feels further info is needed but at minimum, it could be a single short paragraph in addition to what is written below.

I've proposed such a section and included the current DOI doc below:

Proposed summary paragraph for persistent ID info:
(Note the outline numbers are not actual, only for relative position)

I. Installation Guide:
5. Configuration
5.4 Root Dataverse Configuration
5.4.4 Persistent Identifiers and Publishing Datasets
Persistent identifiers are a required and integral part of the Dataverse platform. They provide a URL that is guaranteed to resolve to the datasets they represent. Dataverse currently supports creating identifiers using DOI and additionally displaying identifiers created using HDL. By default and for testing convenience, the installer configures a temporary DOI test namespace through EZID. This is sufficient to create and publish datasets but they are not citable nor guaranteed to be preserved. To properly configure persistent identifiers for a production installation, an account and associated namespace must be acquired for a fee from one of two DOI providers: EZID or DataCite (make as links). Once account credentials and DOI namespace have been acquired, please complete the following identifier configuration parameters:

(make as links)
JVM Options: doi.baseurlstring, doi.username, doi.password
Database Settings: :DoiProvider, :Protocol, :Authority, :DoiSeparator

Please note that any datasets creating using the test configuration cannot be directly migrated and would need to be created again once a valid DOI namespace is configured.

Currently submitted DataCite/EZID DOI documentation:
I. Installation Guide:
2. Preparation:
2.2 Architecture and Components:
Persistent identifier service: DOI support is provided. An EZID subscription or DataCite account is required for production use.
2.4 Decisions to Make:
How much does it cost to subscribe to a service to create persistent identifiers such as DOIs?
5. Configuration:
5.5 JVM Options
5.5.1 doi.baseurlstring
As of this writing “https://ezid.cdlib.org” and “https://mds.datacite.org” are the only valid values. See also these related database settings below:
:DoiProvider
:Protocol
:Authority
:DoiSeparator
5.5.2 doi.username
Used in conjuction with doi.baseurlstring.
5.5.3 doi.password
Used in conjuction with doi.baseurlstring.
5.6 Database Settings
5.6.6 :DoiProvider
As of this writing “EZID” and “DataCite” are the only valid options.
curl -X PUT -d EZID http://localhost:8080/api/admin/settings/:DoiProvider
5.6.7 :Protocol
As of this writing “doi” is the only valid option for the protocol for a persistent ID.
curl -X PUT -d doi http://localhost:8080/api/admin/settings/:Protocol
5.6.8 :Authority
Use the DOI authority assigned to you by your DoiProvider.
curl -X PUT -d 10.xxxx http://localhost:8080/api/admin/settings/:Authority
5.6.9 :DoiSeparator
It is recommended that you keep this as a slash (“/”).
curl -X PUT -d "/" http://localhost:8080/api/admin/settings/:DoiSeparator

[posixeleni]

@kcondon thanks for putting this together. This will be useful to share with the DataCite Community so please let me know when this is up in the guides and I can send them the link.

[pdurbin]

This is basically the new #2632 and looks like a good brain dump of how we need to document this stuff better (and maybe change the installer). For now I added it to the long list at #2944 but it would be great to have this be part of pull request #2964 before it's merged.

[sekmiller]

Completed as requested except for the internal linking to JVM options and Settings entries.

[sekmiller]

Added internal linking

[kcondon]

OK looks good. Closing.