zaqar/doc/source/contributor/index.rst
liuyamin 49a397ebfb Use doc8 check
doc8 is a linter for documents and used in openstack-manuals. It is better to
enforce document linters for simple checking.

The current rules are really simple like:
- line length check (80 chars)
- new line at the end of file
- Trailing whitespace

Change-Id: I328e2b2b82739696b95eca4a4130ca347893b0dc
2017-08-10 09:07:41 +08:00

1.1 KiB

Contribution Guide

welcome project_info development.environment first_patch first_review launchpad gerrit jenkins reviewer_guide running_tests test_suite

Modules reference

Zaqar is composed of two layers:

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.