From 0c3efa0059323a4b7f1b3022628e5c7fcb1987a5 Mon Sep 17 00:00:00 2001 From: fpotier Date: Wed, 30 Sep 2026 14:06:58 +0200 Subject: [PATCH] move publication instructions to a dedicated page --- docs/ingestorManual.md | 46 +-------------------------------------- docs/publishing.md | 49 ++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 4 +++- 3 files changed, 53 insertions(+), 46 deletions(-) create mode 100644 docs/publishing.md diff --git a/docs/ingestorManual.md b/docs/ingestorManual.md index fca13b4..8c76ec3 100644 --- a/docs/ingestorManual.md +++ b/docs/ingestorManual.md @@ -626,51 +626,7 @@ on the lower left corner). --> ## Publish -As part of a publication workflow datasets must become citable via a -digital object identifier (DOI). This assignment is done as part of -the publication workflow described below. The publication then can -link to these published datasets using this DOI. The DOIs can link to -both raw and/or derived datasets. The published data and therefore the -DOI ususally refers to a **set** of Datasets, thus avoiding the need to -list potentially thousands of individual dataset identifiers in a -journal publication. - -You publish data in the following way: go to , -login and select all the datasets, that you want to publish under a -new DOI. - -![Selecting Datasets to be published](assets/images//screenshots/PublishingData1.png "Selecting Datasets to be published") - -Then you add these datasest a a "shopping cart" by using the "add to -Cart" button. You can repeat this often as needed. Once finished with -the selection you can "check out" the cart (click on the cart in the -top bar) and pick the "Publish" action. - -![Check out cart](assets/images//screenshots/PublishingData2.png "Check out cart") - -This opens a form. The image below contains all fields that are mandatory and must be filled. - -![Defining metadata of published data](assets/images//screenshots/PublishingData3.png "Defining metadata of published data") - -By clicking on "Save and Continue" and later on "Publish" -(makes the data publicly available) defines the data as to -be published and makes it known to the data catalog, but -the corresponding DOI is not yet made globally available. -For this last step to happen, someone with access to this -newly generated published data definition (e.g. the person defining -the published data or e.g. the PI) has to hit the "register" -button. This will trigger the global publication of the DOI. The links -on are usually updated within one day, so wait one day -before following these links or searching for the doi via the doi -resolver. - -All published data definitions are then openly available via the so -called "Landing Pages", which are hosted on . - -For now all publication are triggered by a scientist explicitly, -whenever necessary. In future in addition an automated publication -after the embargo period (default 3 years after data taking) will be -implemented (details to be defined) +See the dedicated page [Publish Datasets with a DOI](publishing.md). ## Cleanup and Retention diff --git a/docs/publishing.md b/docs/publishing.md new file mode 100644 index 0000000..916b229 --- /dev/null +++ b/docs/publishing.md @@ -0,0 +1,49 @@ +--- +title: Publish Datasets with a DOI +--- + +As part of a publication workflow datasets must become citable via a +digital object identifier (DOI). This assignment is done as part of +the publication workflow described below. The publication then can +link to these published datasets using this DOI. The DOIs can link to +both raw and/or derived datasets. The published data and therefore the +DOI ususally refers to a **set** of Datasets, thus avoiding the need to +list potentially thousands of individual dataset identifiers in a +journal publication. + +You publish data in the following way: go to , +login and select all the datasets, that you want to publish under a +new DOI. + +![Selecting Datasets to be published](assets/images//screenshots/PublishingData1.png "Selecting Datasets to be published") + +Then you add these datasest a a "shopping cart" by using the "add to +Cart" button. You can repeat this often as needed. Once finished with +the selection you can "check out" the cart (click on the cart in the +top bar) and pick the "Publish" action. + +![Check out cart](assets/images//screenshots/PublishingData2.png "Check out cart") + +This opens a form. The image below contains all fields that are mandatory and must be filled. + +![Defining metadata of published data](assets/images//screenshots/PublishingData3.png "Defining metadata of published data") + +By clicking on "Save and Continue" and later on "Publish" +(makes the data publicly available) defines the data as to +be published and makes it known to the data catalog, but +the corresponding DOI is not yet made globally available. +For this last step to happen, someone with access to this +newly generated published data definition (e.g. the person defining +the published data or e.g. the PI) has to hit the "register" +button. This will trigger the global publication of the DOI. The links +on are usually updated within one day, so wait one day +before following these links or searching for the doi via the doi +resolver. + +All published data definitions are then openly available via the so +called "Landing Pages", which are hosted on . + +For now all publication are triggered by a scientist explicitly, +whenever necessary. In future in addition an automated publication +after the embargo period (default 3 years after data taking) will be +implemented (details to be defined) diff --git a/mkdocs.yml b/mkdocs.yml index 24e29f7..2ff607a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,4 +52,6 @@ theme: nav: - index.md - gettingStarted.md - - ingestorManual.md \ No newline at end of file + - Ingestor Manual: + - ingestorManual.md + - publishing.md \ No newline at end of file -- 2.54.0