hawkBit rest docs (management & DDI API) (#688)

* hawkBit REST docs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fiy gitignore. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add to website. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Switch to generated docs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix typos. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Review findings. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Otimizations. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Revert accidental checkin. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add security link.
eclipse · May 24, 2018 · 428e3af · 428e3af
1 parent 7126d68
commit 428e3af
Show file tree

Hide file tree

Showing 244 changed files with 11,634 additions and 428 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@ tmp
 .settings
 .classpath
 target
+!hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/json/model/target
 .allure
 .vscode
 .springbeans

diff --git a/README.md b/README.md
@@ -5,7 +5,9 @@
 Eclipse [hawkBit](http://www.eclipse.org/hawkbit/index.html) is an domain independent back end solution for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.
 
 Build: [![Circle CI](https://circleci.com/gh/eclipse/hawkbit.svg?style=shield)](https://circleci.com/gh/eclipse/hawkbit)
- [![SonarQuality](https://sonar.ops.bosch-iot-rollouts.com/api/badges/gate?key=org.eclipse.hawkbit:hawkbit-parent)](https://sonar.ops.bosch-iot-rollouts.com) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent)
+ [![SonarQuality](https://sonar.ops.bosch-iot-rollouts.com/api/badges/gate?key=org.eclipse.hawkbit:hawkbit-parent)](https://sonar.ops.bosch-iot-rollouts.com) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent) 
+
+Docker images: [![Docker](https://images.microbadger.com/badges/version/hawkbit/hawkbit-update-server:0.2.0M9.svg)](https://microbadger.com/images/hawkbit/hawkbit-update-server:0.2.0M9 "Get your own version badge on microbadger.com") [![Docker MYSQL](https://images.microbadger.com/badges/version/hawkbit/hawkbit-update-server:0.2.0M9-mysql.svg)](https://microbadger.com/images/hawkbit/hawkbit-update-server:0.2.0M9-mysql "Get your own version badge on microbadger.com")
 
 # Documentation
 

diff --git a/docs/README.md b/docs/README.md
@@ -2,16 +2,22 @@
 
 The hawkBit documentation is based on [Jekyll](http://jekyllrb.com/). Jekyll is a Ruby gem and thus requires a Ruby runtime to be executed. Compiling the documentation is not included within the regular Maven build.
 
-# Build and Serve documentation
+## Build and Serve documentation
+
+### Unix / Mac
 
-## Unix / Mac
 On a unix or mac you don't need to extra install Jekyll. The Maven build is downloading the ruby runtime and the necessary ruby-gems via the Maven rubygems-proxy repository. The Ruby runtime is downloaded into the `target` folder and executed during the build.
 
 To serve the current documentation you only need to call `mvn install gem:exec@jekyll-serve` (within the `docs` folder). It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://127.0.0.1:4000/hawkbit/](http://127.0.0.1:4000/hawkbit/).
 
-## Windows
+### Windows
+
 On a Windows operating system you'll need to install Jekyll manually. If you don't have installed Jekyll on your machine you can use the [PortableJekyll](https://github.com/madhur/PortableJekyll) project. Just clone the Github repository and start the `setpath.cmd` which setups the necessary path entries into the CMD (don't forget to copy them into the environment path variable to have the path set for every command prompt).
 
 The Maven build on windows just executes the `Jekyll` process using the maven-exec plugin. This allows to use Maven to build and serve the documentation on a windows machine as well.
 
 To serve the current documentation you only need to call `mvn exec:exec@jekyll-serve`. It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://127.0.0.1:4000/hawkbit/](http://127.0.0.1:4000/hawkbit/).
+
+## Test API docs integration
+
+In order to verify the hawkbit-rest-docs integration you have to run the serve command above and when running call `mvn install`in parallel to include the generated rest docs into the serve run.
diff --git a/docs/pom.xml b/docs/pom.xml
@@ -86,6 +86,32 @@
                      <jrubyVerbose>false</jrubyVerbose>
                   </configuration>
                </plugin>
+               <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-dependency-plugin</artifactId>
+                    <executions>
+                    <execution>
+                        <id>unpack-api-docs</id>
+                        <phase>generate-resources</phase>
+                        <goals>
+                            <goal>unpack</goal>
+                        </goals>
+                        <configuration>
+                            <artifactItems>
+                                <artifactItem>
+                                <groupId>org.eclipse.hawkbit</groupId>
+                                <artifactId>hawkbit-rest-docs</artifactId>
+                                <version>${project.version}</version>
+                                <type>jar</type>
+                                <overWrite>true</overWrite>
+                                <outputDirectory>${basedir}/target/classes/documentation/</outputDirectory>
+                                <includes>**</includes>
+                                </artifactItem>
+                            </artifactItems>
+                        </configuration>
+                    </execution>
+                 </executions>
+                </plugin>
             </plugins>
          </build>
 

diff --git a/docs/src/main/resources/_includes/footer.html b/docs/src/main/resources/_includes/footer.html
@@ -1,25 +1,26 @@
 <!-- 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>
+    <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 Resources</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>
+                    <li><a href="http://www.eclipse.org/security/">Reporting a Security Vulnerability</a></li>
+                </ul>
+            </div>
+            <div class="col-md-2">
+
+            </div>
 </footer>
 
-<!--/.Footer-->
+<!--/.Footer-->