Skip to content

Commit

Permalink
help: docs finished deposit section
Browse files Browse the repository at this point in the history
  • Loading branch information
lnielsen committed Sep 26, 2023
1 parent 8e6fc6b commit 8de5498
Show file tree
Hide file tree
Showing 13 changed files with 155 additions and 20 deletions.
67 changes: 55 additions & 12 deletions content/help/docs/deposit/about-records/contents.lr
Original file line number Diff line number Diff line change
@@ -1,25 +1,68 @@
_model: docspage
---
_hidden: true
---
title: About records
---
sort_key: 1
---
menu: /help/docs/deposit
---
tocdesc: General information about records.
---
lead: Records are the basic entities used to share and preserve a digital research object (datasets, publications, software, poster, presentations etc) on Zenodo. Any user on Zenodo can create a new record.
---
body:

- Records: metadata and files
- Metadata can be edited, files cannot
- DOIs
- Versions
- Persistent identifiers
- Public vs restricted
- Usage statistics
When you share and preserve research on Zenodo, you do so by creating a new record. Any user on Zenodo can create a new record.

A **record** consists of:

- **Metadata:** Information about title, publication date, creators, description, etc.
- **Files:** The actual data for the digital research object.
- **Persistent identifier**: A globally unique persistent identifier (in our case a [Digital Object Identifier](https://www.doi.org)) used for identification of the record.

#### Metadata

The metadata is critical for describing your dataset and making your record findable. We require only minimal metadata (what's needed for a citation), but we strongly encourage entering as much of the fields as possible.

Zenodo is able to export the metadata according to many different standards.

#### Files

Zenodo supports uploading files in any size and format. You should however consider uploading files in a preservation-friendly format as we only guarantee bit-level preservation - e.g. proprietary file format may not be readable in 10 or 50 years.

For further guidance on preservation-friendly formats please see the following resources:

- [Digital Preservation Handbook - File formats and standards](https://www.dpconline.org/handbook/technical-solutions-and-tools/file-formats-and-standards)
- [Library of Congress recommended format specifications](http://www.loc.gov/preservation/resources/rfs/index.html)

#### Persistent Identifier

Zenodo will automatically register a Digital Object Identifier (DOI) for a record once you publish it. The DOI is a globally unique persistent identifier which ensures that the record can be uniquely cited which is important for reproducibility and attribution of credit. Zenodo register DOIs with [DataCite](https://www.datacite.org).

You can also share research objects that already has a DOI on Zenodo (e.g. a journal publication). In this case you must provide the DOI during the upload to Zenodo, so that we don't create a new DOI for your content.

### Life cycle

A record starts as a **draft**, where you can fill in the metadata and upload files. Once the draft is complete, you publish the draft and it becomes a record. Once the record is published:

- Metadata CAN be modified
- Files and the persistent identifier CANNOT be modified

This is because Zenodo is a digital repository and operate according to best practices for archiving. A researcher citing a specific dataset on Zenodo must be able to rely on that the dataset they used is not modified because it could potentially invalidate their findings or make them impossible to reproduce.

#### Versions

Our versioning feature help with the case when you need to publish an update to a dataset (i.e. modify the files). In this case you can create a new version of your dataset.

Technically, this is a completely new record with separate metadata, files and persistent identifier. This ensures that if a researcher cite the specific version, they can be sure the files did not change.

### Access

Metadata for all records in Zenodo are always publicly accessible. You have the possibility to restrict access to the files, and once you restrict access you have the possibility to share with specific people.

We support the restricted access for e.g. embargoed content, content under peer-review, or e.g. content that cannot be made generally available (e.g. anonymized clinical trial data).

See [Sharing](../../sharing/) and [Communities](../../communities/) for further options on sharing restricted content.

---
docs:
---
todo:
- Finish writing.
20 changes: 19 additions & 1 deletion content/help/docs/deposit/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,24 @@ sort_key: 2
---
menu: /help/docs/deposit
---
body: bla bla
body:

!!! info
**Want to test Zenodo?** Use our sandbox environment on https://sandbox.zenodo.org to play.

This section provides a comprehensive documentation on how you upload your research on Zenodo. See the [quick start](../get-started/quickstart/) guide for short introduction to publishing your upload in 3 simple steps.

---
docs:

#### docsheader ####
text: Overview
----
ref: overview
#### docstext ####

text:
In this section, learn about the following topics:

#### docstoc ####
menu: /help/docs/deposit
2 changes: 2 additions & 0 deletions content/help/docs/deposit/create-new-upload/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ body:

See the [quick start](../../get-started/quickstart/) guide for a short introduction to publishing an upload in 3 simple steps. This guide goes in further detail about how to create a new record, and subsequent sections covers each part in detail.
---
tocdesc: Overview of how to create a new upload, add/remove files, fill metadata, save for later, set visibility, preview a record, apply an embargo and publish.
---
docs_show_toc: true
---
docs:
Expand Down
2 changes: 2 additions & 0 deletions content/help/docs/deposit/describe-records/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ sort_key: 3
---
menu: /help/docs/deposit
---
tocdesc: How to fill metadata for each specific field.
---
docs:

#### docstext ####
Expand Down
4 changes: 3 additions & 1 deletion content/help/docs/deposit/manage-files/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@ _model: docspage
---
title: Manage files
---
tocdesc: Learn how to add/remove files to a draft and set which file to preview by default.
---
sort_key: 4
---
menu: /help/docs/deposit
---
body:

!!! warning
**Heads up**: You CANNOT add/delete/modify files after your record is published.
**Heads up**: You CANNOT modify files *after* your record is published, instead use [versioning](../manage-versions/).

The following sections documents how to manage files for a draft and record. You can by default upload up to a 100 files and a total volume of 50GB (50.000.000.000 bytes).
---
Expand Down
2 changes: 2 additions & 0 deletions content/help/docs/deposit/manage-records/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ _model: docspage
---
title: Manage records
---
tocdesc: Learn how browse your drafts/published records, how to edit the metadata of published records.
---
sort_key: 5
---
menu: /help/docs/deposit
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 71 additions & 5 deletions content/help/docs/deposit/manage-versions/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,86 @@ _model: docspage
---
title: Manage versions
---
tocdesc: Learn how modify files by creating a new version.
---
sort_key: 6
---
menu: /help/docs/deposit
---
body:

Zenodo supports versioning of records.
The following sections describe how you can create a new version of record, import files from previous version, browse versions, and edit previous versions.

**When to use versioning?**

After a record is published you can no longer edit the files in the record (you can edit the metadata, see [manage records](../manage-records/) for details).
Versioning is used if you need to *add/remove/modify files* in your published record. If you just need to edit metadata (title, creators, description etc) then see [Edit published records](../manage-records/#edit).

To modify the files of a record you must a new record version.
Read more about versioning in [about records](../about-records/).

The section covers:
---
docs_show_toc: true
---
docs:

#### docstext ####
text: Test
#### docsheader ####
text: Create a new version
----
ref: create-version
#### docsstep ####
step: 1
----
text: Go to the record landing page of the record you want to create a new version of.
#### docsstep ####
step: 2
----
text: Click the green **New version**-button to create a new version draft. The button is only displayed if you have permissions to edit the record.
----
image: new-version.png
#### docsstep ####
step: 4
----
text: The deposit form will now show that you're editing a **New version draft**. Fill in the metadata, upload files as for any other record.
----
image: publish-button.png
#### docsheader ####
text: Import files from previous version
----
ref: import-files
#### docsstep ####
step: 1
----
text: In files section of the deposit form, click the **Import files**-button to import files from a previous. Using this feature saves storage space as we don't duplicate the previous files.
----
image: import-files.png
#### docsstep ####
step: 2
----
text: You can now add/remove/modify the imported files as described in [manage files](../manage-files/).

#### docsheader ####
text: Browse versions
----
ref: browse-versions
#### docsstep ####
step: 1
----
text: Go to **My uploads**.
#### docsstep ####
step: 2
----
text: Toggle the **View all versions** switch to on. You're now able to browse and search all previous versions of a record.
----
image: browse-versions.png
#### docsheader ####
text: Edit metadata of previous version
----
ref: create-version
#### docsstep ####
step: 1
----
text: Find the previous version you want to edit using e.g. [browse versions](#browse-versions).
#### docsstep ####
step: 2
----
text: Click the **Edit**-button to edit the previous version (see [edit published records](../manage-records/#edit)).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/help/faq/general/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Once the record has been published, you can no longer change the files in the re
1. If the record has a Zenodo DOI (prefix: ``10.5281``):
* The recommended way is to create a new version of a record (more details available [here](/#versioning)).
Most of the cases fall under this category, which include modifications of the dataset/software, addition or removal of files, new versions of datasets, software or revisions of the papers, including major revisions as well typos and formatting/styling.
* Exceptionally, we allow small modifications to the record's files, if and only if the record was published recently (less than one week). If you have spotted mistakes such as typos, accidental omission of important files/inclusion of hidden files or confidential files and would like to update them, please contact us.
* Exceptionally, we allow small modifications to the record's files, if and only if the record was published recently (less than 1 month). If you have spotted mistakes such as typos, accidental omission of important files/inclusion of hidden files or confidential files and would like to update them, please contact us.
1. If the record has a non-Zenodo DOI:
* Since it is not possible to create new versions for the non-Zenodo DOIs you should contact us about the file update directly.

Expand Down

0 comments on commit 8de5498

Please sign in to comment.