openstack/octavia
Code Issues Proposed changes

Minor restructuring of documentation tree

Browse Source 
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
This commit is contained in:
Stephen Balukoff 2015-10-04 02:51:24 -07:00
parent d7661d9923
commit cf79c701de
7 changed files with 50 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/main/api/haproxy-amphora-api.rst → doc/source/api/haproxy-amphora-api.rst
View File

@ -1,6 +1,9 @@
=====================================
Octavia Reference HAProxy Amphora API
=====================================
===========================
Octavia HAProxy Amphora API
===========================
Introduction
============
This document describes the API interface between the reference haproxy driver
and its corresponding haproxy-based amphorae.
@ -68,7 +71,6 @@ In no case should the amphora assume it ever has direct access to the Octavia
database. Also, sensitive data (like TLS certificates) should be stored in
a secure way (ex. memory filesystem).
===
API
===

4
doc/source/main/octaviaapi.rst → doc/source/api/octaviaapi.rst
View File

@ -1,5 +1,5 @@
Using Octavia's Operator API
============================
Octavia API
===========
Authentication
--------------

57
doc/source/index.rst
View File

@ -4,38 +4,39 @@
Main
====
Getting started
---------------
.. toctree::
:glob:
:maxdepth: 1
main/*
main/*/*
main/glossary.rst
======================
Project Specifications
======================
For developers
--------------
Version 0.5 specs:
.. toctree::
:maxdepth: 1
main/CONSTITUTION.rst
main/HACKING.rst
====
APIs
====
.. toctree::
:glob:
:maxdepth: 1
specs/version0.5/*
Version 1:
.. toctree::
:glob:
:maxdepth: 1
specs/version1/*
api/*
====================
Design Documentation
====================
Version 0.5:
Version 0.5
-----------
.. toctree::
:glob:
@ -43,6 +44,28 @@ Version 0.5:
design/version0.5/*
======================
Project Specifications
======================
Version 0.5
-----------
.. toctree::
:glob:
:maxdepth: 1
specs/version0.5/*
Version 1
---------
.. toctree::
:glob:
:maxdepth: 1
specs/version1/*
==================
Indices and tables
==================

1
doc/source/main/CONSTITUTION.rst Symbolic link
View File

@ -0,0 +1 @@
../../../CONSTITUTION.rst

1
doc/source/main/HACKING.rst Symbolic link
View File

@ -0,0 +1 @@
../../../HACKING.rst

0
specs/version0.5/active_passive_loadbalancer.rst → specs/version1/active_passive_loadbalancer.rst
View File

82
specs/version1/design.rst
View File

@ -1,82 +0,0 @@
..
This work is licensed under a Creative Commons Attribution 3.0 Unported
License.
http://creativecommons.org/licenses/by/3.0/legalcode
==========================================
Title of your blueprint
==========================================
Problem description
===================
Proposed change
===============
Alternatives
------------
Data model impact
-----------------
REST API impact
---------------
Security impact
---------------
Notifications impact
--------------------
Other end user impact
---------------------
Performance Impact
------------------
Other deployer impact
---------------------
Developer impact
----------------
Implementation
==============
Assignee(s)
-----------
Work Items
----------
Dependencies
============
Testing
=======
Documentation Impact
====================
References
==========