Stream: docs

Topic: Document features disabled by default #10717


view this post on Zulip Dimitri Szabo (Jul 24 2024 at 13:39):

Hello there!
Following this discussion, Philip and I figured it would be good to indicate in the User (or sometimes Admin) guide, when a feature that is documented there is not enabled by default.
Here is the issue to review the proposed text of the note that could be added, and list the features where it would be needed.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 24 2024 at 13:52):

Yes, thanks, Dimitri. If anyone wants to work on this, I'm happy to help them get started!

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 24 2024 at 14:52):

Embargo is a big one. At least it starts with "A Dataverse instance may be configured to support file-level embargoes" to give a clue that it might not be turned on.

view this post on Zulip Julian Gautier (Jul 24 2024 at 15:22):

I've heard from some folks running installations that one reason they've created their own documentation, instead of pointing to the guides at https://guides.dataverse.org, is to mention only features enabled in their installation. I'm just mentioning this to add broader context here. I agree it's a good idea to be more explicit in the default Dataverse guides about which features a particular installation may or may not have.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 24 2024 at 15:22):

Yeah, good point.

view this post on Zulip Philip Durbin ๐Ÿš€ (Jul 24 2024 at 15:23):

Also, historically, we had a rule that we don't link from the User Guide to other guides so as not to confuse the user. However, the champion of that idea is long gone and now we freely link between any guides.

view this post on Zulip Oliver Bertuch (Jul 25 2024 at 15:48):

Here's an example for our custom guide: https://data.fz-juelich.de/guide/juelich/index.html

view this post on Zulip Oliver Bertuch (Jul 25 2024 at 15:48):

But to be fair: it's not a complete fork of the guides - we did not apply patches, just an extra section.


Last updated: Nov 01 2025 at 14:11 UTC