Skip to content

Commit c54bd38

Browse files
committed
chore: cleanup format and clarify language
1 parent b6b4338 commit c54bd38

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

doc/design/doi-generation-2.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ For example:
1414

1515
Dandiset DOI redirect will always refer to the DLP.
1616

17-
At creation the `Dandiset DOI` will be a DataCite `Draft DOI`, but will be "promoted" to a DataCite `Findable DOI` as soon as there is a published version.
18-
A `Version DOI` will be created as a `Findable DOI`.
17+
At creation the `Dandiset DOI` will be a DataCite `Draft DOI`.
18+
`Dandiset DOI` will remain a `Draft DOI` until there is a published version, at that time we will "promote" to a DataCite `Findable DOI`.
19+
For each published version there will be a `Version DOI` created as a `Findable DOIs`.
1920

2021
## The current approach
2122

@@ -79,7 +80,7 @@ DataCite allows for three types of DOIs ([DataCite](https://support.datacite.org
7980
- Upon changes to embargoed dandiset metadata record, don't do anything.
8081
- Upon deletion of an embargoed dandiset: don't do anything.
8182
- Upon unembargoing dandiset:
82-
- Mint `Dandiset DOI` (Draft) with latest metadata,
83+
- Mint `Dandiset DOI` (Draft) with latest metadata
8384

8485
### Cautions
8586

@@ -90,9 +91,9 @@ If DANDI_DOI_PUBLISH is false (default)
9091
If all DOI configuration options are not set:
9192
- all required options:
9293
- `DANDI_DOI_API_URL`
93-
- `DANDI_DOI_API_URL`
94-
- `DANDI_DOI_API_PASSWORD`
94+
- `DANDI_DOI_API_USER`
9595
- `DANDI_DOI_API_PASSWORD`
96+
- `DANDI_DOI_API_PREFIX`
9697
- DOIs CRUD through Datacite API should be entirely disabled
9798
- DOI (the string) should not be added to the version
9899

@@ -228,7 +229,7 @@ This is because `Draft` DOI is not visible/usable by users.
228229
However, if we promote the `Draft DOI` to `Findable` as soon as it is valid, and the user then change it to be invalid again, the DOI metadata will be wrong.
229230
We discussed annotating the DOI, ie "potentially incorrect metadata", but we ultimately decided that the messiness is not worth the value.
230231

231-
- Dandisets can be deleted. In such cases, upon deletion of a dandiset:
232+
How Findable DOIs for Draft Dandisets would work upon deletion of a dandiset:
232233
- if DOI was a `Draft` DOI - just delete it as well.
233234
- if DOI was a `Findable` DOI - convert to `Registered` DOI (follows [datacite best practices](https://support.datacite.org/docs/tombstone-pages))
234235
- Also at the level of the DANDI archive itself we should provide tombstone page so URL is still "working" (#3211)

0 commit comments

Comments
 (0)