Matt Riedemann 9fefad779b Add search capability to the docs

This follows the nova docs and adds an in-tree neutron-specific
docs search and an openstack-wide search.

The former is necessary for finding things that aren't obviously
linked from top level indexes, like documentation about the
metadata service proxy (which is what I was originally trying
to find without the help of a search box).

Change-Id: I86dde1936d0c7d445f8a6db182f5f41dfb179752

2018-03-08 11:13:05 -05:00

2.4 KiB

Raw Blame History

Welcome to Neutron's documentation!

Neutron is an OpenStack project to provide "network connectivity as a service" between interface devices (e.g., vNICs) managed by other OpenStack services (e.g., nova). It implements the Neutron API.

This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Neutron and other components of OpenStack can be found on the OpenStack wiki and the Neutron section of the wiki. The Neutron Development wiki is also a good resource for new contributors.

Enjoy!

Installation Guide

Installation Guide <install/index>

Networking Guide

admin/index

Configuration Reference

configuration/index

CLI Reference

cli/index

Neutron Feature Classification

feature_classification/index

Contributor Guide

contributor/index

API Extensions

Go to https://developer.openstack.org/api-ref/network/ for information about the OpenStack Network API and its extensions.

Search

Neutron document search <search>: Search the contents of this document.
OpenStack wide search: Search the wider set of OpenStack documentation, including forums.

2.4 KiB Raw Blame History