Merge pull request #13 from EUDAT-B2FIND/guidelines

Guidelines

ckanext/b2find/templates/ckanext/guidelines/introduction.html

@@ -17,7 +17,6 @@ <h4><i class="icon-wrench"></i> UNDER CONSTRUCTION <i class="icon-wrench"></i></
     <div class="module-content">
       <h1 class="page-heading">{{ _('Introduction') }}</h1>
 
-
         <p>Welcome to the guidelines of the metadata service EUDAT-B2FIND for data providers. These guidelines are intended to provide information about the requirements for successful integration in B2FIND.</p>
 
 <!--
@@ -39,11 +38,10 @@ <h3><a name="audience">Intended Audience</a></h3>
 
         <h3><a name="audience">Objective</a></h3>
 
-
         <p>EUDAT-B2FIND gathers together diverse metadata related to research output of many heterogeneous sources, with the aim of providing a unified discovery portal allowing widespread and cross-disciplinary search and access to the underlying data collections. </p>
 
-        <p>The B2FIND guidelines provide instructions to be followed and policies to be fulfilled during the establishment of the associated ingestion workflow.
-</p>
+        <p>The B2FIND guidelines provide instructions to be followed and policies to be fulfilled during the establishment of the ingestion workflow associated with successful publishing of metadata.</p>
+        <p>Our intention is to provide a low-barrier approach for integrating research data related metadata to B2FIND. </p>   
 
 
         <h3><a name="principles">Open research data principles</a></h3>
@@ -55,17 +53,21 @@ <h3><a name="principles">Open research data principles</a></h3>
 	      <li>the value of data curation to enable data access and reuse,</li> 
 	      <li> support for developing researchers’ data skills,</li> 
 	      <li> cultural norms of academia that ensure individuals can gain credit for data sharing.</li> 
-	     </ul>
+	    </ul>
 	  </p>
 
-	<p>To the extend that these principles affect metadata we address them in the following sections.</p>
-	<p>In general great importance is lied to provide a low-barrier approach to allow easy integration in B2FIND.</p>   
-
+	<p>To the extent that these principles affect metadata we address them in the following sections.</p>
+
         <h3><a name="content">Contents of the Guidelines</a></h3>
       <p>The guidelines are divided in three thematic paragraphs :
 	<ol>
-	  <li>The first section addresses the policies for <a href="http://b2find.eudat.eu/guidelines/providing.html">Providing Metadata for EUDAT-B2FIND</a>, e.g. policies about the structure and availability of the provided metadata.</li>          <li>The subsequent section focuses on the <a href="http://b2find.eudat.eu/guidelines/harvesting.html">Harvesting of Metadata by B2FIND</a>.</li>
-	  <li>And finally we investigate the <a href="http://b2find.eudat.eu/guidelines/mapping.html"> Mapping onto the common B2FIND Schema</a> and gave some recommendations how metadata quality can be improved or asured during this process.</li>
+	  <li> <a href="http://b2find.eudat.eu/guidelines/providing.html">Providing Metadata for EUDAT-B2FIND</a> establishes policies and directives, e.g.about which syntax, structure and licencing of the provided metadata is required.</li>
+          <li> <a href="http://b2find.eudat.eu/guidelines/harvesting.html">Harvesting of Metadata by B2FIND</a> describes the interfaces and APIs supported by B2FIND to transfer metadata exposed by the data providers to B2FIND.</li>
+	  <li> <a href="http://b2find.eudat.eu/guidelines/mapping.html"> Mapping onto the common B2FIND Schema</a> explains how the existing, community-specific metadata are homogenised to the unique and common B2FIND schema.
+<!-- Not yet shown
+     Beside the definition of the B2FIND schema we discuss in this context how metadata quality can be checked, assured and, if necessary, improved.
+-->
+	  </li>
 	</ol>
 
       </p>
@@ -76,14 +78,14 @@ <h3><a name="workflow">B2FIND Workflow</a></h3>
 
       <figure>
         <img border="1" vspace="1" class="left" src="/images/B2FIND_Workflow.png" width="600" height="120" alt="B2FIND ingestion workflow">
-        <figcaption> The B2FIND ingestion workflow</figcaption>
+        <figcaption> The B2FIND metadata ingestion workflow</figcaption>
       </figure>
 
       <p>Beside the first (MD Generation) and last (MD Uploading) step, the sub processes ‘MD Providing’, ‘MD Harvesting’ and ‘MD Mapping’ correspond to the paragraphs of the guidelines.</p>
-      <p>While we don't go in the technical details, we refer
+      <p>These guidelines don’t go in the technical details, but there is more detailed information available:
 	<ul>
-	  <li>data managers who are interested in the step by step implementation of the whole MD ingestion workflow to the <a href="https://github.com/EUDAT-Training/B2FIND-Training"> B2FIND-Training </a> and </li>
-	  <li>developers who are interested in the underlying software and the sourcecode to the github repository <a href="https://github.com/EUDAT-B2FIND"> EUDAT-B2FIND </a>.</li>.
+	  <li>Data managers who are interested in the step by step implementation of the whole MD ingestion workflow are referred to the <a href="https://github.com/EUDAT-Training/B2FIND-Training"> B2FIND-Training </a> material. </li>
+	  <li>Developers who are interested in the underlying software find the source code in the github repository <a href="https://github.com/EUDAT-B2FIND"> EUDAT-B2FIND </a>.</li>.
 
         <h3><a name="versions">Versions</a></h3>
 	<ul>
@@ -101,6 +103,7 @@ <h3><a name="editors">Editors</a></h3>
         <li>Heinke Höck, DKRZ</li>
         <li>Mikael Karlsson, CSC</li>
         <li>Michael Kurtz, DKRZ</li>
+        <li>Claudia Martens, DKRZ</li>
         <li>Hannes Thiemann, DKRZ</li>
         <li>Heinrich Widmann, DKRZ</li>
       </ul>