Documentation : Add a note on features not enabled by default
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
The Dataverse user or admin guide don't always indicate that the feature documented is not enabled by default.
As per this Zulip discussion, this can be confusing especially for new installations.
Adding the following text (or a similar one with the necessary adjustment depending on the feature) should prevent users from being disappointed if they don't find the feature and help them give the necessary information for their installation admin to enable the wanted features:
Note: This feature is not enabled by default. More information on how your admin can enable and configure this feature can be found in the [Installation Guide]{link to the appropriate section of the configuration guide}.
Any open or closed issues related to this feature request?
- #9263
List of features (Please feel free to point out others in the comments)
- URL for Anonymized Access needing anonymizedfieldtypenames
- Embargoes needing maxembargodurationinmonths
- OpenDP
- make-data-count : link to the fully fledged MDC documentation page
- Institutional login
- ORCiD login
- Microsoft Azure AD, GitHub, and Google Log In
- BagIt
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the unchecked feature links in the user guide, especially URL for Anonymized Access, Embargoes, make-data-count, and the login sections, then compare each with its linked Installation Guide or configuration entry. Done means every applicable feature clearly notes whether it is disabled by default and links to the information needed to enable it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100