initial commit of the hawkBit documentation (#343)

Signed-off-by: Michael Hirsch <michael.hirsch@bosch-si.com>

docs/src/main/resources/_includes/base.html

@@ -0,0 +1,14 @@
+<!--base to have relative path for offline navigation -->
+
+{% assign base = '' %}
+{% assign depth = page.url | split: '/' | size | minus: 1 %}
+{% if    page.permalink != null %}
+  {% assign depth = depth | plus: 1 %}
+{% endif %}
+{% if    depth == 1 %}{% assign base = '' %}
+{% elsif depth == 2 %}{% assign base = '..' %}
+{% elsif depth == 3 %}{% assign base = '../..' %}
+{% elsif depth == 4 %}{% assign base = '../../..' %}
+{% elsif depth == 5 %}{% assign base = '../../../..' %}
+{% elsif depth == 6 %}{% assign base = '../../../../..' %}{% endif %}
+ 

docs/src/main/resources/_includes/footer.html

@@ -0,0 +1,25 @@
+<!-- Footer -->
+<footer>
+   <div class="container">
+   <div class="row">
+         <div class="col-md-4">
+           <h3 class="footer-links-header">Quick Links</h3>
+           <ul class="footer-links clearfix">
+             <li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
+             <li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
+             <li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
+             <li><a href="http://www.eclipse.org/legal/">Legal</a></li>
+           </ul>
+           <ul class="footer-links clearfix">
+             <li><a href="http://www.eclipse.org">Eclipse Home</a></li>
+             <li><a href="http://marketplace.eclipse.org/">Market Place</a></li>
+             <li><a href="http://live.eclipse.org/">Eclipse Live</a></li>
+             <li><a href="http://www.planeteclipse.org/">Eclipse Planet</a></li>
+           </ul>
+           </div>
+         <div class="col-md-2">
+          
+   </div>
+</footer>
+
+<!--/.Footer-->

docs/src/main/resources/_includes/header.html

@@ -0,0 +1,34 @@
+<!--Header section Site navigation -->
+
+{% include base.html %}
+<!-- Navigation -->
+<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+		<div class="container">
+				<div class="navbar-header">
+						<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-collapse">
+								<span class="sr-only">Toggle navigation</span>
+								<span class="icon-bar"></span>
+								<span class="icon-bar"></span>
+								<span class="icon-bar"></span>
+						</button>
+						<a class="navbar-brand" href="{{base}}/index.html">Eclipse hawkBit™</a>
+				</div>
+				<div class="collapse navbar-collapse wow fadeIn" id="navbar-collapse" data-wow-delay="0.2s">
+						<ul class="nav navbar-nav pull-right">
+							{% for menu in site.data.menus %}
+								<li {% if page.path contains menu.url %} class ="active"{% endif %}>
+									{% if menu.url contains 'https://' or menu.url contains 'http://' %}
+										<a target="_blank" href="{{ menu.url }}">{{ menu.name }}</a>
+									{% else %}
+										<a href="{{base}}/{{ menu.url }}">{{ menu.name }}</a>
+
+									{% endif %}
+								</li>
+							{% endfor %}
+						</ul>
+				</div>
+				<!-- /.navbar-collapse -->
+		</div>
+		<style>#forkongithub a{background:#8d0c0c;color:#fff;text-decoration:none;font-family:Arial, Helvetica, sans-serif;text-align:center;font-weight:bold;padding:5px 40px;font-size:12px;line-height:3rem;position:relative;transition:0.5s;}#forkongithub a:hover{background:#c11;color:#fff;}#forkongithub a::before,#forkongithub a::after{content:"";width:100%;display:block;position:absolute;top:1px;left:0;height:1px;background:#fff;}#forkongithub a::after{bottom:1px;top:auto;}@media screen and (min-width:800px){#forkongithub{position:fixed;display:block;top:0;right:0;width:50px;overflow:visible;height:200px;z-index:9999;}#forkongithub a{width:260px;position:absolute;top:40px;right:-60px;transform:rotate(45deg);-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);-moz-transform:rotate(45deg);-o-transform:rotate(45deg);}}</style><span id="forkongithub"><a href="https://github.com/eclipse/hawkbit">Fork me on GitHub</a></span>
+		<!-- /.container -->
+</nav>

docs/src/main/resources/_includes/headhomepagesection.html

@@ -0,0 +1,65 @@
+<!--Head section for CSS/Javascript  -->
+
+<head>
+  <meta charset="utf-8">
+  <meta content='width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no' name='viewport'>
+  <meta name="description" content="IoT Eclipse hawkBit">
+  <meta name="author" content="">
+  {% include base.html %}
+  <title>Eclipse hawkBit - IoT Software Update</title>
+
+  <!--Stylesheets-->
+  <!-- Bootstrap 3.3.1 -->
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/css/bootstrap.min.css" rel="stylesheet" type="text/css" />
+  <!-- Font Awesome Icons -->
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.css" rel="stylesheet" type="text/css" />
+  <link rel="stylesheet" href="{{base}}/css/prettyPhoto.css" type="text/css" media="screen" title="prettyPhoto main stylesheet" charset="utf-8" />-
+
+  <!-- Custom CSS -->
+  <link href="{{base}}/css/hawkbit.css" rel="stylesheet">
+
+  <!-- Wow CSS -->
+  <link href="{{base}}/css/animate.css" rel="stylesheet">
+  <!--<link href="https://cdnjs.cloudflare.com/ajax/libs/wow/1.1.2/animate.css" rel="stylesheet">-->
+
+
+  <!--Javascript-->
+  <!-- JQuery 2.1.1-->
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
+  <!-- Bootstrap 3.3.1 JS -->
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js" type="text/javascript"></script>
+
+  <!-- Below css/js is only for Homepage -->  
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/wow/1.1.2/wow.min.js"></script>
+  <!-- Custom JS -->
+  <script src="{{base}}/js/app.js"></script>
+
+  	<script>
+  	  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  	  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  	  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  	  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  	  ga('create', 'UA-61866024-1', 'auto');
+  	  ga('send', 'pageview');
+  </script>
+<script src="{{base}}/js/jquery.prettyPhoto.js" type="text/javascript" charset="utf-8"></script>
+  <script type="text/javascript" charset="utf-8">
+               $(document).ready(function(){
+                 $("a[rel^='prettyPhoto']").prettyPhoto();
+               });
+  </script>
+  <script type="text/javascript" charset="utf-8">
+    new WOW().init();
+  </script>
+  <script type="text/javascript">
+$(document).ready(function(){
+    
+    $(".tip-right").tooltip({
+        placement : 'right'
+    });
+    
+});
+</script>
+
+</head>

docs/src/main/resources/_includes/headsection.html

@@ -0,0 +1,31 @@
+<!--Head section for CSS/Javascript  -->
+
+<head>
+  <meta charset="utf-8">
+  <meta content='width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no' name='viewport'>
+  <meta name="description" content="IoT Software Update">
+  <meta name="author" content="">
+  {% include base.html %}
+  <title>Eclipse hawkBit - IoT Software Update</title>
+
+  <!--Stylesheets-->
+  <!-- Bootstrap 3.3.1 -->
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/css/bootstrap.min.css" rel="stylesheet" type="text/css" />
+  <!-- Font Awesome Icons -->
+  <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.css" rel="stylesheet" type="text/css" />
+  <link rel="stylesheet" href="{{base}}/css/prettyPhoto.css" type="text/css" media="screen" title="prettyPhoto main stylesheet" charset="utf-8" />
+  <!-- Custom CSS -->
+  <link href="{{base}}/css/hawkbit.css" rel="stylesheet">
+
+  <!--Javascript-->
+  <!-- JQuery 2.1.1-->
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
+  <!-- Bootstrap 3.3.1 JS -->
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js" type="text/javascript"></script>
+  <script src="{{base}}/js/jquery.prettyPhoto.js" type="text/javascript" charset="utf-8"></script>
+  <script type="text/javascript" charset="utf-8">
+               $(document).ready(function(){
+                 $("a[rel^='prettyPhoto']").prettyPhoto();
+               });
+             </script>
+</head>

docs/src/main/resources/_includes/homepagebottom.html

@@ -0,0 +1,54 @@
+<div class="box">
+  <h2 class="box-headline" id="header10">Community</h2>
+{% for main in site.pages %}
+{% if main.series == 'homepagebottom' %}
+<div class="{{main.style}} container-fluid wow fadeInDown">
+<div class="row">
+     <div class="col-md-1">
+            <i class="{{main.imagename}}"></i>
+          </div>
+    <div class="col-md-2">
+
+     <a href= "{{main.accesslink}}" target="_blank"><h4>{{main.title}}</h4></a>
+     </div>
+     <div class="col-md-7">
+    <section>{{ main.content }}</section>
+ </div>
+</div>
+</div>
+{% endif %}
+
+{% if main.series == 'homepageAddProjects' %}
+    <div id = "zoo" class="box">
+        <div class="row">
+
+           <div class="col-md-12 page-header pull-left">
+      <h2>Projects/Products using hawkBit</h2>
+</div>
+
+
+
+        <div class="container-fluid">
+
+        <!--table class="table table-striped table-condensed">
+            <thead>
+            <tr>
+              <th>Name</th>
+              <th>Description</th>
+              <th>License</th>
+              <th>Author(s)</th>
+            </tr></thead>
+            <tbody>
+
+             {{ main.content }}
+          </tbody><tfoot></tfoot></table-->
+          <br>
+          <p align = "center"><img src="{{ base }}/img/companies_logo.jpg" class="box-img img-responsive"></p>
+
+        </div>
+        </div>
+        <hr>
+{% endif %}
+{% endfor %}
+
+</div>

docs/src/main/resources/_includes/homepagecontributors.html

@@ -0,0 +1,18 @@
+<div class="box">
+<h2 class="box-headline" id="header10">Existing Contributors</h2>
+<hr>
+{% for main in site.pages reversed %}
+{% if main.series == 'homepagecontributors' %}
+<div class="row">
+     <div class="col-md-6">
+        <a href="{{main.url1}}" target="_blank"><img src="{{main.image1}}" /></a>
+        </div>
+    <div class="col-md-6">
+         <a href="{{main.url2}}" target="_blank"><img src="{{main.image2}}" /></a>
+        </div>
+        </div>
+ {% endif %}       
+ 
+{% endfor %}
+</div>
+

docs/src/main/resources/_includes/homepageheader.html

@@ -0,0 +1,36 @@
+<!--Header section Site navigation -->
+
+{% include base.html %}
+
+<!-- Navigation -->
+<nav class="navbar navbar-inverse navbar-fixed-top navbar-lp" role="navigation">
+<div class="navbar-brand-logo"> </div>
+		<div class="container">
+				<div class="navbar-header">
+						<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-collapse">
+								<span class="sr-only">Toggle navigation</span>
+								<span class="icon-bar"></span>
+								<span class="icon-bar"></span>
+								<span class="icon-bar"></span>
+						</button>
+						<a class="navbar-brand" href="{{base}}/index.html">Eclipse hawkBit™</a>
+				</div>
+				<div class="collapse navbar-collapse wow fadeIn" id="navbar-collapse" data-wow-delay="0.2s">
+						<ul class="nav navbar-nav pull-right">
+							{% for menu in site.data.menus %}
+								<li {% if page.path contains menu.url %} class ="active"{% endif %}>
+									{% if menu.url contains 'https://' or menu.url contains 'http://' %}
+										<a target="_blank" href="{{ menu.url }}">{{ menu.name }}</a>
+									{% else %}
+										<a href="{{base}}/{{ menu.url }}">{{ menu.name }}</a>
+
+									{% endif %}
+								</li>
+							{% endfor %}
+						</ul>
+				</div>
+				<!-- /.navbar-collapse -->
+		</div>
+		<!-- /.container -->
+		<style>#forkongithub a{background:#8d0c0c;color:#fff;text-decoration:none;font-family:Arial, Helvetica, sans-serif;text-align:center;font-weight:bold;padding:5px 40px;font-size:12px;line-height:3rem;position:relative;transition:0.5s;}#forkongithub a:hover{background:#c11;color:#fff;}#forkongithub a::before,#forkongithub a::after{content:"";width:100%;display:block;position:absolute;top:1px;left:0;height:1px;background:#fff;}#forkongithub a::after{bottom:1px;top:auto;}@media screen and (min-width:800px){#forkongithub{position:fixed;display:block;top:0;right:0;width:50px;overflow:visible;height:200px;z-index:9999;}#forkongithub a{width:260px;position:absolute;top:40px;right:-60px;transform:rotate(45deg);-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);-moz-transform:rotate(45deg);-o-transform:rotate(45deg);}}</style><span id="forkongithub"><a href="https://github.com/eclipse/hawkbit">Fork me on GitHub</a></span>
+</nav>

docs/src/main/resources/_includes/homepagemiddle.html

@@ -0,0 +1,36 @@
+<!-- Middle Content -->
+
+<div class="box">
+  
+{% for main in site.pages  %}
+<!--   {% if main.series == 'homepagemiddle' %}-->
+     <div class="container-fluid wow {{main.animatestyle}} {{main.style}}">
+      <!-- Example row of columns -->
+      <div class="row">
+        <div class="col-md-4 text-center">
+          <h2 class="ex">Devices</h2>
+          <p class="ex">Easy to connect devices to either the direct device protocol using HTTP or integrate with any protocol your device is talking and build an device to hawkBit-DMF adapter.</p>
+                 
+        </div>
+        <div class="col-md-4 text-center">
+          <h2 class="ex">User Interface</h2>
+          <p class="ex">The user interface allows to manage and monitor your software update process for either a small group of devices till monitor a large software rollout.</p>
+        
+       </div>
+        <div class="col-md-4 text-center">
+          <h2 class="ex">Cloud Ready</h2>
+          <p class="ex">hawkBit is based on the spring-boot project and allows you to adapt and deploy it to any cloud-platform</p>
+          
+              
+        </div>
+
+      </div>
+    
+    </div> 
+    <!-- /container -->
+  <!-- {% endif %}-->
+   
+ {% endfor %}
+
+ </div>
+ <hr>

docs/src/main/resources/_includes/homepagetop.html

@@ -0,0 +1,44 @@
+<!-- Top Content -->
+{% for main in site.pages %}
+  {% if main.series == 'homepagetop' %}
+  {% capture thecycle %}{% cycle 'odd', 'even' %}{% endcapture %}
+  <div class="box">
+    {% if thecycle == 'odd' %}
+          <img class="box-img img-responsive pull-right wow {{ main.animatestyle}} zoom1" src="{{ base }}/img/{{ main.imagename}}">
+
+     {% if main.videourl %}
+       <div class="{{ main.style }}">
+      <a title="{{main.videotitle}}" data-rel="prettyPhoto" href="{{main.videourl}}" rel="prettyPhoto" >
+          <i class="fa fa-play-circle fa-5 play-icon"></i>
+          </a>
+        <!--  {% if main.playvideo== 'yes' %}
+        <video width="500" height="500" controls autoplay><source src="{{base}}/video/mov_bbb.mp4" type="video/mp4"></video>
+          {% endif %} -->
+        </div>
+
+        {% endif %}
+
+    {% else %}
+      <img class="box-img img-responsive pull-left wow fadeInLeft zoom1" src="{{ base }}/img/{{ main.imagename}}">
+        {% if main.videourl %}
+        <div class="{{ main.style }}">
+          <a title="{{main.videotitle}}" data-rel="prettyPhoto" href="{{main.videourl}}" rel="prettyPhoto" >
+            <i class="fa fa-play-circle fa-5 play-icon"></i>
+          </a>
+        </div>
+      {% endif %}
+    {% endif %}
+    {% if main.fadeduration %}
+      <div class="wow {{ main.fadestyle}}" data-wow-duration="{{ main.fadeduration}}s">
+    {% else %}
+      <div class="wow {{ main.fadestyle}}">
+
+    {% endif %}
+      <h2 class="box-headline" id="header{{main.sequence}}">{{ main.title}}</h2>
+      <p>{{ main.content }}</p>
+      </div>
+  </div>
+  <hr class="box-separator">
+  {% endif %}
+
+{% endfor %}

docs/src/main/resources/_includes/submenu.html

@@ -0,0 +1,21 @@
+{% include base.html %}
+{% for menu in include.level %}
+  {% if menu.sub != null %}
+    <li>
+      {{ menu.title }}
+      <ul class="nav navmenu-nav">
+        <!-- 2nd level -->
+        {% include submenu.html level=menu.sub %}
+      </ul>
+    </li>
+  {% else %}
+    <li  >
+      {% if menu.href contains 'https://' or menu.href contains 'http://' %}
+        <a target="_blank" href="{{ menu.href }}">{{ menu.title }}</a>
+      {% else %}
+        <a href="{{base}}{{ menu.href }}">{{ menu.title }}</a>
+      {% endif %}
+
+    </li>
+  {% endif %}
+{% endfor %}