Changes between Version 22 and Version 23 of GeniExperiments


Ignore:
Timestamp:
01/25/13 16:45:47 (7 years ago)
Author:
hmussman@bbn.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GeniExperiments

    v22 v23  
    123123 a)  A standardized format, optimized for easy understanding, will make it is easier for the user to understand a tutorial, particularly after completing another GENI tutorial
    124124
    125  b)  Start with a static document, that indicates how user should modify for their own run
     125 b)  Start with a static document, that indicates how user can modify for their own experiment
    126126
    127127 c)  Typically provide as a web page, with an option to print it out
     
    129129 d)  Two "best-in-class" examples were found:
    130130
    131  + Web page [http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html  Getting Started with Amazon EC2 Linux Instances];  note alsooption ti print
     131 + Web page [http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html  Getting Started with Amazon EC2 Linux Instances]
     132
     133 + Note also option from Amazon for a comprehensive [http://awsdocs.s3.amazonaws.com/EC2/latest/ec2-ug.pdf  pdf document]
    132134
    133135 + Configuration manuals from Cisco, such as [http://groups.geni.net/geni/attachment/wiki/GeniExperiments/cisco%203750%20%20smart_install.pdf    Cisco Smart Install Configuration Guide]
     
    135137 e)  Include a "navigation feature", to find the individual steps;  in the Amazon case, this is done with a table, that includes links to each step.
    136138
    137  f)  Number the steps for easy reference;  follow the approach in the Amazon table:  steps 1 - 9; within a step, sub-steps 1 - 9;  optionally, within a sub-step, sub-sub-steps a - z
     139 f)  Number the steps for easy reference;  follow the approach in the Amazon table:  steps 1 - n; within a step, sub-steps 1 - n;  optionally, within a sub-step, sub-sub-steps a - z
    138140
    139141 g)  Each step should be phrased:  "do this..";  consider a controlled vocabulary, such as:  use;  do;  repeat;  stop;  load;  execute;  see;  expect
     
    141143 h)  Each step should be indented, so that the user can check off the steps on the left, when the web page is printed.
    142144
    143  i)  Additional notes can be included, with a different identation than the steps, to provide notes to the user
     145 i)  Additional notes can be included, with a different indentation than the steps, to provide notes to the user
    144146
    145147 j)  Notes to the user may include:  tips;  cautions;  FAQs;  troubleshooting info;  references
    146148
    147  j)  The configuration in a step should include a figure
    148 
    149  k)  When a selection or command entry is required, a box should be used to show the related command line, GUI entry and/or script
    150 
    151  l)  When a selection is required by the user, it shoudl be clear what they are to enter
    152 
    153  m)  Expected results should be presented, typically with a box that shows the related command line, GUI entry and/or script
     149 j)  The configuration in a step should typically include a figure
     150
     151 k)  When a selection or command entry is required, a box should be used to show the command line, GUI entry and/or script
     152
     153 l)  When a selection is required by the user, it should be clear what they are to enter
     154
     155 m)  Expected results should be presented, typically with a box that shows a command line, GUI entry, script, table or graph
    154156
    155157 n)  Formatting conventions should be used to aid understanding:
     
    163165 o)  Suggested formatting conventions are:
    164166
    165  + ?
    166 
    167  p)  Option:  utilize a production method for the web page, so that the user can copy the page as a template, include entries for this particular run, and store everything for later reference;  this reference page provides an "experiment description" for a particular experiment run
     167 + TBD
     168
     169 p)  Option:  utilize a production method for the web page, so that the user can copy the page as a template, include entries for this particular run, and store everything for later reference; 
     170
     171 + Then, this reference page provides an "experiment description" for a particular experiment run
     172
     173 + Of course, the backup option is to print the static web page, and then write on it
    168174
    169175 q)  The user's entries may include:
     
    181187== 8)  Example Tutorials (Jeanne and Harry) ==
    182188
    183  a)  GIMI tutorial at GEC15
     189 a)  [http://groups.geni.net/geni/wiki/GIMIv1.1Tutorial GIMI GEC15 tutorial]
    184190
    185191
     
    198204 
    199205 
    200 == 11)  Issues  ==
     206== 12)  Issues  ==
    201207 
    202208 a)  Can we agree on these standardized, self-contained steps?   what changes or additions?
     
    212218== References ==
    213219 
    214 [http://groups.geni.net/geni/wiki/TestTutorialExperimentWorkflow  workflow text]
    215 
    216  [http://groups.geni.net/geni/wiki/TestTutorialExperimentStoryboard related storyboard]
    217 
    218 Currently being used by GIMI and GEMINI I&M projects.
    219 
    220  See [http://groups.geni.net/geni/wiki/GIMIv1.1Tutorial GIMI GEC15 tutorial] that follows these steps.
    221 
    222 See [http://groups.geni.net/geni/wiki/GEC15Agenda/ExperimentLifecycleTools slides] from Experiment Lifecycle Tools session at GEC15.
     220
     221 + See [http://groups.geni.net/geni/wiki/GIMIv1.1Tutorial GIMI GEC15 tutorial] that follows these steps.
     222
     223 + See [http://groups.geni.net/geni/wiki/GEC15Agenda/ExperimentLifecycleTools slides] from Experiment Lifecycle Tools session at GEC15.
    223224
    224225  p4 for configuration