Merge branch 'develop' into 11918-template-apis

Author: sekmiller

doc/release-notes/11990-controlled-vocab-edit-error.md

@@ -0,0 +1,5 @@
+### Bug Fix
+
+Editing a controlled vocabulary field (i.e. one with values specified in the field's metadatablock) that only allows a single selection would also update the value in the prior published version if (and only if) the edit was made starting from the published version (versus an existing draft). This is now fixed.
+The bug appears to be 11+ years old and previously unreported. As the value in the database was overwritten, there is no simple way to detect if/when this occurred without looking at backups or archival file copies. 
+ 

doc/sphinx-guides/source/index.rst

@@ -6,13 +6,16 @@
 Dataverse Documentation v. |version|
 ====================================
 
+Check out the new :doc:`/quickstart/index`!
+
 These documentation guides are for the |version| version of Dataverse. To find guides belonging to previous or future versions, :ref:`guides_versions` has a list of all available versions.
 
 .. toctree::
   :glob:
   :titlesonly:
   :maxdepth: 2
 
+  quickstart/index
   user/index
   admin/index
   ai/index

doc/sphinx-guides/source/quickstart/index.md

@@ -0,0 +1,9 @@
+# Quickstart Guide
+
+```{toctree}
+:caption: "Contents:"
+:maxdepth: 1
+what-is-dataverse.md
+publish-a-dataset.md
+publish-a-collection.md
+```

doc/sphinx-guides/source/quickstart/publish-a-collection.md

@@ -0,0 +1,63 @@
+# Publish a Collection
+
+## 🔐 Step 1: Log In & Create a Draft
+
+- {ref}`Log in <account-log-in-options>`.
+- (Optional) Navigate to {doc}`a collection </user/dataverse-management>`.
+- Click "Add Data" → "New Dataverse".
+
+Note: If you don’t see the "Add Data" button, contact your repository support team.
+
+## 📝 Step 2: Enter Basic Metadata & Settings
+
+- Fill in the required {ref}`metadata <create-dataverse>` fields
+- Select metadata settings.  
+- Click "Create Dataverse" at the bottom to save your draft collection.
+
+## 🚀 Step 3: Publish Your Collection
+
+Note: once published, easy deletion of a collection is no longer possible.
+
+- Click "Publish" (top right).
+
+---
+
+## ✅ Choose Look & Feel (optional)
+
+- Click "Edit" → "Theme \+ Widgets".  
+- Select {ref}`theme settings <theme>`.
+- Click "Save Changes".
+
+## ✅ Set Permissions (optional)
+
+- Click "Edit" → "Permissions".  
+- Under "Permissions", click "Edit Access" to {ref}`set general permissions <dataverse-permissions>`.
+- (Optional) Add users or groups with specific permissions under "Users/Groups" by clicking "Assign Roles to Users/Groups".
+
+## ✅ Create Groups (optional)
+
+- Click "Edit" → "Groups".  
+- Click "Create Group".  
+- Enter a Group Name and Group Identifier.  
+- Add users to this group using autofill in "Users/Groups".  
+- Click "Create Group".
+
+## ✅ Set Dataset Templates (optional)
+
+- Click "Edit" → "Dataset Templates".  
+- Click {ref}`Create Dataset Template <dataset-templates>`.
+- Enter a template name.  
+- Add any template metadata in the metadata fields.  
+- Click "Save \+ Add Terms".  
+- {ref}`Choose a license <choosing-license>` from the dropdown or select {ref}`Custom Dataset Terms <custom-terms>`.
+- Provide other relevant terms information  
+- Click "Save Dataset Template"
+
+## ✅ Set Dataset Guestbooks (optional)
+
+- Click "Edit" → "Dataset Guestbooks".  
+- Click {ref}`Create Dataset Guestbook <dataset-guestbooks>`.
+- Enter a guestbook name.  
+- Add information to collect.  
+- Click "Create Dataset Guestbook".
+

doc/sphinx-guides/source/quickstart/publish-a-dataset.md

@@ -0,0 +1,61 @@
+# Publish a Dataset
+
+## 🔐 Step 1: Log In & Create a Draft
+
+- {ref}`Log in <account-log-in-options>`.
+- (Optional) Navigate to {doc}`a collection </user/dataverse-management>`.
+- Click "Add Data" → "{ref}`New Dataset <adding-new-dataset>`".
+
+Note: If you don’t see the "Add Data" button, contact your repository support team.
+
+## 📝Step 2: Enter Basic Metadata
+
+- Fill in the required {ref}`metadata <metadata-supported>` fields.
+- Click "Save" at the bottom to save your draft dataset.
+
+
+## 📁 Step 3: Upload or Edit Files
+
+- In the draft dataset, scroll down to the "Files" tab.
+- Click "{ref}`Upload Files <dataset-file-upload>`".
+- Choose "Select Files to Add" or drag and drop files.
+- (Optional) Use "{ref}`Upload Folder <folder-upload>`" if available.
+- Click "Done" when upload is completed.
+
+To edit files:
+
+- Select files on the left → Click "{ref}`Edit Files <edit-files>`".
+- To {ref}`restrict/embargo files <edit-file-metadata>`, choose the relevant option.
+
+## 📜 Step 4: Set Terms of Use
+
+- Go to the terms tab.
+- Click "{ref}`Edit Terms Requirements <license-terms>`".
+- {ref}`Choose a license <choosing-license>` from the dropdown or select {ref}`Custom Dataset Terms <custom-terms>`.
+- Click "Save changes".
+
+## 🧾 Step 5: Add or Edit Metadata
+
+- Go to the metadata tab.
+- Click "Add + Edit Metadata".
+- Click "Save" after making changes.
+
+## 🚀 Step 6: Publish Your Dataset
+
+Note: once published, easy deletion of a dataset is no longer possible.
+
+- Click publish-dataset or submit-for-review (top right).
+
+ - {ref}`Publish Dataset <publish-dataset>`: Immediately publish a dataset. This option is only available on repositories without a review phase.
+
+ - {ref}`Submit for Review <submit-for-review>`: Locks draft and sends to support staff. If changes are needed, you’ll be notified via email and you can resubmit. This option is only available on repositories with a review phase.
+
+## 🔄 Optional: Update a Published Dataset
+
+- Edit the dataset and publish {ref}`a new version <dataset-versions>`.
+- The DOI remains the same.
+- The dataset-versioning tracks all changes:
+
+  - Metadata changes = minor version.
+
+  - Data changes = major version.

doc/sphinx-guides/source/quickstart/what-is-dataverse.md

@@ -0,0 +1,40 @@
+# What is Dataverse?
+
+Dataverse is an open source web application for sharing, preserving, citing, exploring, and analyzing research data. It is developed and supported by the Dataverse user community.
+
+A Dataverse repository can host one or more Dataverse collections, which organize datasets. 
+
+- Collections can contain datasets and sub-collections for further organization.  
+- Each dataset includes:  
+  - Metadata  
+  - Data files  
+  - Documentation or code
+
+## Core Capabilities
+
+### 📤 Upload, manage, publish and download data files.
+
+- Upload data while retaining directory structure for better context and reproducibility.  
+- Manage datasets by inviting collaborators before publication.  
+- Control access with permissions, configurations, licenses, file restrictions, and guestbooks.  
+- Publish datasets with rich metadata, licensing, and versioning to make data FAIR.  
+- Download data with clear terms of use and cite data using provided citation options.
+
+### 🔍 Make your data findable, reusable, and citable with rich metadata
+
+- Rich metadata is added to a dataset before publication, with the option to use domain-specific metadata blocks.  
+- Harvest metadata of datasets through the distribution of standardized data descriptions across the web (e.g. Google Dataset Search).
+
+### 📜Define how data can be reused with clear terms
+
+- Standardized licenses can be applied to a dataset.  
+- Custom dataset terms allow for dataset publication that cannot use standardized licenses.
+
+### 📈 Keep track of changes on published datasets with versioning
+
+- Track version changes with metadata and file changes tracked as minor and major versions.  
+- Access and cite specific versions via the version tab on a dataset.  
+- Compare versions with the detailed version change overview on dataset-level.
+
+### ✨More features  
+The Dataverse project is continuously evolving. For an overview of capabilities, visit the [features list](https://dataverse.org/software-features).

doc/sphinx-guides/source/user/account.rst

@@ -14,6 +14,8 @@ As a registered user, you can:
 -  Contribute to existing datasets, if permitted.
 -  Request access to restricted files, if permitted.
 
+.. _account-log-in-options:
+
 Account Log In Options
 ~~~~~~~~~~~~~~~~~~~~~~
 

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

@@ -8,6 +8,7 @@ A dataset in a Dataverse installation is a container for your data, documentatio
 .. contents:: |toctitle|
 	:local:
 
+.. _metadata-supported:
 
 Supported Metadata
 ==================
@@ -421,9 +422,13 @@ Differentially Private (DP) Metadata can be accessed for restricted tabular file
 
 See also :ref:`terms-of-access` and :ref:`permissions`.
 
+.. _edit-files:
+
 Edit Files
 ==========
 
+.. _edit-file-metadata:
+
 Edit File Metadata
 ------------------
 
@@ -476,6 +481,8 @@ Terms
 
 Dataset terms can be viewed and edited from the Terms tab of the dataset page, or under the Edit dropdown button of a Dataset. There, you can set up how users can use your data once they have downloaded it (via a standard license or, if allowed, custom terms), how they can access your data if you have files that are restricted (terms of access), and enable a Guestbook for your dataset so that you can track who is using your data and for what purposes. These are explained in further detail below:
 
+.. _choosing-license:
+
 Choosing a License
 ------------------
 
@@ -506,6 +513,8 @@ The `Dataverse Community Norms <https://dataverse.org/best-practices/dataverse-c
 
 \* **Legal Disclaimer:** these `Community Norms <https://dataverse.org/best-practices/dataverse-community-norms>`_ are not a substitute for the CC0 waiver or custom terms and licenses applicable to each dataset. The Community Norms are not a binding contractual agreement, and downloading datasets from a Dataverse installation does not create a legal obligation to follow these policies.
 
+.. _custom-terms:
+
 Custom Terms of Use for Datasets
 --------------------------------
 
@@ -688,6 +697,8 @@ Adding Widgets to an OpenScholar Website
 #. Click on the Settings Cog and select Layout
 #. At the top right, select Add New Widget and under Misc. you will see the Dataverse Collection and the Dataverse Dataset Citation Widgets. Click on the widget you would like to add, fill out the form, and then drag it to where you would like it to display in the page.
 
+.. _publish-dataset:
+
 Publish Dataset
 ===============
 
@@ -700,6 +711,8 @@ Whenever you edit your dataset, you are able to publish a new version of the dat
 Note: Prior to publishing your dataset the Data Citation will indicate that this is a draft but the "DRAFT VERSION" text
 will be removed as soon as you Publish.
 
+.. _submit-for-review:
+
 Submit for Review
 =================
 
@@ -758,6 +771,8 @@ Support for file-level retention periods can also be configured in a Dataverse i
 Retention periods are intended to support use cases where files must be made unavailable - and in most cases destroyed, e.g. to meet legal requirements - after a certain period or date.
 Actual destruction is not automatically handled, but would have to be done on the storage if needed.
 
+.. _dataset-versions:
+
 Dataset Versions
 ================