Skip to content

Commit 5c980b0

Browse files
committed
add Quickstart Guide and first page: Publish #11652
1 parent 23d47a3 commit 5c980b0

3 files changed

Lines changed: 70 additions & 0 deletions

File tree

doc/sphinx-guides/source/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@
66
Dataverse Documentation v. |version|
77
====================================
88

9+
Check out the new :doc:`/quickstart/index`!
10+
911
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.
1012

1113
.. toctree::
1214
:glob:
1315
:titlesonly:
1416
:maxdepth: 2
1517

18+
quickstart/index
1619
user/index
1720
admin/index
1821
ai/index
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Quickstart Guide
2+
3+
```{toctree}
4+
:caption: "Contents:"
5+
:maxdepth: 1
6+
publish.md
7+
```
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Publish A Dataset
2+
3+
## 🔐 Step 1: Log In & Create a Draft
4+
5+
- Log in.
6+
- (Optional) Navigate to a collection.
7+
- Click "Add Data" → "New Dataset".
8+
9+
Note: If you don’t see the "Add Data" button, contact your repository support team.
10+
11+
## 📝 Step 2: Enter Basic Metadata
12+
13+
- Fill in the required metadata fields.
14+
- Click "Save" at the bottom to save your draft dataset.
15+
16+
## 📁 Step 3: Upload or Edit Files
17+
18+
1. In the draft dataset, scroll down to the "Files" tab.
19+
1. Click "Upload Files".
20+
1. Choose "Select Files to Add" or drag and drop files.
21+
1. (Optional) Use "Upload Folder" if available.
22+
1. Click "Done" when upload is completed.
23+
24+
To edit files:
25+
26+
- Select files on the left → Click "Edit Files".
27+
- To restrict/embargo files, choose the relevant option.
28+
29+
## 📜 Step 4: Set Terms of Use
30+
31+
- Go to the "Terms" tab.
32+
- Click "Edit Terms Requirements".
33+
- Choose a license from the dropdown or select Custom Dataset Terms.
34+
- Click "Save changes".
35+
36+
## 🧾 Step 5: Add or Edit Metadata
37+
38+
- Go to the "Metadata" tab.
39+
- Click "Add + Edit Metadata".
40+
- Click "Save" after making changes.
41+
42+
## 🚀 Step 6: Publish Your Dataset
43+
44+
Note: once published, easy deletion of a dataset is no longer possible.
45+
46+
- Click "Publish Dataset" or "Submit for Review" (top right).
47+
48+
- Publish Dataset: Immediately publish a dataset. This option is only available on repositories without a review phase.
49+
50+
- 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.
51+
52+
## 🔄 Optional: Update a Published Dataset
53+
54+
- Edit the dataset and publish a new version.
55+
- The DOI remains the same.
56+
- The Versioning tab tracks all changes:
57+
58+
- Metadata changes = minor version.
59+
60+
- Data changes = major version.

0 commit comments

Comments
 (0)