add Quickstart Guide #11653

pdurbin · 2025-07-18T14:57:23Z

What this PR does / why we need it:

This PR adds a new Quickstart Guide with the following content:

What is Dataverse?
Publish a dataset
Publish a collection

It also adds buttons to the top of the User Guide linking to these pages and a fourth button that links to an existing page in the User Guide about finding and using data.

Preview links:

Discuss:

Which issue(s) this PR closes:

Closes Quickstart Guide #11652

Notes for reviewers

"What is Dataverse?" only gives a brief overview of features. At the bottom, we intend to link to the list of features that is coming in pull request move the list of features into the guides #12000.

DieuwertjeBloemen · 2025-07-18T15:03:23Z

I think as discussed in the meeting, making the "step x" heading slightly smaller to make the page look shorter might be nice.

pdurbin · 2025-07-18T18:18:26Z

I think as discussed in the meeting, making the "step x" heading slightly smaller to make the page look shorter might be nice.

Hmm, I agree but for accessibility we should keep the h1 and h2 tags, right? Here they are:

I'm not sure what options we have with Sphinx. Can we have custom CSS for a single page? 🤔 Is it worth it? As @poikilotherm said a couple times, we should probably "shop" for a new theme anyway, as the Bootstrap 3 theme we're using now is quite old. 😅

It looks like .h2,h2{font-size:30px} is coming from https://dataverse-guide--11653.org.readthedocs.build/en/11653/_static/bootstrap-3.4.1/css/bootstrap.min.css which is to say https://github.com/IQSS/dataverse/blob/v6.7/doc/sphinx_bootstrap_theme/bootstrap/static/bootstrap-3.4.1/css/bootstrap.min.css

pdurbin · 2025-07-18T18:24:11Z

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

Should we change this filename from publish.md to publish-a-dataset.md?

Perhaps we'll want a quickstart about publishing a collection in the future? 🤔

Yeah, I think publish-a-dataset.md is the better option

Ok. Done in 820a1d4. I'll fix URLs where I can (e.g. Zulip) and follow up to the Google Group with a link to the new URL for the page: https://dataverse-guide--11653.org.readthedocs.build/en/11653/quickstart/publish-a-dataset.html

DieuwertjeBloemen · 2025-08-13T09:39:03Z

I've just noticed some steps are numbered and some are just bullet points. I would change them all to bullets.

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

removed numbers for bullets

ofahimIQSS · 2025-08-13T19:27:29Z

I've just noticed some steps are numbered and some are just bullet points. I would change them all to bullets.

updated, thanks!

ofahimIQSS · 2025-08-15T14:10:53Z

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

+
+## 🔐 Step 1: Log In & Create a Draft
+
+- Log in.


Suggested change

- Log in.

- Log in. [Log in.](https://guides.dataverse.org/en/latest/user/account.html#account-log-in-options)

Here's how to do it: 0458921

pdurbin · 2025-11-25T22:48:32Z

@DieuwertjeBloemen as discussed, we fixed this. Good catch!

DieuwertjeBloemen · 2025-11-30T15:00:13Z

@pdurbin I've just edited the svg's for the buttons to be skinnier and to have some padding around them. They're in the google folder and the file names stayed the same

pdurbin · 2025-12-01T15:04:19Z

@DieuwertjeBloemen thanks! I just copied the new buttons over in this commit: a8cb986

sekmiller · 2025-12-02T19:48:45Z

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

+- (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.


do we want to add something like "to request/obtain the required permissions"?

No, because depending on Dataverse set-ups and policies, it might just be that they don't get that option (e.g. institutional repositories). This way it's clear enough to contact support without creating expectations that might not be realistic for all Dataverse set-ups. Also, sometimes they don't see the button because they're e.g. on the My Data page. So, it could have several reasons as wel... So, to keep short and clear, just mentioning of asking for support.

sekmiller · 2025-12-02T19:51:06Z

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

+- (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.


again note required permissions

See response above: conscious choice not to do so.

sekmiller · 2025-12-02T19:52:53Z

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

+
+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. A Dataverse repository can host one or more Dataverse collections, which organize datasets.


not sure why this is repeated, unless we want to say that a collection can host other collections

Mistake on my part probably when copying in stuff from the Dataverse about pages. Duplication can be taken out.

sekmiller · 2025-12-02T19:57:06Z

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

+
+### 🔍 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.  


do we want to say that metadata blocks are configurable at the collection level?

No, this is a page with the most basic explanation of what dataverse is for several types of users and installations. This is too specific of a feature/point to mention here, I believe.

sekmiller · 2025-12-03T14:10:01Z

Thanks for the response @DieuwertjeBloemen

…taverse into 11652-quickstart-publish

sekmiller

Looks good. thanks again, @DieuwertjeBloemen for responding to my comments

add Quickstart Guide and first page: Publish #11652

5c980b0

lowercase a #11652

2b62b9b

pdurbin changed the title ~~add Quickstart Guide and first page: Publish~~ add Quickstart Guide and first section: Publish a Dataset Jul 18, 2025

pdurbin added this to IQSS Dataverse Project Jul 18, 2025

pdurbin moved this to In Progress 💻 in IQSS Dataverse Project Jul 18, 2025

pdurbin assigned pdurbin and DieuwertjeBloemen Jul 18, 2025

pdurbin commented Jul 18, 2025

View reviewed changes

change filename/path from publish to publish-a-dataset #11652

820a1d4

pdurbin assigned ofahimIQSS Jul 31, 2025

ofahimIQSS reviewed Aug 13, 2025

View reviewed changes

doc/sphinx-guides/source/quickstart/publish-a-dataset.md Outdated Show resolved Hide resolved

ofahimIQSS added 2 commits August 13, 2025 15:25

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

32e9d99

Update publish-a-dataset.md

6c548e9

removed numbers for bullets

cmbz added the FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) label Aug 14, 2025

ofahimIQSS reviewed Aug 15, 2025

View reviewed changes

pdurbin marked this pull request as draft August 15, 2025 20:02

make "Log In" a link (and add ref) #11652

0458921

pdurbin changed the title ~~add Quickstart Guide and first section: Publish a Dataset~~ add Quickstart Guide Aug 20, 2025

add "publish a dataset" button to top of User Guide #11652

6f2dba3

cmbz added the FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) label Aug 28, 2025

cmbz added the FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) label Sep 14, 2025

fix link to collection

3789523

pdurbin removed the Status: Needs Input Applied to issues in need of input from someone currently unavailable label Nov 25, 2025

pdurbin unassigned DieuwertjeBloemen Nov 25, 2025

pdurbin moved this from On Hold ⌛ to Ready for Review ⏩ in IQSS Dataverse Project Nov 25, 2025

pdurbin added this to the 6.9 milestone Nov 25, 2025

pdurbin marked this pull request as ready for review November 25, 2025 15:21

make buttons smaller #11652

a8cb986

sekmiller self-assigned this Dec 2, 2025

sekmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Dec 2, 2025

Merge branch 'develop' into 11652-quickstart-publish

45fec30

sekmiller reviewed Dec 2, 2025

View reviewed changes

sekmiller added 2 commits December 3, 2025 09:25

#11652 remove duplication

4a9700f

Merge branch '11652-quickstart-publish' of https://github.com/IQSS/da…

2e6270c

…taverse into 11652-quickstart-publish

sekmiller approved these changes Dec 3, 2025

View reviewed changes

github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Dec 3, 2025

sekmiller removed their assignment Dec 3, 2025

stevenwinship self-assigned this Dec 3, 2025

stevenwinship moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Dec 3, 2025

stevenwinship merged commit 908ce3c into develop Dec 3, 2025
7 of 8 checks passed

github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Dec 3, 2025

stevenwinship deleted the 11652-quickstart-publish branch December 3, 2025 14:48

stevenwinship removed their assignment Dec 3, 2025

scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Dec 3, 2025

	- Log in.
	- Log in. [Log in.](https://guides.dataverse.org/en/latest/user/account.html#account-log-in-options)


		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. A Dataverse repository can host one or more Dataverse collections, which organize datasets.


		### 🔍 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.

add Quickstart Guide #11653

add Quickstart Guide #11653

Uh oh!

Conversation

pdurbin commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DieuwertjeBloemen commented Jul 18, 2025

Uh oh!

pdurbin commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DieuwertjeBloemen commented Aug 13, 2025

Uh oh!

Uh oh!

ofahimIQSS commented Aug 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdurbin commented Nov 25, 2025

Uh oh!

DieuwertjeBloemen commented Nov 30, 2025

Uh oh!

pdurbin commented Dec 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DieuwertjeBloemen Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sekmiller Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sekmiller commented Dec 3, 2025

Uh oh!

sekmiller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

pdurbin commented Jul 18, 2025 •

edited

Loading

pdurbin commented Jul 18, 2025 •

edited

Loading

DieuwertjeBloemen Dec 3, 2025 •

edited

Loading

sekmiller Dec 2, 2025 •

edited

Loading