diff --git a/docs/README.md b/docs/README.md index 8373efa36..cc9a3475f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,17 +1,17 @@ # Eclipse hawkBit Documentation -The hawkBit documenation is based on the [Jekyll](http://jekyllrb.com/) -Jekyll is a ruby gem and needs ruby to execute. +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 -## 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`. It automatically monitors the filesystem and every local changes are generated on-demand on the local server [http://127.0.0.1:4000/](http://127.0.0.1:4000/). +## 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 -On a windows operating system you'll need to install Jekyll manually. If you don't have installed Jekyll on your machine you can just 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). +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 also use maven build to build and servce the documentation on a windows machine. +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/](http://127.0.0.1:4000/). \ No newline at end of file +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/). diff --git a/docs/src/main/resources/documentation/architecture/rollout-management.md b/docs/src/main/resources/documentation/architecture/rollout-management.md index f8e7a8f7b..3abbadd65 100644 --- a/docs/src/main/resources/documentation/architecture/rollout-management.md +++ b/docs/src/main/resources/documentation/architecture/rollout-management.md @@ -35,9 +35,8 @@ The cascading execution of the deployment groups is based on two thresholds that - success condition by means of percentage of successfully installed targets in the current groups triggers. - error condition by means of absolute or percentage of failed installations which triggers an emergency shutdown of the entire rollout. -[[images/DeploymentGroups.png]] - ## Rollout state machine + ### State Machine on Rollout ![](../images/rolloutstatediagram.png){:width="100%" .image-center}