Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Writing up the Wiki for ONVM #121

Open
koolzz opened this issue May 20, 2019 · 2 comments
Open

Writing up the Wiki for ONVM #121

koolzz opened this issue May 20, 2019 · 2 comments

Comments

@koolzz
Copy link
Member

koolzz commented May 20, 2019

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
Copy link
Contributor

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
Copy link
Contributor

I can work on the 'NF Packets' section

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants