Skip to content

Commit d045f1a

Browse files
committed
document require-embargo-reason feature flag #12067
The flag was added in #12067.
1 parent 9824b62 commit d045f1a

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

doc/sphinx-guides/source/installation/config.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4075,7 +4075,12 @@ dataverse.feature.only-update-datacite-when-needed
40754075

40764076
Only contact DataCite to update a DOI after checking to see if DataCite has outdated information (for efficiency, lighter load on DataCite, especially when using file DOIs).
40774077

4078+
.. _dataverse.feature.require-embargo-reason:
40784079

4080+
dataverse.feature.require-embargo-reason
4081+
++++++++++++++++++++++++++++++++++++++++
4082+
4083+
Require an embargo reason when a user creates an embargo on one or more files. See :ref:`embargoes`.
40794084

40804085
.. _:ApplicationServerSettings:
40814086

doc/sphinx-guides/source/user/dataset-management.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ Note that only one Preview URL (normal or with anonymized access) can be configu
750750
Embargoes
751751
=========
752752

753-
A Dataverse instance may be configured to support file-level embargoes. Embargoes make file content inaccessible after a dataset version is published - until the embargo end date. A reason for the embargo may be supplied when creating the embargo. A reason may be required in some Dataverse instances.
753+
A Dataverse instance may be configured to support file-level embargoes. Embargoes make file content inaccessible after a dataset version is published - until the embargo end date. A reason for the embargo may be supplied when creating the embargo. A reason may be :ref:`required <dataverse.feature.require-embargo-reason>` in some Dataverse instances.
754754
This means that file previews and the ability to download files will be blocked. The effect is similar to when a file is restricted except that the embargo will end at the specified date without further action and during the embargo, requests for file access cannot be made.
755755
Embargoes of files in a version 1.0 dataset may also affect the date shown in the dataset and file citations. The recommended practice is for the citation to reflect the date on which all embargoes on files in version 1.0 end. (Since Dataverse creates one persistent identifier per dataset and doesn't create new ones for each version, the publication of later versions, with or without embargoed files, does not affect the citation date.)
756756

0 commit comments

Comments
 (0)