From 06f2e37758c73bee9b53fcac198d16a828c2ffc0 Mon Sep 17 00:00:00 2001
From: Marcello Stanisci <stanisci.m@gmail.com>
Date: Sat, 4 Nov 2017 10:03:58 +0100
Subject: pylint builder in doc and shortening the doc.

---
 doc/onboarding.texi | 110 ++++++++++++++++++----------------------------------
 1 file changed, 38 insertions(+), 72 deletions(-)

diff --git a/doc/onboarding.texi b/doc/onboarding.texi
index b58202c..4c31304 100644
--- a/doc/onboarding.texi
+++ b/doc/onboarding.texi
@@ -96,14 +96,45 @@ There is also a "restart" script, runnable as follows:
 $ ~/buildbot/restart.sh
 @end example
 
-NOTE: the following command reloads the configuration without
-restarting the bot.
+NOTE: the following command reloads the configuration without the
+need to restart the bot.
 
 @example
 $ source ~/buildbot/venv/bin/activate
 $ buildbot reconfig ~/buildbot/master/
 @end example
 
+@subsection Start/stop workers
+
+@cartouche
+@quotation
+Every worker is run by a dedicated user in the system, and runs in
+"virtualenv".  The latter is installed within
+@code{<worker_home_dir>/buildbot/venv}. The worker setup lies into
+@code{<worker_home_dir>/buildbot/<worker_setup>}, where @code{<worker_setup>}
+has an "obvious" name, like @code{worker}, @code{slave}, @code{<worker_username>},
+@code{<builder_name>} or any combination of these.
+
+The following commands show how to start and stop a worker.
+
+@example
+# log in as the worker user.
+# cwd is $HOME.
+
+# this activated the virtualenv.
+$ source buildbot/venv/bin/activate
+
+# this starts the worker.
+$ buildbot-worker start buildbot/<worker_setup>
+
+# this stops the worker.
+$ buildbot-worker stop buildbot/<worker_setup>
+
+@end example
+
+@end quotation
+@end cartouche
+
 @subsection Debug worker
 
 This worker is used to test the Buildbot and it is run by the
@@ -113,6 +144,10 @@ which is the repository where debug pushes have to be done.
 Note that this worker might not be activated all the time, as it
 is not needed by any production codebase.
 
+@subsection Python linter
+This worker is responsible for running Python static analysis, and it
+is served by the user @code{pylinter}.
+
 @subsection Documentation worker
 
 This worker is responsible for building all the documentation on
@@ -128,20 +163,6 @@ to be built.  Namely,
 @item @emph{api}
 @end itemize
 
-It can be start with the following command:
-
-@example
-# First log-in as the 'docbuilder' user.
-$ 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
-
 @cartouche
 @quotation Note
 use the @code{--umask=022} option when creating this worker,
@@ -152,19 +173,7 @@ and this makes generated files unreadable.
 
 @subsection Wallet worker
 This worker is responsible for running wallet testcases.  It is run
-by the @emph{containers} user.  Manage this worker with the following
-commands:
-
-@example
-$ source ~/buildbot/venv/bin/activate
-$ buildbot-worker start ~/buildbot/wallet_worker/
-
-# stop it with:
-$ buildbot-worker stop ~/buildbot/wallet_worker/
-
-# deactivate the virtual env with:
-$ deactivate
-@end example
+by the @emph{containers} user.
 
 @subsection Selenium worker
 This worker is responsible for running the Selenium wallet test:
@@ -173,35 +182,12 @@ an automatic clicker that performs the cycle withdraw-and-spend.
 The @emph{containers} user is also responsible for running the Selenium
 buildbot worker.
 
-Start it with:
-
-@example
-$ source ~/buildbot/venv/bin/activate
-$ buildbot-worker start ~/buildbot/selenium_worker/
-
-# stop it with:
-$ buildbot-worker stop ~/buildbot/selenium_worker/
-
-# deactivate the virtual env with:
-$ deactivate
-@end example
-
 @subsection Lcov worker
 
 The worker is implemented by the @emph{lcovslave} user and is responsible
 for generating the HTML showing the coverage of our tests, then available
 on @emph{https://lcov.taler.net}.
 
-To start the worker, log in as @emph{lcovslave} and run:
-
-@example
-$ source ~/activate
-$ taler-deployment-bbstart
-
-# To stop it:
-$ taler-deployment-bbstop
-@end example
-
 @b{NOTE:} a Postgres "per-user" database service should always
 be running, as @emph{lcovslave} is deployed in a standalone environment.
 
@@ -238,19 +224,6 @@ has some additional "sudo" rights, since it has to act as @emph{test-blue},
 Note that the "sudo file" is tracked in this (@emph{deployment}) repository,
 under the @emph{sudoers} directory.
 
-To start the worker, log in as @emph{testswitcher} and run:
-
-@example
-$ source ~/venv/bin/activate
-$ buildbot-worker start ~/buildbot/slave
-
-# To stop it:
-$ buildbot-worker stop ~/buildbot/slave
-
-# To exit the virtual env
-$ deactivate
-@end example
-
 @subsection Manual switch
 
 After the desired blue/green party has been compiled, it is possible to
@@ -271,13 +244,6 @@ The pointed locations are updated by the @emph{lcovslave}.
 
 @subsection Hooks
 
-@cartouche
-@quotation Note
-Hooks at taler.net are still work in progress, so this section should
-be considered a recipe, rather than a fact.
-@end quotation
-@end cartouche
-
 Whenever a push occurs into one of Taler repositories, Buildbot gets
 notified via the Git @emph{hooks} system.
 
-- 
cgit v1.2.3