add information on installing modules. Fixes T680
ClosedPublic

Authored by tflink on Jan 14 2016, 5:16 PM.

Details

Summary

adds information on modules, installing them and where testcloud is required

Test Plan

read docs, do they make sense?

Diff Detail

Repository
rLTRN libtaskotron
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
tflink retitled this revision from to add information on installing modules. Fixes T680.Jan 14 2016, 5:16 PM
tflink updated this object.
tflink edited the test plan for this revision. (Show Details)
tflink added reviewers: kparal, mkrizek, jskladan.
mkrizek accepted this revision.Jan 15 2016, 9:52 AM
This revision is now accepted and ready to land.Jan 15 2016, 9:52 AM
kparal accepted this revision.Jan 19 2016, 11:20 AM
kparal added inline comments.
docs/source/index.rst
78–79
``libtaskotron-core``

if you want to make it pretty :-)

109–111

This seems clearer to me:

The bits needed to enable execution with <disposable clients>. Without this module
you can only use local execution or a persistent remote machine execution.
This module depends on `testcloud <https://github.com/Rorosha/testcloud>`_ which will pull in several other
non-trivial dependencies.

The disposable clients part could be a hyperlink to a document where we give more details about them, if there's such.

tflink updated this revision to Diff 1868.Jan 20 2016, 5:59 PM
  • adding disposable client docs, linking from index
tflink updated this revision to Diff 1870.Jan 20 2016, 6:07 PM
  • adding disposable client docs, linking from index
  • forgot to add diagram images for new page

Great new docs, thanks a lot.

docs/diagrams/disposableClientExecution.svg
2–5

Shiny! For the disposable image, could the arrows be sorted top-to-bottom in the same order as the steps are executed? I.e. arrow number 1 (step number 1) top most, arrow number 4 bottom most. It would be easier to read the image.

docs/source/disposableclients.rst
25–26

I'd put Executor below Overlord and Minion, so that the description follows the usual workflow Overlord -> Minion -> Executor.

tflink updated this revision to Diff 1881.Jan 22 2016, 11:34 PM
  • adding disposable client docs, linking from index
  • forgot to add diagram images for new page
  • changes labels and order of arrows in diagrams
  • changing description order to match what disposable clients actually do
This revision was automatically updated to reflect the committed changes.