Vorto Features Overview. Fixes #315

Signed-off-by: Guenther Michael (INST/BSV2-TD) <[email protected]>

website/_data/doclinks.yml

@@ -4,11 +4,11 @@
     - title: "Overview"
       href: "/documentation/overview/introduction.html"
     - title: "Features"
-      href: "/documentation/overview/introduction.html#features"
+      href: "/documentation/overview/features.html"
     - title: "Significant Contribution"
-      href: "/documentation/overview/introduction.html#significant-contribution"
+      href: "/documentation/overview/contribution.html"
     - title: "System Requirements"
-      href: "/documentation/overview/introduction.html#system-requirements"
+      href: "/documentation/overview/system-requirements.html"
 - title: "Installation"
   href: ""
   sub:

website/documentation/overview/contribution.md

@@ -0,0 +1,19 @@
+---
+layout: documentation
+title: Contribution
+---
+
+{% include base.html %}
+
+
+## Significant Contribution
+
+The Vorto project considers the following contributions as significant contribution:
+
+- Giving technical input to the Vorto Meta Information Model that leads to an update of the current ecore model.
+- Giving input to the project that leads to a high prioritized bug in [Github Issues](https://github.com/eclipse/vorto/issues).
+- Implementing and contributing a new Vorto code generator to the project.
+- Fixing a bug that is considered as critical.
+- Implementing a complex feature.
+
+If you satisfy our requirements for significant contribution, email your logo to <strong><mailto:[email protected]></strong> to get added to our homepage.

website/documentation/overview/features.md

@@ -0,0 +1,21 @@
+---
+layout: documentation
+title: Features
+---
+
+{% include base.html %}
+
+## Features
+
+Vorto is characterized by the following features:
+
+* Describe device characteristics and services as Information Models with the Eclipse Vorto Toolset  
+  ![Vorto Features Models]({{base}}/img/documentation/vorto_features_models.png)
+* Share & Reuse Information Models via a centralized Vorto Repository  
+  ![Search page]({{base}}/img/documentation/vorto_repository_search.png)
+* Many Example Generators to translate Information Models into executable platform-specific code  
+  For example, LWM2M, AWS, ThingWorx, MQTT etc.  
+  ![Generators]({{base}}/img/documentation/vorto_repository_generators.png)
+* Developer API to plug-in other platform generators  
+* Command Line Interface Tool to access the Vorto Repository  
+  ![Vorto CLI Tool]({{base}}/img/documentation/vorto_features_cli_tool.png)

website/documentation/overview/introduction.md

@@ -11,11 +11,11 @@ This section details the following topics:
 
 [Overview](#overview)
 
-[Features](#features)
+[Features](./features.html)
 
-[Significant Contribution](#significant-contribution)
+[Significant Contribution](./contribution.html)
 
-[System Requirements](#system-requirements)
+[System Requirements](./system-requirements.html)
 
 ## Overview
 
@@ -26,85 +26,3 @@ Standardization organizations and industry consortia work hard on device abstrac
 The Vorto project is an approach to leverage the standardization of so called Information Models. Information models are abstract representations of real world devices following a meta information model which is also part of the project. The meta information model shall be very flexible and easy to use. In addition, the project scope includes an eclipse based toolset that allows for creating information models, a repository for finding, managing and sharing information models, and last but not least a set of code generators that allow for the creation of information model based code artifacts to be employed in specific solutions.
 
 ![More about Vorto]({{base}}/img/documentation/vorto_eclipse_overview_L.png)
-
-
-## Features
-
-Vorto allows the user to create the following:
-
-**Datatypes**  
-Vorto provides a facility to create a new data type (Entity or Enum). You can use auto-completion and validation to update data types.
-
-**Function block model**  
-Vorto provides a facility to create a function block model project containing all necessary resources.
-
-**Information model**  
-Information models represent the capabilities of a particular type of device in its entirety. An information model contains one or more function blocks. Vorto allows to create an information model project and all required resources.
-
-**Mapping model**  
-Vorto provides a facility to create a mapping model from existing Datatype, Function block, or Information models.
-
-**Generate code**  
-Vorto provides a facility to create information model based code artifacts which you can use in specific solutions by choosing a suitable generator from the list of existing generators or allows the user to implement/create his own code generator
-
-**DSL editors**  
-The new Domain-specific Language (DSL) is a simple way to define and read datatype models, function block models and information models without the need to understand XML, XSD or even Java. On-the-fly auto-completion and validation lets you create the named models even faster than ever.
-
-* _Datatype model DSL editor:_
-
-![Datatype model DSL editor]({{base}}/img/documentation/m2m_tc_datatype_model_dsl_editor.png)
-
-* _Function block model DSL editor:_
-
-![Function block model DSL editor]({{base}}/img/documentation/m2m_tc_function_block_model_dsl_editor.png)
-
-* _Information model DSL editor:_
-
-![Information model DSL editor]({{base}}/img/documentation/m2m_tc_information_model_dsl_editor.png)
-
-* _Mapping model DSL editor:_
-
-Vorto provides Mapping DSL editor for user to create customized mapping that map a vorto model to another platform model.
-
-**Vorto perspective**  
-The Vorto perspective as a new Eclipse perspective simplifies the view and, thus, the work with the more abstract models.
-
-![Vorto Perspective]({{base}}/img/documentation/m2m_tc_vorto_perspective.png)
-
-
-**Example code generators**  
-Vorto provides several code generators, so that the user can generate code based on the select information model. Vorto also provides a code generator extension point, so that the user can create his own code generator.
-
-![Generating function block model]({{base}}/img/documentation/m2m_vorto_code_generator_menu.png)
-
-## Significant Contribution
-
-The Vorto project considers the following contributions as significant contribution:
-
-- Giving technical input to the Vorto Meta Information Model that leads to an update of the current ecore model.
-- Giving input to the project that leads to a high prioritized bug in [Github Issues](https://github.com/eclipse/vorto/issues).
-- Implementing and contributing a new Vorto code generator to the project.
-- Fixing a bug that is considered as critical.
-- Implementing a complex feature.
-
- If you satisfy our requirements for significant contribution, email your logo to <strong><mailto:[email protected]></strong> to get added to our homepage.
-
-## System Requirements
-
-For the use of the Vorto Toolset the following software requirements must be met:
-
-- Eclipse
-  - [Eclipse IDE for Java and DSL Developers](http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-dsl-developers/mars2) (Mars or higher)  
-    or
-  - [Eclipse IDE](http://www.eclipse.org/downloads/packages/release/Mars/2) (Mars or higher)
-  - [Xtext](http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/) 2.9.x (or higher)
-- [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/)
-
-<table class="table table-bordered">
-<tbody>
-  <tr>
-    <td><i class="fa fa-info-circle info-note"></td>
-    <td>Validity period will endure at the most as long as the version of infrastructure software of third party manufacturers defined in this document (Operating Systems, Java, etc.) is publicly and officially supported. We support the most recent patch releases of the respective software product version.</td>
-  </tr>
- </tbody>
-</table>

website/documentation/overview/system-requirements.md

@@ -0,0 +1,56 @@
+---
+layout: documentation
+title: System Requirements
+---
+
+{% include base.html %}
+
+
+## System Requirements
+
+For the use of the Vorto Toolset the following software requirements must be met:
+
+- Eclipse
+  - [Eclipse IDE for Java and DSL Developers](http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-dsl-developers/mars2) (Mars or higher)  
+    or
+  - [Eclipse IDE](http://www.eclipse.org/downloads/packages/release/Mars/2) (Mars or higher)
+  - [Xtext](http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/) 2.9.x (or higher)
+- [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/)
+
+<table class="table table-bordered">
+<tbody>
+  <tr>
+    <td><i class="fa fa-info-circle info-note"></td>
+    <td>To avoid using a wrong Java version, you can set the required Java version as a preference in the <code>eclipse.ini</code> file:
+    <code><br />
+      -vmargs<br />
+      -Dosgi.requiredJavaVersion=1.8<br />
+      ...
+    </code></td>
+  </tr>
+ </tbody>
+</table>
+
+<table class="table table-bordered">
+<tbody>
+  <tr>
+    <td><i class="fa fa-info-circle info-note"></td>
+    <td>Your operating system, Java installation and Eclipse installation must <strong>all</strong> have either 32bit or 64bit architecture!<br />
+    If necessary, you can align the path to the correct Java version as a preference in the <code>eclipse.ini</code> file, e.g.:
+    <code><br />
+      -vm<br />
+      C:\Program Files\Java\jdk8\bin\javaw.exe<br />
+      ...
+    </code></td>
+  </tr>
+ </tbody>
+</table>
+
+<table class="table table-bordered">
+<tbody>
+  <tr>
+    <td><i class="fa fa-info-circle info-note"></td>
+    <td>Validity period will endure at the most as long as the version of infrastructure software of third party manufacturers defined in this document (Operating Systems, Java, etc.) is publicly and officially supported. We support the most recent patch releases of the respective software product version.</td>
+  </tr>
+ </tbody>
+</table>

website/documentation/vorto-repository/cli-tool/cli-tool.md

@@ -23,7 +23,7 @@ Vorto Command Line Interface (CLI) tool is REST-Client that allows you, to acces
 
 The CLI-Tool is based on a simple structure.
 
-It consists of a Command Line Interface as well as a **.yaml** file, that stores all necessary configuration properties like _Username_, _Password_, _Proxy_ and _Repository_.
+It consists of a Command Line Interface as well as a `.yaml` file, that stores all necessary configuration properties like _Username_, _Password_, _Proxy_ and _Repository_.
 
 ## Installation
 
@@ -33,16 +33,18 @@ A very convenient way to use the CLI Tool is, to add the path of the directory i
 
 ![Environment Variable]({{base}}/img/documentation/cli_evnmt_variable.jpg)
 
-Before you can use the CLI Tool as a REST Client, you need to initialize basic preferences. The preferences are stored in a `C:\Users\{$username}\.vortocli.yaml.file`, which is located in your home directory.
+Before you can use the CLI Tool as a REST Client, you need to initialize basic preferences. The preferences are stored in the file `.vortocli.yaml`, which is located in your home directory (in Windows, for example: `C:\Users\{$username}\`).
 
-You have to setup vorto via **vorto config**. If you want to initialize vorto with additional values (or change them afterwards) like _-username_, _-password_, _-proxy_ and _-repo_, then you can extend the **vorto config** command with four additional flag parameters _-username_, _-password_, _-proxy_ and _-repo_, or you can edit the _.vortocli.yaml_ file via text editor. 
+You have to setup vorto in one of the following ways:
 
-	vorto config -username andreas -password test1234 -repo http://vorto.eclipse.org/repo
+* Use the **vorto config** command.  
+  To initialize vorto with additional values (or change them afterwards) like username, password, proxy or repository, use the command flags `-username`, `-password`, `-proxy` or `-repo`.  
+  Example: `vorto config -username <username> -password <password> -repo http://vorto.eclipse.org`
+* Edit the `.vortocli.yaml` file with a text editor.  
+  ![CLI Yaml file]({{base}}/img/documentation/yamlfile.jpg)
 
 Congratulations! - Setup is done and you are now able to use the Vorto CLI Tool.
 
-![CLI Yaml file]({{base}}/img/documentation/yamlfile.jpg)
-
 
 ## CLI Commands