Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify steps for publishing a Dandiset #111

Merged
merged 4 commits into from
Feb 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 33 additions & 13 deletions docs/14_publish.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,35 @@
# Publishing Dandisets

Once you create a Dandiset, DANDI will automatically create a `draft` version of the Dandiset that
can be
changed as many times as needed.

Prior to publishing, you should edit your metadata appropriately
(e.g. people and funding contributors, protocol information, keywords, related resources in other
sources such as publications, code repositories, and other data).
If you need to change the Dandiset or its metadata in the future, you will need to create another version of your
Dandiset. The content of the specific published version of the Dandiset cannot be changed.

When you are ready to publish your data and to create a unique version of your
Dandiset, click the `Publish` button (on the right panel of the landing page). Note that the `Publish`
button is only active if all the metadata and asset errors are fixed.
Once you create a Dandiset, DANDI will automatically create a `draft` version
of the Dandiset that can be changed as many times as needed by editing the
metadata or uploading new files.

When the draft version is ready, you can *publish* your Dandiset. This results
in an immutable snapshot of your Dandiset with its own unique version number
that others can cite. If you need to change the data or metadata, you can do
so by continuing to modify the draft version and publishing a new version
when you are ready.

Follow these steps to publish your Dandiset:

1. Edit the Dandiset metadata, aiming to fix all Dandiset metadata validation
errors, and include any other useful information. For example, you may want
to edit the following fields:
- People and funding contributors
- Protocol information
- Keywords
- Related resources such as publications and code repositories

1. Fix all asset metadata errors by modifying the asset files to eliminate
the errors and re-uploading them.

1. When all the Dandiset metadata and asset metadata errors are fixed, and the Dandiset is made public if it was initially embargoed, the
`Publish` button (on the right panel of the Dandiset landing page) will
be enabled and turn green. Click the button to publish your Dandiset.

1. In the lower right section of the Dandiset landing page, you should see
the new, published version of your Dandiset listed. Click on that link
to view this version.

**NOTE:** Dandisets with Zarr assets currently cannot be published. We are
actively working on enabling this feature.
Loading