On Tue, Mar 19, 2013 at 03:10:23PM +0800, Can Zhang wrote: > Hello Yamahata,
Hello. > I'd like to write some documents about Ryu recently, mainly for two reasons: That's very great. One caution is that Ryu is moving target and will be re-written heavily so that documentations on internal details can become stale fast. > 1) I think Ryu is a good platform for OpenFlow, but it lacks rich documents > comparing to POX and other platforms. I have to admit it. Documentation needs to be done for Ryu to be mature. Pain for growing. > 2) As I read lots of code of Ryu recently, I want to take this chance to > confirm/correct some of my understandings. > So I want to know how to contribute to this project? Sending mail to the mail > list or push to a repository? And what format should I use? Personally I > prefer > markdown. Ryu project prefers 'git send-patch' to ryu-devel than pull request on github. The github wiki pages on github would be good place for documentation. https://github.com/osrg/ryu/wiki git://github.com/osrg/ryu.wiki.git If you want review before publishing on the wiki page, sending the patch for wiki repository to ryu-devel is good way. Wiki prefix on the subject will clarify it. And markdown format is good as github prefers it. One issue for github wiki is that it doesn't allow binary files. If you write many images, you may want to put your documentations under ryu/doc/sources of the Ryu repo instead of the wiki. thanks, -- yamahata ------------------------------------------------------------------------------ Everyone hates slow websites. So do we. Make your web apps faster with AppDynamics Download AppDynamics Lite for free today: http://p.sf.net/sfu/appdyn_d2d_mar _______________________________________________ Ryu-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/ryu-devel
