openstack/octavia
Code Issues Proposed changes
598f8540ea
octavia/doc/source/index.rst

82 lines
910 B
ReStructuredText
Raw Normal View History

Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
.. octavia-specs documentation master file
Adding initial glossary of terms Along with defining terms, this commit cleans up some of the documentation structure so the auto-generated docs are a bit cleaner. Change-Id: I6445f86a6746956d8227d2a587509fe08b27d26d
2014-09-17 21:08:20 -07:00
====
Main
====
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
Getting started
---------------
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
.. toctree::
:maxdepth: 1
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
main/glossary.rst
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
Adds documentation for the Octavia configuration This patch moves the Octavia configuration option documentation into the Octavia repository. The OpenStack docs team deleted this documentation from the Mitaka release[1]. The Octavia team finds value in this documentation so we are moving it into our repository. [1] https://review.openstack.org/#/c/259889/ Change-Id: I4fcc2a7dc8fa3ef343456d98202ea7d4f9cd1289
2016-03-18 00:21:01 +00:00
Configuration reference
-----------------------
.. toctree::
:maxdepth: 1
config-reference/octavia-config-table.rst
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
For developers
--------------
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
.. toctree::
:maxdepth: 1
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
main/CONSTITUTION.rst
main/HACKING.rst
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
====
APIs
====
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
.. toctree::
:glob:
:maxdepth: 1
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
api/*
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
Adding initial glossary of terms Along with defining terms, this commit cleans up some of the documentation structure so the auto-generated docs are a bit cleaner. Change-Id: I6445f86a6746956d8227d2a587509fe08b27d26d
2014-09-17 21:08:20 -07:00
====================
Design Documentation
====================
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
Version 0.5
-----------
Octavia v0.5 component design This design represents the overall layout of components that will make up the first major milestone release of Octavia (v0.5). The intent here is to have a scalable service delivery layer, to get communication with external components right, and not yet worry about making the command and control layer scalable. Change-Id: I09ab7185683b66ec2567119616bc54cf9d8cc000
2014-08-12 00:41:43 -07:00
.. toctree::
:glob:
:maxdepth: 1
design/version0.5/*
Minor restructuring of documentation tree This restructuring should hopefully make better sense of the documentation currently available. This is in preparation for bringing the version 0.5 component documentation up to date and adding a getting started and installation guide. Change-Id: Ie1e27bab4d2b8d7d033f75750fda842dd9dd3de7
2015-10-04 02:51:24 -07:00
======================
Project Specifications
======================
Version 0.5
-----------
.. toctree::
:glob:
:maxdepth: 1
specs/version0.5/*
Version 1
---------
.. toctree::
:glob:
:maxdepth: 1
specs/version1/*
Populate repository with common initial files Every repo needs a first commit, eh? Most of this is based on the neutron and neutron-specs project layouts. Change-Id: I17a41fc30f8f8499c679afad14019c0755582bc6
2014-06-25 02:58:49 -07:00
==================
Indices and tables
==================
* :ref:`search`
Copy Permalink