diff --git a/doc/source/main/api/haproxy-amphora-api.rst b/doc/source/api/haproxy-amphora-api.rst similarity index 99% rename from doc/source/main/api/haproxy-amphora-api.rst rename to doc/source/api/haproxy-amphora-api.rst index 0b6665be0e..ffee94e34d 100644 --- a/doc/source/main/api/haproxy-amphora-api.rst +++ b/doc/source/api/haproxy-amphora-api.rst @@ -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 === diff --git a/doc/source/main/octaviaapi.rst b/doc/source/api/octaviaapi.rst similarity index 99% rename from doc/source/main/octaviaapi.rst rename to doc/source/api/octaviaapi.rst index 1b0e190289..4731fc0ec9 100644 --- a/doc/source/main/octaviaapi.rst +++ b/doc/source/api/octaviaapi.rst @@ -1,5 +1,5 @@ -Using Octavia's Operator API -============================ +Octavia API +=========== Authentication -------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 06d3dd97a3..48ba851285 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ================== diff --git a/doc/source/main/CONSTITUTION.rst b/doc/source/main/CONSTITUTION.rst new file mode 120000 index 0000000000..dfb0d92f30 --- /dev/null +++ b/doc/source/main/CONSTITUTION.rst @@ -0,0 +1 @@ +../../../CONSTITUTION.rst \ No newline at end of file diff --git a/doc/source/main/HACKING.rst b/doc/source/main/HACKING.rst new file mode 120000 index 0000000000..7d6e3b9b8a --- /dev/null +++ b/doc/source/main/HACKING.rst @@ -0,0 +1 @@ +../../../HACKING.rst \ No newline at end of file diff --git a/specs/version0.5/active_passive_loadbalancer.rst b/specs/version1/active_passive_loadbalancer.rst similarity index 100% rename from specs/version0.5/active_passive_loadbalancer.rst rename to specs/version1/active_passive_loadbalancer.rst diff --git a/specs/version1/design.rst b/specs/version1/design.rst deleted file mode 100644 index ba77613de8..0000000000 --- a/specs/version1/design.rst +++ /dev/null @@ -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 -========== - -