NetkitHow to Contribute Labs

From Netkit Wiki
Revision as of 11:07, 19 May 2011 by Admin (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Instructions for Lab Contributors

If you want to submit your own lab, proceed as follows:

  1. Download the Contributor's Pack, which provides a template to prepare lecture slides as well as a skeleton of an empty lab. Adherence to this scheme is not strictly required: the pack is intended to be a starting point and a way to enforce some standardization in the format of the labs, but actually it is only provided for your convenience.
  2. Prepare your lab according to the documentation provided with Netkit and check that it works as expected.
  3. Optionally, equip your lab with a self-testing procedure. Again, check the Netkit documentation and the example labs published in the web site for information about preparing self-tests.
  4. Pack the lab into an archive and send it to our e-mail address, which you can find in the Contacts page.

Once you have submitted the lab, we will perform some checks on it and eventually publish it in the Contributed Labs page, with a license you choose.

If the lab is found to be clearly broken, contains inappropriate or off-topic information, or is anyhow held as inadequate to the contents of this page, it will be rejected. Judgment on this point is unquestionably settled by people in The Netkit Team.

A published lab can be in either one of the following states:

  • accepted: the lab has passed preliminary tests, has been found to be functional, and has been accepted for publication; for the case of slides or other documentation, the material has been quickly checked for inconsistencies or inappropriate contents;
  • verified: the lab is equipped with a self-testing procedure, and the procedure has been found to complete successfully; for the case of slides or other documentation, the material has been reviewed and found to provide a clear and exhaustive presentation of the pertaining topic;
  • approved: the lab has passed the above checks and has been inspected for consistency with its intended behavior explained in its attached documentation (for example, a BGP lab showing the use of communities actually allows to see them propagated); for the case of slides or other documentation, the material has been deeply analyzed for errors and inconsistencies.
Personal tools