OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added some explanation for the website build. (#945) 

* Added some explanation for the website build.
* Adapted to jenkins config changes.
* Removed additional blank line.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
pull/950/head
Jerome Luckenbach 2019-04-24 18:08:58 +02:00 committed by GitHub
parent 1c10caf290
commit f0749a2987
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -60,7 +60,7 @@ So we are saving time for everyone by keeping those files at their original loca
### How the documentation build works
We have set up our [build server](https://ci.openhab.org/view/Documentation/) to do the magic automatically.
There are several triggers (mostly time based), which will then *gather the external contents* and move them to our *final* branch.
There are several triggers (mostly time based), which will then *gather the external contents* and move them to our [final](https://github.com/openhab/openhab-docs/tree/final) branch.
You can find this migrated external content in the *final* branch under:
- `_addons_*`
@ -74,6 +74,18 @@ The external content is updated by the following toolchain:
Everything that gets updated in the *master* branch will be also merged over to the *final* branch automatically.
Afterwards we will redeploy the website with the latest content from the *final* branch at regular intervals.
#### Build triggers investigated
There are two triggers available currently.
The `merge docs` job is triggerd after something has been added to the documentation through this repository.
The `gather external docs` job is started with a **succesful** build of the openhab-distribution.
A succesful disribution build will include all of the latest changes that have been made to external sources like addons.
So when a distribution build is succesful, we will trigger the gathering of all external sources.
When one of these jobs is finished, we will then notify our website hosting service, to start a new website build.
This recognized due to new commits in the final branch of this repository.
The new build will include all the latest changes in the cods repository and in all external repositories.
## Documentation Versioning
Just as openHAB is released in versions, the documentation website provides fixed versions of the documentation articles, e.g., [https://www.openhab.org/v2.2/installation/linux.html](https://www.openhab.org/v2.2/installation/linux.html)