diff --git a/xml/book-obs-user-guide.xml b/xml/book-obs-user-guide.xml index 6fc69093..fe79d836 100644 --- a/xml/book-obs-user-guide.xml +++ b/xml/book-obs-user-guide.xml @@ -65,7 +65,7 @@ - + @@ -108,7 +108,6 @@ - diff --git a/xml/obs_source_service.xml b/xml/obs_source_services.xml similarity index 90% rename from xml/obs_source_service.xml rename to xml/obs_source_services.xml index 64e406b1..e1f11831 100644 --- a/xml/obs_source_service.xml +++ b/xml/obs_source_services.xml @@ -3,7 +3,7 @@ %entities; ]> - @@ -11,7 +11,7 @@ - About Source Service + About Source Services Source Services are tools to validate, generate or modify sources in a trustable way. They are designed as smallest possible tools and can be @@ -23,8 +23,8 @@ - Server side generated files are easy to identify and are not - modifiable by the user. This way other user can trust them to be + Server-side generated files are easy to identify and are not + modifiable by the user. This way, other users can trust them to be generated in the documented way without modifications. @@ -40,42 +40,42 @@ - Services are runnable at any time without user commit. + Source services are runnable at any time without user commit. - Services are runnable on server and client side in the same way. + Source services are runnable on server and client side in the same way. - Services are safe. A source checkout and service run never harms + Source services are safe. A source checkout and service run never harms the system of a user. - Services avoid unnecessary commits. + Source services avoid unnecessary commits. This means there are no time-dependent changes. In case the package - already contains the same file, the newly generated file are dropped. + already contains the same file, the newly generated file is dropped. - Services running local or inside the build environment can get created, + Source services running local or inside the build environment can get created, added and used by everybody. - Services running in default or server side mode must be installed by + Source services running in default or server side mode must be installed by the administrator of the &obsa; server. - The use of a service can be defined per package or project wide. + The use of a source service can be defined per package or project wide. @@ -143,12 +143,12 @@ - Modes of Services - Each service can be used in a mode defining when it should run + Modes of Source Services + Each source service can be used in a mode defining when it should run and how to use the result. This can be done per package or globally for an entire project. - Service Modes + Source Service Modes @@ -299,9 +299,9 @@ - Defining Services for Validation + Defining Source Services for Validation - Source Services can be used to validate sources. This can be defined + Source services can be used to validate sources. This can be defined at different levels: @@ -420,20 +420,20 @@ Using it on gitlab - Go to your repository settings page in your gitlab instance. Select Integrations - there. All what you need to fill is the URL + Go to your repository settings page in your gitlab instance. Select Integrations + there. All what you need to fill is the URL https://YOUR_INSTANCE/trigger/runservice - and the Secret Token. Hit the Add webhook button and you are good. - You may specify project and package via CGI parameters in case you created a - wildcard token: + and the Secret Token. Hit the Add webhook button and you are good. + You may specify project and package via CGI parameters in case you created a + wildcard token: https://YOUR_INSTANCE/trigger/runservice?project=PROJECT&package=PACKAGE - Using it on github.com + Using Source Services on GitHub Go to your repository settings page of your repository on github.com. Select Webhooks settings and create a hook via Add Webhook button. Define the payload @@ -448,8 +448,4 @@ - - Interfaces for Using Source Services - tbd -