IQSS / IQSS/dataverse

docs for dataverse.feature.enable-version-note

Open
#12,016 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Suggestion
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Suggestion
The documentation should clearly explain how to enable version notes, including where the dataverse.feature.enable-version-note flag is set, what its default behavior is, and how administrators can toggle it. The current docs mention the flag but don’t describe how to actually enable it in a real deployment.

What kind of user is the suggestion intended for?
Add documentation for this:

What inspired this idea?
Trying to set this up and it's not clear and the information is fragmented.

What existing behavior do you want changed?
Improve the documentation so it states that version notes are off by default and must be enabled manually. Include concrete instructions for enabling the feature flag, such as how to set the JVM option in a Payara domain.xml file or via the settings mechanism. Right now the docs mention the flag but don’t tell the admin where or how to set it.

Any brand new behavior do you want to add to Dataverse?
No new product behavior. Just clearer, centralized documentation on enabling version notes.

Any open or closed issues related to this suggestion?
The feature was introduced in v6.6 (PR 11068), but there is no dedicated documentation issue tracking the missing setup instructions.

Are you thinking about creating a pull request for this issue?
Help is always welcome, is this idea something you or your organization plan to implement?
Yes, I can contribute a documentation PR once there is agreement on where the instructions should live in the guides.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing documentation associated with PR 11068 and the Payara domain.xml and settings entry points mentioned in the issue. Confirm how dataverse.feature.enable-version-note behaves by default and document concrete administrator steps for enabling it, with the finished guide stating that version notes are disabled by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.