summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2017-06-09 18:32:40 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2017-06-09 18:32:40 +0200
commite18f30d84a35d7b2b0fd489a6719a0c8df8ed65c (patch)
tree55767af2dff475b2c7b6e9dba56aecadb173a69e
parent51bf9170207c17f5bbe11e7aa13628eacde59383 (diff)
downloaddeployment-e18f30d84a35d7b2b0fd489a6719a0c8df8ed65c.tar.gz
deployment-e18f30d84a35d7b2b0fd489a6719a0c8df8ed65c.tar.bz2
deployment-e18f30d84a35d7b2b0fd489a6719a0c8df8ed65c.zip
instruction to run the doc worker
-rw-r--r--doc/onboarding.texi31
1 files changed, 29 insertions, 2 deletions
diff --git a/doc/onboarding.texi b/doc/onboarding.texi
index 2fe9c6d..39fe304 100644
--- a/doc/onboarding.texi
+++ b/doc/onboarding.texi
@@ -87,8 +87,35 @@ There is also a "restart" script, runnable as follows:
$ ~/buildbot/restart.sh
@end example
-@subsubsection Selenium worker
+@subsection Documentation worker
+
+This worker is responsible for building all the documentation on
+@code{https://docs.taler.net}. It is run by the user @code{docbuilder},
+whose home directory must have all the repositories with documentation
+to be built. Namely,
+
+@itemize
+@item @emph{exchange}
+@item @emph{merchant}
+@item @emph{merchant-frontend-examples}
+@item @emph{deployment} - because of "onboarding" documentation
+@item @emph{api}
+@end itemize
+
+It can be start with the following command:
+
+@example
+$ source ~/buildbot/venv/activate
+$ buildbot-worker start ~/buildbot/worker
+
+# stop it with:
+$ buildbor-worker stop ~/buildbot/worker
+# deactivate the virtual env with:
+$ deactivate
+@end example
+
+@subsubsection Selenium worker
This worker is responsible for running the Selenium wallet test:
an automatic clicker that performs the cycle withdraw-and-spend.
@@ -104,7 +131,7 @@ $ buildbot-worker start ~/buildbot/selenium_worker/
# stop it with:
$ buildbot-worker stop ~/buildbot/selenium_worker/
-# deactivate the virtual env with
+# deactivate the virtual env with:
$ deactivate
@end example