Documentation improvements. (#324)

Author: tobiasake

wiki/markdown/docker.md

@@ -18,35 +18,32 @@ With the Docker image user can try-out the Eiffel-Intelligence on a Docker Host
 
 ## Follow these step to build the Docker image.
 
-1. Build the Eiffel-intelligence war file:
-`mvn package -DskipTests`
+**1** Build the Eiffel-intelligence war file:
+    
+    mvn package -DskipTests
 
 
 This will produce a war file in the "target" folder.
 
-
-2. Build the Docker image with the war file that was produced from previous step:
-
-
-`docker build -t eiffel-intelligence-backend:1.0.1 --build-arg URL=./target/eiffel-intelligence-1.0.1.war -f src/main/docker/Dockerfile .`
-
+**2** Build the Docker image with the war file that was produced from previous step:
+    
+    docker build -t eiffel-intelligence-backend:1.0.1 --build-arg URL=./target/eiffel-intelligence-1.0.1.war -f src/main/docker/Dockerfile .
 
 Now docker image has build with tag "eiffel-intelligence-backend:1.0.1"
 
 ## Run Docker image on local Docker Host
 To run the produced docker image on the local Docker host, execute this command:
-
-
-`docker run -p 8070:8080 --expose 8080 -e server.port=8080 -e logging.level.log.level.root=DEBUG -e logging.level.org.springframework.web=DEBUG -e logging.level.com.ericsson.ei=DEBUG -e spring.data.mongodb.host=mongodb -e spring.data.mongodb.port=27017 eiffel-intelligence:1.0.1`
+    
+    docker run -p 8070:8080 --expose 8080 -e server.port=8080 -e logging.level.log.level.root=DEBUG -e logging.level.org.springframework.web=DEBUG -e logging.level.com.ericsson.ei=DEBUG -e spring.data.mongodb.host=mongodb -e spring.data.mongodb.port=27017 eiffel-intelligence:1.0.1
 
 MongoDB, RabbitMq and other Eiffel-Intelligence required components need to running and configured via these application properties that is provided to the docker command above. See the application.properties file for all available/required properties:
-[application.properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties)
+[application.properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties)
 
 
-# Some info of all flags to this command
+## Some info about all flags to this command
 
 
-## Eiffel Intelligence Spring Properties
+### Eiffel Intelligence Spring Properties
 
 
 <B>"-e server.port=8080"</B> - Is the Spring property setting for Eiffel-Intelligence applications web port.
@@ -58,11 +55,10 @@ logging.level.com.ericsson.ei=DEBUG"</B> - These Spring properties set the loggi
 
 It is possible to set all Spring available properties via docker envrionment "-e" flag. See the application.properties file for all available Eiffel-Intelligence Spring properties:
 
+[application.properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties)
 
-[application.properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties)
 
-
-## Docker flags
+### Docker flags
 
 
 <B>"--expose 8080"</B> - this Docker flag tells that containers internal port shall be exposed to outside of the Docker Host. This flag do not set which port that should be allocated outside Docker Host on the actual server/machine.
@@ -75,17 +71,18 @@ When Eiffel-Intelligence container is running on your local Docker host, Eiffel-
 
 
 Another option to configure Eiffel-Intelligence is to provide the application properties file into the container, which can be made in two ways:
-1. Put application.properties file in Tomcat Catalina config folder in container and run Eiffe-Intelligence:
-
-`docker run -p 8070:8080 --expose 8080 --volume /path/to/application.properties:/usr/local/tomcat/config/application.properties eiffel-intelligence:0.0.19`
 
-2. Put application.properties file in a different folder in container and tell EI where the application.properties is located in the container:
+**1** Put application.properties file in Tomcat Catalina config folder in container and run Eiffel-Intelligence:
+    
+    docker run -p 8070:8080 --expose 8080 --volume /path/to/application.properties:/usr/local/tomcat/config/application.properties eiffel-intelligence:0.0.19
 
-`docker run -p 8070:8080 --expose 8080 --volume /path/to/application.properties:/tmp/application.properties -e spring.config.location=/tmp/application.properties eiffel-intelligence:0.0.19`
+**2** Put application.properties file in a different folder in container and tell EI where the application.properties is located in the container:
+    
+    docker run -p 8070:8080 --expose 8080 --volume /path/to/application.properties:/tmp/application.properties -e spring.config.location=/tmp/application.properties eiffel-intelligence:0.0.19
 
 
 # Run Docker image with provided docker-compose file
-This docker-compose file includes these components, [docker-compose.yml](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/docker/docker-compose.yml):
+This docker-compose file includes these components, [docker-compose.yml](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/docker/docker-compose.yml):
 - mongodb
 - rabbitmq
 - eiffel-er
@@ -97,31 +94,30 @@ The variable EI_BACKEND_IMAGE needs to be updated to the value of your
 recently built image: "eiffel-intelligence:1.0.1".
 
 Then run following docker-compose command to startup all components:
-
-`docker-compose -f src/main/docker/docker-compose.yml up -d`
+    
+    docker-compose -f src/main/docker/docker-compose.yml up -d
 
 It will take some minutes until all components has started. When all components has loaded, you should be able to access EI-Backend REST-interfaces with address:
 http://localhost:8080/\<EI rest-api endpoint\>
 
 Curl command can be used to make request to EI-Backend REST API, example for getting all subscriptions:
-
-
-`curl -X GET http://localhost:8080/subscriptions`
+    
+    curl -X GET http://localhost:8080/subscriptions
 
 It is also possible to access these Rest-Api addresses in web-browser and get result present in a Json view in web-browser.
 
 Following command can be used to get the logs from the EI-Backend container/service:
-
-`docker-compose -f src/main/docker/docker-compose.yml logs ei-backend`
+    
+    docker-compose -f src/main/docker/docker-compose.yml logs ei-backend
 
 All service names can be retreived with following command:
+    
+    docker-compose -f src/main/docker/docker-compose.yml config --services
 
-`docker-compose -f src/main/docker/docker-compose.yml config --services`
-
-It is also possible to retrieve the logs by only using "docker logs <container_id or container_name>" command:
-
-`docker logs <container_id or container_name>`
+It is also possible to retrieve the logs by using standard "docker" command:
+    
+    docker logs <container_id or container_name>
 
 Container id can be retrieved with docker command:
-
-`docker ps`
+    
+    docker ps

wiki/markdown/running-eiffel-intelligence.md

@@ -18,7 +18,15 @@ append **_-DskipTests_** if you want to skip the tests since the latest on
 master always has passed the tests. The war file should now be found under
 target folder in your cloned project.
 
-Now that you have the executable run :
+If you run from source code, you can run Eiffel-Intelligence front-end with maven command:
+
+    mvn spring-boot:run
+
+With properties added to the maven command, e.g:
+    
+    mvn spring-boot:run -Dlogging.level.com.ericsson.ei=DEBUG -Dspring.data.mongodb.port=27019
+
+Or you can run the executable war file (located in target folder, if running from source code):
 
     java -jar eiffel-intelligence-<version>.war
 
@@ -36,3 +44,5 @@ for more information about using external configuration.
 If only few properties need to be overridden then use java opts, for example
 
     java -jar eiffel-intelligence-<version>.war -Dspring.data.mongodb.port=27019
+
+All available Eiffel-Intelligence properties can be found in [application.properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties) example file.