Merge pull request #3 from zalf-rdm/updates_by_specka

Updates by specka

retype.yml

@@ -31,13 +31,13 @@ poweredByRetype:
 
 links: # A list of custom links to add to the top bar of the generated website.
   # See also: footer.links
-  - text: ZALF Data Service
+  - text: ZALF Data Services
     link: https://www.zalf.de/en/forschung_lehre/dataservice/Pages/default.aspx # Link to an internal file or external URL.
-    icon: #globe
+    icon: info
     target: blank # Custom target. Use blank to open link in a new window.
     colors:
       text: "#454645" # Custom color for the label text.
-      background: "#ffffff"
+      background: "#cccccc"
 
 # -----------------------------------------------------------------------------
 

src/contact/index.md

@@ -5,10 +5,12 @@ expanded: false
 order: 200
 ---
 
-# Frequently Asked Questions
+# Contact us
 
-### BonaRes Repository
-**Leibniz Centre for Agricultural Landscape Research (ZALF) <br>**
+The BonaRes Repository is operated by the **Leibniz Centre for Agricultural Landscape Research (ZALF)** (www.zalf.de).
+
+#### Contact
+Leibniz Centre for Agricultural Landscape Research (ZALF) <br>
 Eberswalder Strasse 84 <br>
 15374 Müncheberg, Germany <br>
 :icon-person: (+49) 033432 82 300 <br>

src/datapreparation/index.md

@@ -66,7 +66,7 @@ The following formal criteria for tabular data especially submitted as Excel fil
 | 8  | Each line is available **once**(there are no double lines e. g. due to copy errors)                                                |
 
 
-#### Preferred file formats
+### Preferred file formats
 
 In case of **tabular data**, the prepared dataset should be submitted in the file formats:
 - Textfile (*.txt)

src/how_to_publish/dataset_and_metadata.md

@@ -1,5 +1,5 @@
 ---
-label: Dataset and Metadata Submission
+label: Upload dataset and metadata in our Upload Tool
 icon: project-roadmap
 expanded: false
 order: 30
@@ -8,34 +8,48 @@ order: 30
 
 ### Submit a new dataset
 
-After completing the metadata template, click on the **“submit new dataset”** button and **fill** the upload form.
+After completing the metadata template, go back to our [Upload Tool](https://upload.bonares.de) and
+click on the **“submit new dataset”** button. After you logged in a web form will open. 
 
 :::content-center
-![_Submit a new dataset_](/static/img/fig_submit_new_dataset.png)
+![_Upload Tool: Submit a new dataset_](/static/img/fig_submit_new_dataset.png)
 :::
 
 ### Filling out the Upload form
 
-The first step in the upload form is to provide a title and a brief but understandable description of the dataset – analogue to the abstract of a paper but specified to this data. This information is the basis of the metadata.
+Please fill out as much details as possibles.
+
+#### Title and description
+
+First you need to provide a title and a brief but understandable description of the dataset
+– analogue to the abstract of a paper but specified to this data. This information is the
+basis of the metadata. 
+
+!!!
+You can take the title and description from the metadata template and paste it into the respective form field.
+!!!
+
 :::content-center
 ![_Upload form: Title and description of the dataset_](/static/img/fig_title_description.png)
 :::
 
-### Upload form: Selection of Project
+#### Project
 
 The project in which the data were collected must be specified in the following field. You can choose from the BonaRes collaborative projects and some long-term field experiments. For all other data that cannot be assigned to any of these projects, “Other” must be specified. In the future, it should also be possible to manually enter the individual projects.
 :::content-center
 ![_Upload form: Project_](/static/img/fig_project.png)
 :::
 
-### Upload form: Selection of the relevant Research Domain
+#### Research Domain
 
-When selecting the research domain, the most appropriate domain should be selected. Only one domain can be selected. The research domains are based on the categories of the [German Research Foundation (DFG)](https://www.dfg.de/en/dfg_profile/statutory_bodies/review_boards/subject_areas/index.jsp) (FK No. 207 Agriculture, Forestry and Veterinary Medicine).
+When selecting the research domain, the most appropriate domain should be selected.
+Only one domain can be selected. The research domains are based on the categories of
+the [German Research Foundation (DFG)](https://www.dfg.de/en/dfg_profile/statutory_bodies/review_boards/subject_areas/index.jsp) (FK No. 207 Agriculture, Forestry and Veterinary Medicine).
 :::content-center
 ![_Upload form: Selection of the relevant Research Domain_](/static/img/fig_domain.png)
 :::
 
-### Upload form: Specifying the research question
+### Specifying the research question
 
 Now the research question for which the available data were determined can be specified. Of course, there are not "the" good and "the" bad data - but data are of high quality in relation to the research question they are supposed to answer. This enables the potential reuser to better assess the suitability of the data for her research.
 
@@ -51,20 +65,31 @@ If possible, one or more soil functions that match the dataset should be selecte
 ![_Upload form: Selection the soil functions_](/static/img/fig_soil_functions.png)
 :::
 
-### Upload form: Upload dataset, metadata and supplemental material
+### Upload dataset, metadata and supplemental material
 
-In the next step, the dataset, metadata, any additional material, such as pictures, plans or drawings, can be uploaded. Please upload just the actual dataset (only **one** table, **one** dataset, one worksheet). **Multiple worksheets should be split** and uploaded separately.
+In the next step, the dataset, metadata, any additional material, such as pictures, plans or drawings, can be uploaded.
+Please upload just the actual dataset (only **one** table, **one** dataset, one worksheet). **Multiple worksheets
+should be split** and uploaded separately.
 To illustrate the research data, you can use a **data model** that shows the data, e.g. a diagram.
 :::content-center
-![__](/static/img/fig_select_dataset.png)
+![Upoad form: drag and drop your dataset and metadata here](/static/img/fig_select_dataset.png)
 :::
-Afterwards, additional information can be given specifically for the BonaRes Repository. In addition, the BonaRes data guideline must be approved and assured that the authority exists to hand over the data to the repository and that it has not yet been published elsewhere. This means that the data owner does not necessarily have to submit the data himself and can also designate someone else as the data provider.
 
-If all fields have been filled in, the dataset can be transferred to the BonaRes Repository by clicking on **“Submit”**. The BonaRes Repository sends an automatic **confirmation email** afterwards with a ticket number.
 
-### Upload form: Specification of additional information, consent to the data guideline and confirmation of the authorization and the first publication
+
+### Provide additional information
+
+Afterwards, additional information can be given specifically for the BonaRes Repository. In addition, the BonaRes Data 
+Guideline must be approved. You also have to assure that the authority exists to hand over the data to the repository 
+and that it has not yet been published elsewhere. This means that the data owner does not necessarily have to submit
+the data himself and can also designate someone else as the data provider.
 
 :::content-center
-![Additional Information](/static/img/fig_addtional_information.png)
+![Upload form: Additional Information](/static/img/fig_addtional_information.png)
 :::
-If the upload was successful, a summary of the submitted information appears. The processing status can also be viewed on this page. As long as the submitted data are formally checked
+
+### Submit and close upload form
+If all fields have been filled in, the dataset can be transferred to the BonaRes Repository by clicking on **“Submit”**. 
+The BonaRes Repository sends an automatic **confirmation email** afterwards with a ticket number. If the upload was 
+successful, a summary of the submitted information appears. The processing status can also be viewed on this page. 
+As long as the submitted data are formally checked

src/how_to_publish/download_and_fill_out.md

@@ -1,23 +1,35 @@
 ---
-label: Download and fill out the metadata Template
+label: Download and fill out the metadata template
 icon: desktop-download
 expanded: false
 order: 40
 ---
 
 
 !!!success Note
-If data are already published in another open repository, the BonaRes Repository offers to take over the metadata of the dataset and to disseminate it via its own infrastructure. There is a link to the location of the dataset. This means that the research data can also be found via the BonaRes Repository without the need for republication. **Contact the support of the BonaRes Repository here:** [[email protected]]([email protected]).
+If data are already published in another open repository, the BonaRes Repository offers
+to take over the metadata of the dataset and to disseminate it via its own infrastructure.
+There is a link to the location of the dataset. This means that the research data can also
+be found via the BonaRes Repository without the need for republication. 
+**Contact the support of the BonaRes Repository here:** [[email protected]]([email protected]).
 !!!
 
-### Download
+### Download metadata templates
+
+First you need to fill out the metadata templates which will be later submitted together with your dataset.
+Please visit our Upload Tool at https://upload.bonares.de. Here you can find the links for downloading
+the most current metadata template files provided in German and English. 
 
 :::content-center
-![](/static/img/fig_download_metadata.png)
-_Download the metadata template [here](https://tools.bonares.de/submission/)_
+![_Figure 1: Download the metadata template in our Upload Tool._](/static/img/fig_download_metadata.png)
 :::
 
-### How to Fill out the Metadata Template
+### How to till out the metadata template
+
+After downloading the template file please open it for editing. In the following
+sections the required metadata elements are described.
+
+#### Metadata template: page 1
 
 - **Title English:** Max of xxxxx characters
 - **Title German:** Max of xxxx characters
@@ -28,26 +40,32 @@ _Download the metadata template [here](https://tools.bonares.de/submission/)_
 - **Contributor:** click on “choose an element” and select an option.
 
 :::content-center
-![_Metadata template: page 1_](/static/img/fig_template_page1.png)
+![_Figure 2: Metadata template: page 1_](/static/img/fig_template_page1.png)
 :::
 
+#### Metadata template: page 2
+
 - **Funding information:** provide cross ref links if available.
 - **Geographic area:** provide bounding box information from where the data was collected.
 - **Keywords:** click on links and select keywords then write them under each link.
 - **Place keywords:** precise location
 - **Related data already published:** click on “choose an element” and select an option of the Relation Type.
 
 :::content-center
-![_Metadata template: page2_](/static/img/fig_template_page2.png)
+![_Figure 3: Metadata template: page2_](/static/img/fig_template_page2.png)
 :::
 
+#### Metadata template: page 3
+
 - **Dataset details:** describe what each column stands for and precise the units and methods if applicable
-- **For large datasets use extra excel file.** See below. Image/grapic: provide an image that represents your dataset
+- **For large datasets use extra excel file.** (see Figure 5 below). 
 
 :::content-center
-![_Metadata template: page3_](/static/img/fig_template_page3.png)
+![_Figure 4: Metadata template page3_](/static/img/fig_template_page3.png)
 :::
 
+#### Metadata template: data model description in a separate excel file 
 :::content-center
-![_Metadata template: example of excel file for simple data sets_](/static/img/fig_metadata_excel_example.png)
+![_Figure 5: Dataset description of large datasets in an extra Excel file_](/static/img/fig_metadata_excel_example.png)
 :::
+

src/how_to_publish/index.md

@@ -6,6 +6,8 @@ order: 500
 ---
 # How to publish a dataset in the BonaRes Repository 
 
-1. [Registration on BonaRes Repository](/how_to_publish/registration.md)
-2. [Download and fill the Metadata Template](/how_to_publish/download_and_fill_out.md)
-3. [Dataset and Metadata Submission](/how_to_publish/dataset_and_metadata.md)
+There are several steps involved when publishing a dataset in the BonaRes Repository.
+
+1. [Signup and create an user account](/how_to_publish/registration.md)
+2. [Download and fill out the metadata template](/how_to_publish/download_and_fill_out.md)
+3. [Upload both dataset and metadata in our Upload Tool](/how_to_publish/dataset_and_metadata.md)

src/how_to_publish/registration.md

@@ -1,34 +1,40 @@
 ---
-label: Registration
+label: Sign up and create an user acconut
 icon: pencil
 expanded: false
 order: 50
 ---
-# Registration in the  BonaRes Repository
+# Sign up and create a user acconut
 
-A **[one-time registration](https://signup.bonares.de)** is required to use the services of the BonaRes Repository.
+If you have don't have an user account in the BonaRes Repository, a
+**[one-time registration](https://signup.bonares.de)** is required to use the
+services of the BonaRes Repository.
 
-### 1. Signup to the BonaRes Repository
+### 1. Sign up to the BonaRes Repository
 
-Please use https://signup.bonares.de for setting up a user account. Here you need to provide a user name and email 
-address, as well as assignment of a password
+Please use https://signup.bonares.de for setting up a user account. Here you need to provide a:
+   - user name
+   - email and 
+   - password.
 
-   The following conditions must be met for the password:
+   The **password** must fullfil the following criteria:
    - it must consist of at least 8 characters
    - it must contain at least 3 small letters
    - it must differ from the user name and email address
    - it must contain at least 3 character classes (e.g. uppercase, lowercase, special characters, numbers)
 
-![](/static/img/fig_registration.png)
+![_Figure 1: Registration form for a BonaRes account_](/static/img/fig_registration.png)
 
 
-### 2. Reveive confirmation email
+### 2. Receive confirmation email
 
-Once you signed up, you will receive a confirmation mail. 
+Once you signed up, you will receive a confirmation mail in your mailbox. Please check your SPAM folder
+if you do not receive an email.
 
 ### 3. Confirm your email address 
 
-To finish registration process you need to click the link in the email. .
+To finish registration process you need to click the link in the email to confirm, that your
+email address exists and you signed up for a user account.
 
 !!!success  Note:
 If the intention is to submit several datasets of a **research group**, it is possible to organize all 

src/static/custom.css

@@ -13,18 +13,20 @@ nav a {
   font-weight: bold !important;
   font-style: normal;
   font-variation-settings:
-    "wdth" 400 !important;
+    "width" 400 !important;
 }
 
-
+p {
+    margin-bottom: 0px !important;
+}
 
 #docs-site-header {
   background-image: url("./img/header.png");
   background-position: top -4px right 0px;
   background-repeat: no-repeat;
   background-size: cover;
   background-color: #d5dbd5e1;
-  height: 100px;
+  height: 120px;
 }
 
 .infos {

src/submission_details/index.md

@@ -1,24 +1,35 @@
 ---
-label: Submission Details
+label: Overview of dataset submissions
 icon: upload
 expanded: false
 order: 400
 ---
 # Submission Details
 
-Submission Details
+If you click on **My submissions** in the right menu in the [Upload Tool](https://upload.bonares.de), you will
+see an overview of all of your dataset submissions in the BonaRes Repository. It also gives an overview of the 
+completed processing steps of the respective dataset.
+
 
 :::content-center
 ![_List of all records_](/static/img/fig_list_of_all_records.png)
 :::
-**(Status: Submitted)**, it is possible to make changes. As soon as the data have been added to the database and the metadata have been sent 
-**(Status: in progress)**, contact must be made with the BonaRes Repository for subsequent changes.
 
-The history gives an overview of the completed processing steps of the respective dataset.
+The **status** indicates, how far the dataset is processed. 
+
+- **Submitted**: The dataset was successfully submitted to the repository.  
+- **In progress**: The data stewards are working hard on your dataset. If they will have questions, the contact you.
+- **Published**: The dataset was successfully published in the BonaRes Repository.
+
 
 An overview of all datasets submitted so far appears in the user account under [“Submission”](https://tools.bonares.de/submission/) under **“My dataset submissions”**. If you have any questions or problems, the ticket number should always be given.
 
 :::content-center
-![_Submission details_](/static/img/fig_submission_details.png)
+![_Figure: Details of a submitted datasets_](/static/img/fig_submission_details.png)
 :::
-After a dataset has been transferred to the BonaRes Repository, it is checked formally and in terms of content  (e. g. thematically fit into the BonaRes Repository) by data stewards. Formal checks are, e. g. empty columns, outliers or not plausible values. Conspicuous data are communicated back to the data provider. In the future, the test should carried out by an automated tool. After a dataset passed this formal check, further metadata will be prepared (see chapter Metadata), which can be downloaded as PDF.
+
+!!!
+After a dataset has been transferred to the BonaRes Repository, it is checked formally and in terms of content 
+(e. g. thematically fit into the BonaRes Repository) by data stewards. Formal checks are, e. g. empty columns,
+outliers or not plausible values. Conspicuous data are communicated back to the data provider.
+!!!