Merge pull request #25 from miguelfc/documentation

Documentation changes

README.md

@@ -1,7 +1,12 @@
 # Marble Initiative
 
 This is the main repository for the Marble Initiative project. 
-More information about it could be found in the [main website] (http://marble.miguelfc.com/), and more technical information in
+
+[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo.
+
+The platform is able to extract tweets from [Twitter](https://twitter.com), using both the Search (history) and the Streaming (real-time) API, process the tweets extracted and extract their polarity values, and visualize the results using charts and reports.
+
+More information about it could be found in the [main website](http://marble.miguelfc.com/), and more technical information in
 the [Wiki pages](https://github.com/miguelfc/marble/wiki) of this repository. 
 
 ## Usage
@@ -14,11 +19,9 @@ All modules for this project are published in docker hub for free (as in speech)
 - [miguelfc/marble-processor-stanford](https://hub.docker.com/r/miguelfc/marble-processor-stanford/)
 - [miguelfc/marble-processor-nltk](https://hub.docker.com/r/miguelfc/marble-processor-nltk/)
 - [miguelfc/marble-processor-sklearn](https://hub.docker.com/r/miguelfc/marble-processor-sklearn/)
-- [miguelfc/marble-processor-python2](https://hub.docker.com/r/miguelfc/marble-processor-python2/)
-- [miguelfc/marble-processor-python3](https://hub.docker.com/r/miguelfc/marble-processor-python3/)
 - [miguelfc/marble-plotter-simple](https://hub.docker.com/r/miguelfc/marble-plotter-simple/)
 
-*(The python2 and python3 processor images are just the base structure for future python processors, they don't perform any processing at the moment)*
+*(The python2 and python3 processor modules found in the project are just the base structure for future python processors, they don't perform any processing at the moment)*
 
 A `docker-compose.yml` configuration file is available for you to use directly on a docker-capable server. You will only need access to internet to start using marble (you don't even need a database, as it will be provided by docker too!).
 
@@ -47,8 +50,8 @@ Then, just go to the `docker` folder in a terminal, and execute the following co
 
 Docker will retrieve the latest version of all module images, and start the marble service. You will have two services available:
 
-- The marble portal at port `8080`.
-- The eureka registry at port `1111`.
+- The marble portal at port [`8080`](http://localhost:8080)
+- The eureka registry at port [`1111`](http://localhost:1111)
 
 If you want to keep an eye on the logs of one or all the modules running, you can execute the `logs` command of `docker-compose`: 
 

docker/core-config/application.yml

@@ -1,10 +1,10 @@
 access:
   admin:
-    username: ''
-    password: ''
+    username: 'youshouldchangethis'
+    password: 'yesyoudo'
   oper:
-    username: ''
-    password: ''
+    username: 'pleasechangethis'
+    password: 'prettyplease'
   guest:
-    username: ''
-    password: ''
+    username: 'youmustchangethisnow'
+    password: 'changeitnowplease'

docs/index.html

@@ -8,7 +8,7 @@
 
 	<title>Marble Initiative</title>
 
-	<link rel="shortcut icon" href="assets/images/favicon.ico">
+	<link rel="shortcut icon" href="assets/images/favicon.png">
 
 	<link rel="stylesheet" media="screen" href="http://fonts.googleapis.com/css?family=Open+Sans:300,400,700">
 	<link rel="stylesheet" href="assets/css/bootstrap.min.css">
@@ -122,15 +122,14 @@ <h3>Is it ready?</h3>
 			</div>
 			<div class="col-sm-6">
 				<h3>I want to try it anyway. Can I?</h3>
-				<p>Sure!. You will need a Java EE application Server, a MongoDB instance for the data, and a PostgreSQL database as the hibernate repository. We use Wildfly 8/Java 7 in our development environments, but any modern application server should work (you will need to modify some configuration files, though).</p>
+				<p>Sure!. You will need a server with internet connection and docker installed, and everything else will be taken care of. Be sure to follow the instructions on our <a href="https://github.com/miguelfc/marble">github site</a>, and you will get a MongoDB, an Eureka registry and the full marble platform using a single command from the shell.</p>
 			</div>
 		</div> <!-- /row -->
 
 		<div class="row">
 			<div class="col-sm-6">
 				<h3>Where is the documentation?</h3>
-				<p>Well, there is none yet. Hopefully, once we approach the release phase, we will have stabilized the platform (at least to some degree) and we will work on 
-                the documentation.
+				<p>You can find the documentation in the project's <a href="https://github.com/miguelfc/marble/wiki">Wiki</a>, and in the main README file of the project.
 				</p>
 			</div>
 			<div class="col-sm-6">
@@ -149,17 +148,9 @@ <h3>How is this project licensed?</h3>
 			</div>
 			<div class="col-sm-6">
 				<h3>* I'm trying to access the demo but it seems down.</h3>
-				<p>Yes, it could happen. It could be restarting or struggling for resources. Our demo is being kindly hosted by <a href="http://heroku.com">heroku</a>, in a free dyno with limited resources. So, in terms of memory and CPU it will be on the limit for most operations. If you find it down, give it five minutes to recover (sometimes it is just processing stuff on the background) as it usually takes that time to go up. If it doesn't, drop me a line.
 				</p>
 			</div>
 		</div>
-
-        <!--
-		<div class="jumbotron top-space">
-			<h4>.</h4>
-     		<p class="text-right"><a class="btn btn-primary btn-large">Learn more »</a></p>
-  		</div>-->
-
 </div>	<!-- /container -->
 
 	<!-- Social links. @TODO: replace by link/instructions in template -->

marble-core/pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>org.marble</groupId>
 	<artifactId>marble-core</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>1.0.0-RELEASE</version>
 
 	<properties>
 		<java.version>1.8</java.version>
@@ -17,7 +17,7 @@
 	<parent>
 		<groupId>org.marble</groupId>
 		<artifactId>marble</artifactId>
-		<version>1.0.0-SNAPSHOT</version>
+		<version>1.0.0-RELEASE</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 
@@ -54,7 +54,7 @@
 		<dependency>
 			<groupId>org.marble</groupId>
 			<artifactId>marble-model</artifactId>
-			<version>1.0.0-SNAPSHOT</version>
+			<version>1.0.0-RELEASE</version>
 		</dependency>
 		<dependency>
 			<!-- Setup Spring Boot -->
@@ -162,6 +162,7 @@
 		</dependency>
 	</dependencies>
 	<build>
+		<finalName>app</finalName>
 		<resources>
 			<resource>
 				<directory>${basedir}/src/main/resources</directory>
@@ -242,6 +243,10 @@
 				</executions>
 				<configuration>
 					<imageName>${docker.image.prefix}/${project.artifactId}</imageName>
+					<imageTags>
+                        <imageTag>${project.version}</imageTag>
+                        <imageTag>latest</imageTag>
+                    </imageTags>
 					<dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory>
 					<resources>
 						<resource>

marble-core/src/main/docker/Dockerfile

@@ -1,6 +1,5 @@
 FROM java:8
 VOLUME /tmp
-ADD marble-core-1.0.0-SNAPSHOT.jar app.jar
+ADD app.jar app.jar
 RUN bash -c 'touch /app.jar'
-EXPOSE 1111
 CMD cd config & java -jar ../app.jar

marble-core/src/main/docker/README-short.txt

@@ -0,0 +1 @@
+Main module for Marble, an opinion mining platform, modular and open sourced.

marble-core/src/main/docker/README.md

@@ -0,0 +1,39 @@
+# Supported tags and respective `Dockerfile` links
+
+-	[`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile)
+
+# What is Marble?
+
+[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo.
+
+Marble is composed of several modules. This one, marble-core, represents the main module, providing the backend and frontend capabilities to the system.
+
+All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble).
+
+# How to use this image
+
+As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use.
+
+The required services are mongodb, registry and core, so you can launch them using the up subcommand:
+
+```console
+$ docker-compose up mongodb registry core
+```
+
+If you want to launch all the provided modules, then you can just use the up subcommand without arguments:
+
+```console
+$ docker-compose up
+```
+
+Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser.
+
+For more specific details please check the [Github project](https://github.com/miguelfc/marble).
+
+# Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project.
+
+# Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

marble-model/pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.marble</groupId>
     <artifactId>marble-model</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0-RELEASE</version>
     <packaging>jar</packaging>
 
     <parent>

marble-plotter-simple/pom.xml

@@ -3,13 +3,13 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.marble</groupId>
     <artifactId>marble-plotter-simple</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0-RELEASE</version>
     <packaging>jar</packaging>
 
     <parent>
         <groupId>org.marble</groupId>
         <artifactId>marble</artifactId>        
-        <version>1.0.0-SNAPSHOT</version>
+        <version>1.0.0-RELEASE</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
@@ -22,7 +22,7 @@
         <dependency>
             <groupId>org.marble</groupId>
             <artifactId>marble-model</artifactId>
-            <version>1.0.0-SNAPSHOT</version>
+            <version>1.0.0-RELEASE</version>
         </dependency>
 
         <dependency>
@@ -67,6 +67,7 @@
     </dependencies>
 
     <build>
+        <finalName>app</finalName>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
@@ -93,6 +94,10 @@
                 </executions>
                 <configuration>
                     <imageName>${docker.image.prefix}/${project.artifactId}</imageName>
+                    <imageTags>
+                        <imageTag>${project.version}</imageTag>
+                        <imageTag>latest</imageTag>
+                    </imageTags>
                     <dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory>
                     <resources>
                         <resource>

marble-plotter-simple/src/main/docker/Dockerfile

@@ -1,6 +1,5 @@
 FROM java:8
 VOLUME /tmp
-ADD marble-plotter-simple-1.0.0-SNAPSHOT.jar app.jar
+ADD app.jar app.jar
 RUN bash -c 'touch /app.jar'
-EXPOSE 1111
 ENTRYPOINT ["java","-jar","/app.jar"]

marble-plotter-simple/src/main/docker/README-short.txt

@@ -0,0 +1 @@
+Plotter module for Marble, an opinion mining platform, modular and open sourced.

marble-plotter-simple/src/main/docker/README.md

@@ -0,0 +1,39 @@
+# Supported tags and respective `Dockerfile` links
+
+-	[`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile)
+
+# What is Marble?
+
+[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo.
+
+Marble is composed of several modules. This one, marble-plotter-simple, is a plotter module, providing charts and report to the system.
+
+All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble).
+
+# How to use this image
+
+As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use.
+
+The required services are mongodb, registry and core, so you can launch them using the up subcommand:
+
+```console
+$ docker-compose up mongodb registry core
+```
+
+If you want to launch all the provided modules, then you can just use the up subcommand without arguments:
+
+```console
+$ docker-compose up
+```
+
+Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser.
+
+For more specific details please check the [Github project](https://github.com/miguelfc/marble).
+
+# Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project.
+
+# Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

marble-preprocessor-simple/pom.xml

@@ -3,13 +3,13 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.marble</groupId>
     <artifactId>marble-preprocessor-simple</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0-RELEASE</version>
     <packaging>jar</packaging>
 
     <parent>
         <groupId>org.marble</groupId>
         <artifactId>marble</artifactId>        
-        <version>1.0.0-SNAPSHOT</version>
+        <version>1.0.0-RELEASE</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
@@ -22,7 +22,7 @@
         <dependency>
             <groupId>org.marble</groupId>
             <artifactId>marble-model</artifactId>
-            <version>1.0.0-SNAPSHOT</version>
+            <version>1.0.0-RELEASE</version>
         </dependency>
 
         <dependency>
@@ -62,6 +62,7 @@
     </dependencies>
 
     <build>
+        <finalName>app</finalName>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
@@ -88,6 +89,10 @@
                 </executions>
                 <configuration>
                     <imageName>${docker.image.prefix}/${project.artifactId}</imageName>
+                    <imageTags>
+                        <imageTag>${project.version}</imageTag>
+                        <imageTag>latest</imageTag>
+                    </imageTags>
                     <dockerDirectory>${project.basedir}/src/main/docker</dockerDirectory>
                     <resources>
                         <resource>

marble-preprocessor-simple/src/main/docker/Dockerfile

@@ -1,6 +1,5 @@
 FROM java:8
 VOLUME /tmp
-ADD marble-preprocessor-simple-1.0.0-SNAPSHOT.jar app.jar
+ADD app.jar app.jar
 RUN bash -c 'touch /app.jar'
-EXPOSE 1111
 ENTRYPOINT ["java","-jar","/app.jar"]

marble-preprocessor-simple/src/main/docker/README-short.txt

@@ -0,0 +1 @@
+Preprocessor module for Marble, an opinion mining platform, modular and open sourced.

marble-preprocessor-simple/src/main/docker/README.md

@@ -0,0 +1,39 @@
+# Supported tags and respective `Dockerfile` links
+
+-	[`1.0.0-RELEASE`, `latest` (*Dockerfile*)](https://github.com/miguelfc/marble/blob/76d5017b1438a4c2c00fd401b9f1a8f8bcdb73db/marble-core/src/main/docker/Dockerfile)
+
+# What is Marble?
+
+[Marble](http://marble.miguelfc.com/) is an opinion mining platform, modular and open sourced. This is part of a PhD project, being developed by [Miguel Fernandes](http://miguelfernandes.com/) for the University of Vigo, under the supervision of Ana Fernández Vilas and Rebeca Díaz Redondo.
+
+Marble is composed of several modules. This one, marble-preprocessor-simple, is a preprocessor module, providing cleaning methods to be used along processor modules.
+
+All the modules of the platform them described in the [Github project](https://github.com/miguelfc/marble).
+
+# How to use this image
+
+As there are some dependencies between modules (namely mongodb, registry and core), it is recommended to use docker-compose to launch the required services in a coordinated way. There is a [docker-compose.yml](https://github.com/miguelfc/marble/blob/master/docker/docker-compose.yml) file provided as a baseline for you to use.
+
+The required services are mongodb, registry and core, so you can launch them using the up subcommand:
+
+```console
+$ docker-compose up mongodb registry core
+```
+
+If you want to launch all the provided modules, then you can just use the up subcommand without arguments:
+
+```console
+$ docker-compose up
+```
+
+Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. You can also access the registry via `http://localhost:11111` or `http://host-ip:1111` in a browser.
+
+For more specific details please check the [Github project](https://github.com/miguelfc/marble).
+
+# Issues
+
+If you have any problems with or questions about this image, please contact us through a [Github issue](https://github.com/miguelfc/marble/issues/new) in the Github project.
+
+# Contributing
+
+You are invited to contribute new features, fixes, or updates, large or small. Before you start to code, we recommend discussing your plans through a [Github issue](https://github.com/miguelfc/marble/issues/new), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.