From 4ef3b28f92a3428a800c0cd1cabdab5ef0b01438 Mon Sep 17 00:00:00 2001 From: Flavio Percoco Date: Fri, 3 Oct 2014 11:44:12 +0200 Subject: [PATCH] Move the module reference to the top Instead of having to scroll down to the bottom to read the module reference, it'd be better to make it available for developers before they get into the "how contribute section". This way, we can keep zaqar and openstack sections grouped respectively. Change-Id: I8c5e39e09352ba13b3fe2bf2d04a1dac93ac6509 --- doc/source/index.rst | 48 ++++++++++++++++++++++---------------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 139c21cec..6f5cbe9fa 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -80,6 +80,30 @@ Concepts glossary +Modules reference +================= + +Zaqar is composed of two layers: + +.. toctree:: + :maxdepth: 1 + + transport + storage + +The **transport drivers** are responsible for interacting with Zaqar clients. +Every query made by clients is processed by the transport layer, +which is in charge of passing this information to the backend and then +returning the response in a format understandable by the client. + +The **storage drivers** are responsible for interacting with the storage backends +and, that way, store or retrieve the data coming from the transport layer. + +In order to keep these layers decoupled, we have established that +**checks should be performed in the appropriate layer**. In other words, +transport drivers must guarantee that the incoming data is well-formed +and storage drivers must enforce their data model stays consistent. + Setting up a development environment ==================================== @@ -125,30 +149,6 @@ API reference api/autoindex -Modules reference -================= - -Zaqar is composed of two layers: - -.. toctree:: - :maxdepth: 1 - - transport - storage - -The **transport drivers** are responsible for interacting with Zaqar clients. -Every query made by clients is processed by the transport layer, -which is in charge of passing this information to the backend and then -returning the response in a format understandable by the client. - -The **storage drivers** are responsible for interacting with the storage backends -and, that way, store or retrieve the data coming from the transport layer. - -In order to keep these layers decoupled, we have established that -**checks should be performed in the appropriate layer**. In other words, -transport drivers must guarantee that the incoming data is well-formed -and storage drivers must enforce their data model stays consistent. - Indices and tables ------------------