Writing up the Wiki for ONVM

[koolzz]

Feature Request

ONVM needs better documentation, one way to do that is constantly updating the doc/ section that we provide but so far we have not been very proactive regarding that and some parts are definitely outdated.

I propose we work on the openNetVM wiki page on github and periodically sync those changes with our docs/ folder.

I have some things started in the private repo that I will start moving to the public version soon but so far here is a list of pages I had in mind.

• General explanation of our main NF structs, this will be done after the big merges, will include things like onvm_nf, onvm_nf_context etc
• General API explanation for the NF setup/run/cleanup sequence.
• API differences for default vs normal rings
• Quick list of all the examples we provide including all NFs we currently have + mTCP, snort and others

Feel free to add any page requests that you think would be usefull or even write one yourself

[kevindweb]

Let's have someone update these sections. Packets Received NF Packets Packets Sent Please comment if you'd like to take one of these on.

[catherinemeadows]

I can work on the 'NF Packets' section