Skip to content

Commit 613b826

Browse files
authored
How to Version (#268)
## What Did You Change? Added guide on how to version a published project. ## Do You Want Support (syntax, design, etc)? <!-- After you open this PR, you can preview your changes. A comment will appear with a link to the server. --> ## Any Reference Material Worth Sharing? This resolves issue #262
1 parent 959440e commit 613b826

File tree

7 files changed

+44
-1
lines changed

7 files changed

+44
-1
lines changed

user-guide/curating/guides.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Steps to Curate and Publish Your Datasets
22

3-
We offer step-by-step guides on how to create projects in the Data Depot, and curate and publish work/data across DesignSafe: [**Experimental**](#experimental), [**Simulation**](#simulation), [**Field Research**](#fieldresearch), [**Research Software**](#research-software), [**Other**](#other). For more information: [Policies](/user-guide/curating/policies), [Best Practices](/user-guide/curating/bestpractices/), [Frequently Asked Questions](/user-guide/curating/faq/).
3+
We offer step-by-step guides on how to create projects in the Data Depot, and curate and publish work/data across DesignSafe: [**Experimental**](#experimental), [**Simulation**](#simulation), [**Field Research**](#fieldresearch), [**Research Software**](#research-software), [**Other**](#other), [**Versioning**](#Versioning). For more information: [Policies](/user-guide/curating/policies), [Best Practices](/user-guide/curating/bestpractices/), [Frequently Asked Questions](/user-guide/curating/faq/).
44

55
## Experimental
66

@@ -572,3 +572,46 @@ In **Order Authors**, order the authors of the publication and preview how your
572572
In **Licenses**, select one or more licenses that best fit your data.
573573

574574
Finally, click **Request DOI & Publish** and agree to the agreement to publish your work.
575+
576+
---
577+
## Versioning
578+
579+
After publishing, you can publish new versions of datasets if you wish to update the files/data. A version number will be appended to the end of the citation.
580+
581+
**Note:** If you only need to update metadata, you can amend the metadata without creating a new version. Simply change the metadata in the curation directory, then select **Amend** after selecting **Prepare to Publish / Version / Amend** (See step 2).
582+
583+
### 1. Make Changes in Curation Directory
584+
585+
![](./imgs/guide-versioning-1a.png)
586+
587+
Remove files from a dataset (Experiment, Simulation, Mission, or anything with a DOI) in the **Curation Directory** by removing their relationship to the dataset or the category/collection within the dataset.
588+
589+
![](./imgs/guide-versioning-1b.png)
590+
591+
Add new files by assigning them to a dataset or a category/collection within a dataset.
592+
593+
For **Project Type Other**, new files do not need to be assigned to a specific dataset because entire project is one dataset. Make sure the new files are in the **Curation Directory** so they can be selected for the new version in step 2.
594+
595+
### 2. Prepare to Version
596+
597+
![](./imgs/guide-versioning-2a.png)
598+
599+
Select **Prepare to Publish / Amend / Version** in the **Publication Preview** and you will be given the choice to publish new datasets to your project, amend metadata, or version existing published datasets. Select **Version** to continue.
600+
601+
**Note:** If you only need to update metadata, select **Amend**.
602+
603+
![](./imgs/guide-versioning-2b.png)
604+
605+
Select each published dataset that has been updated and continue. You can version multiple datasets at once. Datasets that have not been published for the first time cannot be selected.
606+
607+
For **Project Type Other**, select each file to be included in the new version.
608+
609+
### 3. Explain Changes & Publish
610+
611+
![](./imgs/guide-versioning-3a.png)
612+
613+
You will be asked to explain the changes made to this new version. This will help someone viewing your data to understand its history, so be thorough in your explanation.
614+
615+
![](./imgs/guide-versioning-3b.png)
616+
617+
Once published, a viewer will be able to toggle between the versions.
66.8 KB
Loading
51.7 KB
Loading
46.2 KB
Loading
53.5 KB
Loading
20.2 KB
Loading
48.2 KB
Loading

0 commit comments

Comments
 (0)