#3 Fix typos in index + generated doc.

crossminer · Nov 24, 2018 · 3c5f357 · 3c5f357
1 parent 78bad10
commit 3c5f357
Show file tree

Hide file tree

Showing 29 changed files with 324 additions and 49 deletions.
diff --git a/docs/development/Contributing.md b/docs/development/Contributing.md
@@ -1,5 +1,5 @@
 
-# Contributing 
+# Contributing
 
 ## Subcategories
 
@@ -29,7 +29,3 @@
 
 * [How to integrate OSGI service plugin in SCAVA Architecture](OSGI Component Integration) Todo
 * [How to communicate between OSGI plugin using JMS](OSGI Plugin Communication) Todo
-
-### TEMPLATE
-
-* [[Guideline Template|Guideline Main Heading]]
diff --git a/docs/development/Development-Guidelines.md b/docs/development/Development-Guidelines.md
@@ -93,6 +93,7 @@ The repository will contain the code of the high-level components shown in Table
 | Metric Providers | /metric-platform | YORK, CWI, AUEB, EHU |
 | Data Storage | /metric-platform | SFT |
 | Web-based dashboards | /web-dashboards | BIT |
+
 Table 1: Leaders and Contributors of the CROSSMINER Deployment diagram nodes
 
 

diff --git a/site/admin/API-Gateway-Configuration/index.html b/site/admin/API-Gateway-Configuration/index.html
@@ -195,6 +195,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/admin/Access-to-MongoDB-database-using-PONGO/index.html b/site/admin/Access-to-MongoDB-database-using-PONGO/index.html
@@ -220,6 +220,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/admin/SCAVA-Administration/index.html b/site/admin/SCAVA-Administration/index.html
@@ -193,6 +193,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/architecture/API-Gateway-Component/index.html b/site/architecture/API-Gateway-Component/index.html
@@ -203,6 +203,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/architecture/Authentication-Component/index.html b/site/architecture/Authentication-Component/index.html
@@ -197,6 +197,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/deploy/Docker-Ossmeter/index.html b/site/deploy/Docker-Ossmeter/index.html
@@ -195,6 +195,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/deploy/Docker-SCAVA/index.html b/site/deploy/Docker-SCAVA/index.html
@@ -201,6 +201,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/deploy/Platform-configuration/index.html b/site/deploy/Platform-configuration/index.html
@@ -207,6 +207,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/deploy/Running-the-platform/index.html b/site/deploy/Running-the-platform/index.html
@@ -203,6 +203,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../../development/How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../../development/Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/development/Component-Naming/index.html b/site/development/Component-Naming/index.html
@@ -189,6 +189,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../Implementing-Restlet-Service/">Implementing Restlet Service</a>
 

diff --git a/site/development/Contributing/index.html b/site/development/Contributing/index.html
@@ -193,6 +193,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../Implementing-Restlet-Service/">Implementing Restlet Service</a>
 
@@ -338,10 +345,6 @@ <h3 id="osgi">OSGI</h3>
 <ul>
 <li><a href="../OSGI Component Integration">How to integrate OSGI service plugin in SCAVA Architecture</a> Todo</li>
 <li><a href="../OSGI Plugin Communication">How to communicate between OSGI plugin using JMS</a> Todo</li>
-</ul>
-<h3 id="template">TEMPLATE</h3>
-<ul>
-<li>[[Guideline Template|Guideline Main Heading]]</li>
 </ul>
 
             </div>

diff --git a/site/development/Development-Guidelines/index.html b/site/development/Development-Guidelines/index.html
@@ -199,6 +199,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../Implementing-Restlet-Service/">Implementing Restlet Service</a>
 
@@ -325,7 +332,7 @@ <h2 id="process-overview">Process overview</h2>
 <p><img alt="Dev Process for Scava" src="../images/scava_dev_process_1.png" />
 Figure 1. Overview of the CROSSMINER development process and tools</p>
 <h3 id="source-code-repository">Source Code Repository</h3>
-<p>Different branches will be created in the repository. In particular, the <code>master</code> branch is the main branch and represents the released state of the product. The <code>dev</code> branch contains the most recent code integrated by partners before release. These two branches are always clean, build and run all the tests successfully.</p>
+<p>Different branches will be created in the repository. In particular, the <code>master</code> branch is the main branch and represents the released state of the product. It is always clean, builds and runs all the tests successfully. The <code>dev</code> branch contains the most recent code integrated by partners before release.</p>
 <p>Other branches will be created for the different features/components, which will be eventually merged in the <code>dev</code> branch. The name of each branch contains the id of the issue it is supposed to implement.</p>
 <p>All source code, binary code and conﬁguration needed to build a working implementation of the system will reside in a GitHub repository.</p>
 <ul>
@@ -362,7 +369,7 @@ <h3 id="continuous-integration-server">Continuous Integration Server</h3>
 <li>Quality analysis on source code</li>
 <li>Perform all the necessary actions to create a fully functioning build of the software when all tests have passed</li>
 </ul>
-<p>The currently used CI server is available at http://ci5.castalia.camp:8080/ </p>
+<p>The currently used CI server is available at http://ci5.castalia.camp:8080/</p>
 <h3 id="development-and-production-environments">Development and Production environments</h3>
 <p>According to the DoW we have not promised the availability of a public installation of the CROSSMINER platform (i.e., a production environment). However, in order to implement the different use cases, use case partners are provided with docker images enabling the local installation of the whole CROSSMINER platform.</p>
 <h2 id="naming-and-change-conventions">Naming and change conventions</h2>
@@ -379,67 +386,67 @@ <h2 id="naming-and-change-conventions">Naming and change conventions</h2>
 <tr>
 <td>DevOps Dashboard</td>
 <td></td>
-<td>CWI</td>
+<td>BIT</td>
 </tr>
 <tr>
 <td>Workflow Diagram Editor</td>
 <td>/crossflow</td>
-<td>EHU</td>
+<td>YORK</td>
 </tr>
 <tr>
 <td>Administration Web Application</td>
 <td>/administration</td>
-<td>AUEB</td>
+<td>SFT</td>
 </tr>
 <tr>
 <td>IDE</td>
 <td>/eclipse-based-ide</td>
-<td>YORK</td>
+<td>FEA</td>
 </tr>
 <tr>
 <td>API Gateway</td>
 <td>/api-gateway</td>
-<td>UDA</td>
+<td>SFT</td>
 </tr>
 <tr>
 <td>DevOps Backend</td>
 <td></td>
-<td>FEA</td>
+<td>BIT</td>
 </tr>
 <tr>
 <td>Knowledge Base</td>
 <td>/knowledge-base</td>
-<td>BIT</td>
+<td>UDA</td>
 </tr>
 <tr>
 <td>Project Analyser</td>
 <td>/metric-platform</td>
-<td>SFT, UNP</td>
+<td>SFT</td>
 </tr>
 <tr>
 <td>Data Collector</td>
 <td>/metric-platform</td>
-<td>SFT, UNP</td>
+<td>SFT</td>
 </tr>
 <tr>
 <td>Project Scheduler</td>
 <td>/metric-platform</td>
-<td>SFT, UNP</td>
+<td>SFT</td>
 </tr>
 <tr>
 <td>Metric Providers</td>
 <td>/metric-platform</td>
-<td>SFT, UNP</td>
+<td>YORK, CWI, AUEB, EHU</td>
 </tr>
 <tr>
 <td>Data Storage</td>
 <td>/metric-platform</td>
-<td>SFT, UNP</td>
+<td>SFT</td>
 </tr>
 <tr>
-<td>ElasticSearch</td>
-<td>/metric-platform</td>
-<td>SFT, UNP</td>
+<td>Web-based dashboards</td>
+<td>/web-dashboards</td>
+<td>BIT</td>
 </tr>
 <tr>
 <td>Table 1: Leaders and Contributors of the CROSSMINER Deployment diagram nodes</td>
@@ -448,18 +455,31 @@ <h2 id="naming-and-change-conventions">Naming and change conventions</h2>
 </tr>
 </tbody>
 </table>
+<p><img alt="Scava components architecture" src="../images/scava_architecture.png" />
+Figure 2: Scava components architecture</p>
 <p>For each component a corresponding folder is available in the repository. Changes must have a CR (i.e. issue) entry for traceability. In particular, the requirements and objectives of each Scava components will be detailed in the relevant deliverables and they will be added in the form of items in the provided Bug Tracking infrastructure. In this way progress on the implementation of each requirement can be tracked. Thus:</p>
 <ul>
 <li>when developers want to operate changes they have to create corresponding issues in the bug tracking system for traceability reasons;</li>
 <li>when a developer wants to perform changes on a component led by an organization, which is different than that the developer belongs to, a pull request (PR) has to be done. Such a PR will be managed by one of the members of the organization leading the component affected by the changes in the PR.</li>
 </ul>
 <p>The partner in charge of managing the development of a component will be free to organize the content of the corresponding subdirectory in any way as long as the following standard ﬁles/directories are contained in the component folder:</p>
 <ul>
-<li>readme.md. This ﬁle will contain the entry-point to all documentation for the component.</li>
-<li>Jenkinsfile: In order to compile the component, run tests, etc on the CI server.</li>
-<li>test: this is a folder containing the unit and/or integration tests.</li>
+<li><code>readme.md</code> : this ﬁle will contain the entry-point to all documentation for the component.</li>
+<li><code>Jenkinsfile</code>: in order to compile the component, run tests, etc on the CI server.</li>
+<li><code>test</code>: this is a folder containing the unit and/or integration tests.</li>
 </ul>
-<p>As a reference, please have a look at https://github.com/crossminer/scava/tree/master/knowledge-base </p>
+<p>As a reference, please have a look at https://github.com/crossminer/scava/tree/master/knowledge-base</p>
+<p>The following items are typical practices when applying CI:
+<em> Maintain a code repository
+</em> Automate the build
+<em> Make the build self-testing
+</em> Everyone commits to the baseline every day
+<em> Every commit (to baseline) should be built
+</em> Keep the build fast
+<em> Test in a clone of the production environment
+</em> Make it easy to get the latest deliverables
+<em> Everyone can see the results of the latest build
+</em> Automate deployment</p>
 <h2 id="communication-and-collaboration-means">Communication and collaboration means</h2>
 <p>The development activities can be done by exploiting different communication and collaboration means. In particular, currently the consortium members have the availability of:</p>
 <ul>

diff --git a/site/development/Extend-MongoDB-Data-Model/index.html b/site/development/Extend-MongoDB-Data-Model/index.html
@@ -199,6 +199,13 @@
 
 
 
+    <li class="toctree-l1 ">
+        <a class="" href="../How-To-Develop-Metric-Provider/">How To Develop Metric Provider</a>
+
+    </li>
+
+
+
     <li class="toctree-l1 ">
         <a class="" href="../Implementing-Restlet-Service/">Implementing Restlet Service</a>
 
@@ -423,7 +430,7 @@ <h2 id="comment">Comment</h2>
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="../Implementing-Restlet-Service/" class="btn btn-neutral float-right" title="Implementing Restlet Service">Next <span class="icon icon-circle-arrow-right"></span></a>
+        <a href="../How-To-Develop-Metric-Provider/" class="btn btn-neutral float-right" title="How To Develop Metric Provider">Next <span class="icon icon-circle-arrow-right"></span></a>
 
 
         <a href="../Development-Guidelines/" class="btn btn-neutral" title="Development Guidelines"><span class="icon icon-circle-arrow-left"></span> Previous</a>
@@ -455,7 +462,7 @@ <h2 id="comment">Comment</h2>
         <span><a href="../Development-Guidelines/" style="color: #fcfcfc;">&laquo; Previous</a></span>
 
 
-        <span style="margin-left: 15px"><a href="../Implementing-Restlet-Service/" style="color: #fcfcfc">Next &raquo;</a></span>
+        <span style="margin-left: 15px"><a href="../How-To-Develop-Metric-Provider/" style="color: #fcfcfc">Next &raquo;</a></span>
 
     </span>
 </div>