neutron

Better developer documentation for Neutron

Registered by Sean M. Collins

As a Neutron newbie, it took a long period of time to learn about Neutron's structure and how things work, and it meant reading a great deal of code. Some more developer documentation to help onboard new developers would be very helpful.

Blueprint information

Status:
Complete
Approver:
None
Priority:
Undefined
Drafter:
Sean M. Collins
Direction:
Needs approval
Assignee:
Sean M. Collins
Definition:
New
Series goal:
None
Implementation:
Implemented
Milestone target:
None
Started by
Sean M. Collins
Completed by
Sean M. Collins

Related branches

Sprints

Whiteboard

Adding more files to doc/source/devref for each layer of Neutron would be helpful. Currently, I think the following layers need good documentation -- Sean M. Collins

* Neutron L2 Agents
* Neutron RPC API
* Neutron DHCP Agent layer
* Neutron Plugin architecture
* Neutron Database layer
* Neutron API layer

Gerrit topic: https://review.openstack.org/#q,topic:bp/developer-documentation,n,z

Addressed by: https://review.openstack.org/72428
    Developer documentation

Addressed by: https://review.openstack.org/80825
    Advanced Services documentation

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.