Skip to end of metadata
Go to start of metadata

Internship Projects/Mentors


Title

Improve OpenDaylight Documentation for NETCONF, BGPCEP and OpenFlow Plugin projects to use JSON examples

Status

COMPLETED

Difficulty

LOW


Description 

OpenDaylight user guide is extensively referred by users to understand how to interact with the controller. It details the APIs supported by different plugins and provides examples for the same. However, the user guides were originally written a few years ago and have most examples as XML payloads. Over the years though, JSON has turned into a format of choice for most developers, users to interact with such platforms. Hence, this project is to improve the documentation to include JSON examples for most widely used projects. The scope will be limited to the user guides for the following:

  • NETCONF
  • BGP
  • PCEP
  • Openflow

Additional Information

As examples please see the user guides here

Learning Objectives

  • Introduction to open source culture and collaboration tools
  • Documentation lifecycle of open source projects
  • Networking opportunities
  • Documentation tools like rst, tox, sphynx

Expected Outcome

  • Updated documentation rst files checked into the correseponding git repositories

Relation to LF Networking 

OpenDaylight (ODL)

Education Level

Undergraduate Level

Skill

  • Understanding of JSON, APIs
  • Usage of git, text editor like vim, web browser

Future plans

Next step would be to extend this to other areas of the documentation like the controller, clustering, etc.

Preferred Hours and Length of Internship


Part-time (20 hours a week for 24 weeks starting in summer and ending in fall)

Mentor(s) Names and Contact Info

Tejas Nevrekar, Tejas Nevrekar, tejas.nevrekar@gmail.com

Luis Gomez, Luis Gomez, ecelgp@gmail.com 

Mentee(s) Names and Contact Info

Aman ., Aman, 170030039@iitdh.ac.in

Dhiraj Sharma , Dhiraj Sharma, dhiraj.8.sharma@gmail.com

Project Results

Results by Aman

Results by Dhiraj Sharma:

Final Report