Build scava-docs site

docs/developers-guide/runing-from-sources/analysis-platform.md

@@ -41,7 +41,7 @@ git checkout dev
 
 Open Eclipse and import all projects from the top level directory of the Scava code (`File -> Import -> Maven -> Existing Maven Projects`), and wait for all the projects to compile without errors.
 
-Meanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors iincluding 
+Meanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors including 
 [Tycho Plugin](https://www.eclipse.org/tycho/).
 <br/>
 <img src="images/m2e-connectors.png" height="500px" width="500px"><br/>

site/developers-guide/runing-from-sources/analysis-platform/index.html

@@ -608,7 +608,7 @@ <h2 id="configuration">Configuration</h2>
 <h3 id="configure-the-eclipse-ide">Configure The Eclipse IDE</h3>
 <h4 id="import-projects-into-eclipse-workspace">Import Projects into Eclipse Workspace</h4>
 <p>Open Eclipse and import all projects from the top level directory of the Scava code (<code>File -&gt; Import -&gt; Maven -&gt; Existing Maven Projects</code>), and wait for all the projects to compile without errors.</p>
-<p>Meanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors iincluding 
+<p>Meanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors including 
 <a href="https://www.eclipse.org/tycho/">Tycho Plugin</a>.
 <br/>
 <img src="images/m2e-connectors.png" height="500px" width="500px"><br/></p>

site/index.html

@@ -648,5 +648,5 @@ <h3 id="useful-links">Useful links:</h3>
 
 <!--
 MkDocs version : 0.16.3
-Build Date UTC : 2019-12-20 09:55:08
+Build Date UTC : 2019-12-20 09:56:56
 -->

site/mkdocs/search_index.json

@@ -872,7 +872,7 @@
         },
         {
             "location": "/developers-guide/runing-from-sources/analysis-platform/",
-            "text": "Running the Analysis Platform form Sources\n\n\nThis is a quick start guide to get the SCAVA platform running from source with Eclipse.\n\n\nPrerequisite\n\n\nInstall MongoDB\n\n\nYou can download MongoDB from the \nMongoDb website\n.\n\n\nInstall EclipseIDE\n\n\nAlthough these instructions may apply to other versions of Eclipse IDE, they were tested under Eclipse Neon.3 with plug-in development support (Eclipse IDE for RCP Developers package).\n\n\nGet the Code\n\n\nGet the latest version of the code, and checkout the \ndev\n branch. Please don't commit to the \nmaster\n branch: see the \nDevelopment Guidelines\n:\n\n\nIf you are using \nLinux / OS X\n:\n\n\ngit clone https://github.com/crossminer/scava.git scava\ncd scava\ngit checkout dev\n\n\n\n\nIf you are using \nWindows\n you need to do things differently due to Windows' long file name limit. In the Git shell:\n\n\nmkdir scava\ncd scava\ngit init\ngit config core.longpaths true\ngit add remote origin https://github.com/crossminer/scava.git\ngit fetch\ngit checkout dev\n\n\n\n\nConfiguration\n\n\nConfigure The Eclipse IDE\n\n\nImport Projects into Eclipse Workspace\n\n\nOpen Eclipse and import all projects from the top level directory of the Scava code (\nFile -> Import -> Maven -> Existing Maven Projects\n), and wait for all the projects to compile without errors.\n\n\nMeanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors iincluding \n\nTycho Plugin\n.\n\n\n\n\n\nFigure-01: Install m2e-connectors plugins.\n\n\nConfigure the Target Platform\n\n\nThe Scava Analysis Platform is based on the Mars version of the RCP Eclipse. In order to run the platform in a newer eclipse environment, you will have to download the Eclipse Mars platform and configure it as Target Platform.\n\n\n\n\nDownload Eclipse Mars platform\n\nDownload the compleate Eclipse Mars platform.\n\n\n\n\nIn command ligne :\n\n\n./eclipse -nosplash -verbose -application org.eclipse.equinox.p2.metadata.repository.mirrorApplication -source http://download.eclipse.org/releases/mars -destination {your platform folder}\n\n\n\n\n./eclipse -nosplash -verbose -application org.eclipse.equinox.p2.artifact.repository.mirrorApplication -source http://download.eclipse.org/releases/mars -destination {your platform folder}\n\n\n\n\nThen, extract the its context somewehere on your machine.\n\n\n\n\nDownload Rascal dependencies\n\n\n\n\nDownload two external libraries required to run metrics providers based on Rascal.\n\n\nRepository URL : \nRascal Dependencies\n\n\n\n\nimpulse_0.3.0.xxx.jar\n\n\n\n\nrascal_eclipse_0.12.0.xxx.jar\n\n\n\n\n\n\nConfigure the Target Platform\n\n\n\n\n\n\nOpen the Eclipse preferences on (\nWindow -> Preferencies\n), then choose the Target Platform Definition (\nPlug-in Development -> Target Platform\n).\n\n\n\nFigure-02: Eclipse Preferences.\n\n\nAdd a new Target Platform configuration for the project, choose the Default initialization then click on (\nNext\n).\n\n\n\nFigure-03: Eclipse Target Platforms Initialization.\n\n\nGive a name to the new target platform, hit the (\nAdd\n) button to add the Eclipse Mars dependencies and the external rascal libraries content to the target, then click on (\nFinish\n).\n\n\n\nFigure-04: Eclipse Target Platforms Dependencies.\n\n\nFinally, check the new target Configuration, then click on (\nApply and Close\n) to save the changes.\n\n\n\n\nFigure-05: Eclipse Target Platforms.\n\n\nConfigure the Analysis Platform\n\n\nidentifier=<your name>\n\n\nThe identifier of the node. If not specified, the platform will attempt to use the node's hostname, and if it cannot resolve the hostname, it will generated a random UUID. \n\n\nIf you plan to multiple instances of the platform on the same machine, you should definitely specify different node identifiers.\n\n\nlog.type=console|file|rolling\n\n\nYou can specify whether to log output to the console (Log4J's ConsoleAppender), to a particular file without a size limit (Log4J's FileAppender), or to a different file per day (Log4J's DailyRollingFileAppender). If you specify \nfile\n or \nrolling\n, you must complete the \nlog.file.path\n or \nlog.rolling.path\n property as well. \n\n\nIf the property is not specified, it will default to the console logger.\n\n\nlog.file.path=<path>\n\n\nThe path to the file to store the log. E.g. \nlog.file.path=/tmp/lovelylog.log\n\n\nlog.rolling.path=<path>\n\n\nThe path to the file to store the log. This is a Log4J DailyRollingFileAppender that will create separate logs for each 12 hours of the day. The date stamp will be appended to the path provided. E.g.: if you specify \nlog.rolling.path=/tmp/mylovelylog.log\n, it will store files like so: \n/tmp/mylovelylog.log.2014-12-17-00\n and \n/tmp/mylovelylog.log.2014-12-17-12\n.\n\n\nmaven_executable=<path>\n\n\nThe path to where Maven is installed. E.g. \nmaven_executable=/usr/bin/mvn\n\n\nstorage_path=<path>\n\n\nThe path to where files should be stored. E.g. \nstorage_path=/mnt/ossmeter/\n\n\nmongo_hosts\n\n\nA comma-separated list of the hosts and ports in a replica set. E.g. \nua002:27017,ua009:27017,ua019:27017,ua020:27017\n\n\nRun the Analysis Platform\n\n\nStart MongoDB\n\n\nInstructions for starting mongo can be found in the MongoDB \nmanual\n. For example:\n\n\nsudo systemctl start mongod\n\n\n\n\nor\n\n\nsudo service mongod start\n\n\n\n\nRun the api-gateway\n\n\n\n\nRight click on\n\nscava-api-gateway/src/main/java/org.eclipse.scava.apigateway/ApiGatewayApplication.java\n\n\nThen click on Run As -> Java Application\n\n\n\n\nRun the authentication service\n\n\n\n\nRight click on\n\nscava-auth-service/src/main/java/org.eclipse.scava.authservice/AuthServiceApplication.java\n\n\nThen click on Run As -> Java Application\n\n\n\n\nValidate and Run the Platform\n\n\nOpen \nreleng/org.eclipse.scava.product/scava.product\n\n  * Click the \nValidate...\n icon in the top right of the product configuration editor (the icon is a piece of paper with a tick)\n  * If things do not validate, there's something wrong -- get in touch :) Problems related to \norg.eclipse.e4.core.di\n aren't critical.\n  * Then, click the \nExport an Eclipse product\n on the left of the \nValidate...\n button. Uncheck the \nGenerate p2 repository\n checkbox, select a destination directory and validate. After a while, the SCAVA platform will be generated in the selected directory.\n  * The platform can then be run using the generated \neclipse\n binary; it accepts the following arguments:\n    * \n-apiServer\n: Starts up the client API on localhost:8182\n    * \n-worker ${id-worker}\n: Spawns a thread that analyses registered projects\n  * To get a full platform running, first launch a worker thread, then the API server.\n\n\nWhen starting the platform, you can pass a configuration file to control the behaviour of the platform:\n\n\n./eclipse -worker ${id-worker} -config myconfiguration.properties",
+            "text": "Running the Analysis Platform form Sources\n\n\nThis is a quick start guide to get the SCAVA platform running from source with Eclipse.\n\n\nPrerequisite\n\n\nInstall MongoDB\n\n\nYou can download MongoDB from the \nMongoDb website\n.\n\n\nInstall EclipseIDE\n\n\nAlthough these instructions may apply to other versions of Eclipse IDE, they were tested under Eclipse Neon.3 with plug-in development support (Eclipse IDE for RCP Developers package).\n\n\nGet the Code\n\n\nGet the latest version of the code, and checkout the \ndev\n branch. Please don't commit to the \nmaster\n branch: see the \nDevelopment Guidelines\n:\n\n\nIf you are using \nLinux / OS X\n:\n\n\ngit clone https://github.com/crossminer/scava.git scava\ncd scava\ngit checkout dev\n\n\n\n\nIf you are using \nWindows\n you need to do things differently due to Windows' long file name limit. In the Git shell:\n\n\nmkdir scava\ncd scava\ngit init\ngit config core.longpaths true\ngit add remote origin https://github.com/crossminer/scava.git\ngit fetch\ngit checkout dev\n\n\n\n\nConfiguration\n\n\nConfigure The Eclipse IDE\n\n\nImport Projects into Eclipse Workspace\n\n\nOpen Eclipse and import all projects from the top level directory of the Scava code (\nFile -> Import -> Maven -> Existing Maven Projects\n), and wait for all the projects to compile without errors.\n\n\nMeanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors including \n\nTycho Plugin\n.\n\n\n\n\n\nFigure-01: Install m2e-connectors plugins.\n\n\nConfigure the Target Platform\n\n\nThe Scava Analysis Platform is based on the Mars version of the RCP Eclipse. In order to run the platform in a newer eclipse environment, you will have to download the Eclipse Mars platform and configure it as Target Platform.\n\n\n\n\nDownload Eclipse Mars platform\n\nDownload the compleate Eclipse Mars platform.\n\n\n\n\nIn command ligne :\n\n\n./eclipse -nosplash -verbose -application org.eclipse.equinox.p2.metadata.repository.mirrorApplication -source http://download.eclipse.org/releases/mars -destination {your platform folder}\n\n\n\n\n./eclipse -nosplash -verbose -application org.eclipse.equinox.p2.artifact.repository.mirrorApplication -source http://download.eclipse.org/releases/mars -destination {your platform folder}\n\n\n\n\nThen, extract the its context somewehere on your machine.\n\n\n\n\nDownload Rascal dependencies\n\n\n\n\nDownload two external libraries required to run metrics providers based on Rascal.\n\n\nRepository URL : \nRascal Dependencies\n\n\n\n\nimpulse_0.3.0.xxx.jar\n\n\n\n\nrascal_eclipse_0.12.0.xxx.jar\n\n\n\n\n\n\nConfigure the Target Platform\n\n\n\n\n\n\nOpen the Eclipse preferences on (\nWindow -> Preferencies\n), then choose the Target Platform Definition (\nPlug-in Development -> Target Platform\n).\n\n\n\nFigure-02: Eclipse Preferences.\n\n\nAdd a new Target Platform configuration for the project, choose the Default initialization then click on (\nNext\n).\n\n\n\nFigure-03: Eclipse Target Platforms Initialization.\n\n\nGive a name to the new target platform, hit the (\nAdd\n) button to add the Eclipse Mars dependencies and the external rascal libraries content to the target, then click on (\nFinish\n).\n\n\n\nFigure-04: Eclipse Target Platforms Dependencies.\n\n\nFinally, check the new target Configuration, then click on (\nApply and Close\n) to save the changes.\n\n\n\n\nFigure-05: Eclipse Target Platforms.\n\n\nConfigure the Analysis Platform\n\n\nidentifier=<your name>\n\n\nThe identifier of the node. If not specified, the platform will attempt to use the node's hostname, and if it cannot resolve the hostname, it will generated a random UUID. \n\n\nIf you plan to multiple instances of the platform on the same machine, you should definitely specify different node identifiers.\n\n\nlog.type=console|file|rolling\n\n\nYou can specify whether to log output to the console (Log4J's ConsoleAppender), to a particular file without a size limit (Log4J's FileAppender), or to a different file per day (Log4J's DailyRollingFileAppender). If you specify \nfile\n or \nrolling\n, you must complete the \nlog.file.path\n or \nlog.rolling.path\n property as well. \n\n\nIf the property is not specified, it will default to the console logger.\n\n\nlog.file.path=<path>\n\n\nThe path to the file to store the log. E.g. \nlog.file.path=/tmp/lovelylog.log\n\n\nlog.rolling.path=<path>\n\n\nThe path to the file to store the log. This is a Log4J DailyRollingFileAppender that will create separate logs for each 12 hours of the day. The date stamp will be appended to the path provided. E.g.: if you specify \nlog.rolling.path=/tmp/mylovelylog.log\n, it will store files like so: \n/tmp/mylovelylog.log.2014-12-17-00\n and \n/tmp/mylovelylog.log.2014-12-17-12\n.\n\n\nmaven_executable=<path>\n\n\nThe path to where Maven is installed. E.g. \nmaven_executable=/usr/bin/mvn\n\n\nstorage_path=<path>\n\n\nThe path to where files should be stored. E.g. \nstorage_path=/mnt/ossmeter/\n\n\nmongo_hosts\n\n\nA comma-separated list of the hosts and ports in a replica set. E.g. \nua002:27017,ua009:27017,ua019:27017,ua020:27017\n\n\nRun the Analysis Platform\n\n\nStart MongoDB\n\n\nInstructions for starting mongo can be found in the MongoDB \nmanual\n. For example:\n\n\nsudo systemctl start mongod\n\n\n\n\nor\n\n\nsudo service mongod start\n\n\n\n\nRun the api-gateway\n\n\n\n\nRight click on\n\nscava-api-gateway/src/main/java/org.eclipse.scava.apigateway/ApiGatewayApplication.java\n\n\nThen click on Run As -> Java Application\n\n\n\n\nRun the authentication service\n\n\n\n\nRight click on\n\nscava-auth-service/src/main/java/org.eclipse.scava.authservice/AuthServiceApplication.java\n\n\nThen click on Run As -> Java Application\n\n\n\n\nValidate and Run the Platform\n\n\nOpen \nreleng/org.eclipse.scava.product/scava.product\n\n  * Click the \nValidate...\n icon in the top right of the product configuration editor (the icon is a piece of paper with a tick)\n  * If things do not validate, there's something wrong -- get in touch :) Problems related to \norg.eclipse.e4.core.di\n aren't critical.\n  * Then, click the \nExport an Eclipse product\n on the left of the \nValidate...\n button. Uncheck the \nGenerate p2 repository\n checkbox, select a destination directory and validate. After a while, the SCAVA platform will be generated in the selected directory.\n  * The platform can then be run using the generated \neclipse\n binary; it accepts the following arguments:\n    * \n-apiServer\n: Starts up the client API on localhost:8182\n    * \n-worker ${id-worker}\n: Spawns a thread that analyses registered projects\n  * To get a full platform running, first launch a worker thread, then the API server.\n\n\nWhen starting the platform, you can pass a configuration file to control the behaviour of the platform:\n\n\n./eclipse -worker ${id-worker} -config myconfiguration.properties",
             "title": "Analysis platform"
         },
         {
@@ -912,7 +912,7 @@
         },
         {
             "location": "/developers-guide/runing-from-sources/analysis-platform/#import-projects-into-eclipse-workspace",
-            "text": "Open Eclipse and import all projects from the top level directory of the Scava code ( File -> Import -> Maven -> Existing Maven Projects ), and wait for all the projects to compile without errors.  Meanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors iincluding  Tycho Plugin .   Figure-01: Install m2e-connectors plugins.",
+            "text": "Open Eclipse and import all projects from the top level directory of the Scava code ( File -> Import -> Maven -> Existing Maven Projects ), and wait for all the projects to compile without errors.  Meanwhile, the Eclipse IDE would suggest you to install a set of m2e-connectors including  Tycho Plugin .   Figure-01: Install m2e-connectors plugins.",
             "title": "Import Projects into Eclipse Workspace"
         },
         {