aboutsummaryrefslogtreecommitdiff
path: root/doc/workflow.rst
diff options
context:
space:
mode:
authorSander Vrijders <[email protected]>2018-04-05 09:42:45 +0200
committerSander Vrijders <[email protected]>2018-04-05 09:48:35 +0200
commit0b82eadc6e949f564bbb4835a2f8a0a25893e7dc (patch)
tree267217616fc216be6ee3403f75b6f2f6b1576161 /doc/workflow.rst
parentead056b9f91c3d9c6ee56adf5fd00ee5b0889db2 (diff)
downloadrumba-0b82eadc6e949f564bbb4835a2f8a0a25893e7dc.tar.gz
rumba-0b82eadc6e949f564bbb4835a2f8a0a25893e7dc.zip
doc: Update docs with feedback from Miguel
This updates the docs with some feedback from Miguel. It should help make the documentation easier to follow.
Diffstat (limited to 'doc/workflow.rst')
-rw-r--r--doc/workflow.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/workflow.rst b/doc/workflow.rst
index 95f68c2..d0e56a7 100644
--- a/doc/workflow.rst
+++ b/doc/workflow.rst
@@ -12,24 +12,24 @@ Workflow
(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 prototype plugins.
+ * 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 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.
+ * 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
- (if necessary). Currently an Ubuntu image is assumed.
+ * 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,
- enrollments, etc.
+ * bootstrap_prototype() calls a prototype-specific setup function,
+ to create the required IPCPs, perform registrations,
+ enrollments, etc.
- 4. swap_out() swaps the experiment out of the testbed.
+ * swap_out() swaps the experiment out of the testbed.
5. Optionally run a Storyboard to emulate real network traffic.