From 41a0fce2b047dacc0e67972ca058c194caa1a51c Mon Sep 17 00:00:00 2001
From: Sander Vrijders <sander.vrijders@ugent.be>
Date: Thu, 29 Mar 2018 16:24:52 +0200
Subject: doc: Reorganize documentation

This reorganizes the documentation somewhat to be more
tutorial-styled.
---
 doc/workflow.rst | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

(limited to 'doc/workflow.rst')

diff --git a/doc/workflow.rst b/doc/workflow.rst
index 672c33c..95f68c2 100644
--- a/doc/workflow.rst
+++ b/doc/workflow.rst
@@ -2,25 +2,28 @@ Workflow
 ************************
 
 1. Define the network graph, creating instances of model.Node and
-   model.DIF classes.
+   model.DIF classes. Experiments can import rumba.model to obtain all
+   Rumba classes needed to run an experiment.
 
-2. Create an instance of a Testbed class.
+2. Create an instance of a specific model.Testbed class (QEMU, Docker,
+   Local, Emulab or jFed).
 
-3. Create an instance of the selected prototype.Experiment class,
-   passing the testbed instance and a list of Node instances.
+3. Create an instance of the selected prototype.Experiment class
+   (Ouroboros, rlite, IRATI), passing the testbed instance and a list
+   of Node instances.
 
   1. At the end of the base Experiment constructor, the
      generate function is called to generate information about
      per-node IPCPs, registrations and enrollment, ready to be
-     used by the plugins.
+     used by the prototype plugins.
 
 4. Call methods on the prototype.Experiment instance:
 
   1. swap_in() swaps the experiment in on the testbed, and fills in
      the missing information in the model.
 
-  2. install_prototype() installs the chosen prototype on the
-     testbed. Currently an Ubuntu image is assumed.
+  2. install_prototype() installs the chosen prototype on the testbed
+     (if necessary). Currently an Ubuntu image is assumed.
 
   3. bootstrap_prototype() calls a prototype-specific setup function,
      to create the required IPCPs, perform registrations,
@@ -28,7 +31,7 @@ Workflow
 
   4. swap_out() swaps the experiment out of the testbed.
 
-5. Run a Storyboard to emulate real network traffic.
+5. Optionally run a Storyboard to emulate real network traffic.
 
 
 Accessing nodes after swap-in
@@ -39,4 +42,4 @@ command (in the same terminal where ssh-agent was run in case of jFed): ::
 
     $ rumba-access $NODE_NAME
 
-Where $NODE_NAME is the name of the node to access.
\ No newline at end of file
+Where $NODE_NAME is the name of the node to access.
-- 
cgit v1.2.3