Documentation

[Cedev]

Documentation for everything

Installation documentation. With examples for config.py/neutron_lbaas.conf

• [ ] a10-neutron-lbaas, Mostly covered in README.md
• [ ] orchestration. Examples for different topologies (if there are any)
• [ ] scaling. Partially covered on internal wiki, copy that.
• [ ] Horizon. Partially covered in a10-openstack, copy that.

Multi-provider documentation

• [ ] Documentation for having multiple providers

Scheduler documentation

• [ ] API documentation for schedulers
• [ ] device-per-tenant scheduler documentation (overlaps with installation)
• [ ] scaling-group-per-vip scheduler documentation (overlaps with installation)

JSON REST API documentation with python neutron-client installation instructions and examples

• [ ] API docs for orchestration
• [x] API docs for scaling
• [ ] API docs for certificates
• [ ] API docs for vxlan

CLI documentation with installation instructions and examples

• [ ] CLI docs for orchestration
• [x] CLI docs for scaling

Horizon documentation

• [ ] Every UI

[Cedev]

Building the documentation requires sphinx, the sphinx rtd theme, and sphinx http domain.

pip install sphinx
pip install sphinx_rtd_theme
pip install sphinxcontrib-httpdomain

Eventually we'll want to

• [ ] Add documentation building requirements to an appropriate requirements.txt