Merge remote-tracking branch 'origin/master' into complaints

.gitignore

@@ -55,6 +55,10 @@ target/
 
 # Buildout
 bin/
+src/
+
+# Local developer configuration
+.mr.developer.cfg
 
 cover/
 output.html

docs.cfg

@@ -8,7 +8,7 @@ parts=
 
 [docs]
 recipe = collective.recipe.sphinxbuilder
-eggs = openprocurement.tender.openua
+eggs = openprocurement.tender.openua [docs]
 source = ${buildout:directory}/docs/source
 build = ${buildout:directory}/docs/_build
 

docs/source/complaints.rst

@@ -5,6 +5,8 @@
    :depth: 2
    :local:
 
+.. _complaint_workflow:
+
 Complaint Workflow
 ==================
 

docs/source/index.rst

@@ -18,6 +18,9 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   overview
+   tendering
+   tutorial
    standard/index
    complaints
    reference

docs/source/overview.rst

@@ -0,0 +1,97 @@
+Overview
+========
+
+The Open Procurement Open UA procedure is plugin to `Open Procurement API
+<http://api-docs.openprocurement.org/>`_ software.  It requires 0.12 version
+of `openprocurement.api package
+<https://github.com/openprocurement/openprocurement.api>`_ to work.
+
+REST-ful interface to plugin is in line with core software design principles. 
+
+
+Conventions
+-----------
+
+This plugin conventions follow the `Open Procurement API conventions
+<http://api-docs.openprocurement.org/en/latest/overview.html#conventions>`_.
+
+Main responsibilities
+---------------------
+
+Open Procurement Open UA procedure is dedicated to Open Tender procedure for
+above Ukrainian threshold procurements.  The code for that type of procedure
+is `aboveThresholdUA`.
+
+Business logic
+--------------
+
+The approach to Open UA procedure is different from core Open Procuermnt API
+procedure (that is used for below threshold procurements) mainly in
+:ref:`stage that precedes <tendering>` auction.  Differences are in
+following aspects:
+
+1) Tender can be edited through the whole tenderPeriod (while in
+   active.tendering state), but any edit that is close to
+   tenderPeriod.endDate would require extending that period
+
+2) There is no dedicated active.enguiries state 
+
+3) Questions can be asked within enquiryPeriod that is based upon
+   tenderPeriod.
+
+4) Answers are provided during whole tenderPeriod
+
+5) Bids can be placed during whole tenderPeriod 
+
+6) Bids placed are invalidated with any tender condition editing and have to
+   be re-confirmed.
+
+
+Project status
+--------------
+
+The project is in active development and has pilot installations.
+
+The source repository for this project is on GitHub: https://github.com/openprocurement/openprocurement.tender.openua
+
+You can leave feedback by raising a new issue on the `issue tracker
+<https://github.com/openprocurement/openprocurement.tender.openua/issues>`_ (GitHub
+registration necessary).  For general discussion use `Open Procurement
+General <https://groups.google.com/group/open-procurement-general>`_
+maillist.
+
+API stability
+-------------
+API is highly unstable, and while API endpoints are expected to remain
+relatively stable the data exchange formats are expected to be changed a
+lot.  The changes in the API are communicated via `Open Procurement API
+maillist <https://groups.google.com/group/open-procurement-api>`_.
+
+Change log
+----------
+
+0.2
+~~~
+Released: unreleased
+
+ New features:
+
+ - Above Threshold :ref:`Complaint workflow <complaint_workflow>`
+
+ Modifications:
+
+0.1
+~~~
+
+Released: 2016-01-25
+
+ New features:
+
+ - no `active.enquiries` status
+ - Bid invalidation
+ - Open Tender UA validation rules
+
+Next steps
+----------
+You might find it helpful to look at the :ref:`tutorial`, or the
+:ref:`reference`.

docs/source/standard/bid.rst

@@ -24,9 +24,9 @@ Schema
 
     Possible values are:
 
-    * `registration`
-    * `validBid`
-    * `invalidBid`
+    * `active`
+    * `invalid`
+    * `deleted`
 
 :value:
     :ref:`Value`, required

docs/source/standard/tender.rst

@@ -33,6 +33,9 @@ Schema
    |ocdsDescription|
    TenderID should always be the same as the OCID. It is included to make the flattened data structure more convenient.
 
+:procurementMethodType:
+    aboveThresholdUA
+
 :procuringEntity:
    :ref:`organization`, required
 

docs/source/tendering.rst

@@ -0,0 +1,30 @@
+
+.. _tendering:
+
+Tendering
+=========
+
+Open UA procedure has `active.tendering` status can be represented with
+following diagram:
+
+.. image:: _static/active-tendering.png
+
+
+Constraints
+-----------
+
+ - `tenderPeriod` cannot be shorter then 15 days.
+
+ - `enquiryPeriod` always ends 3 days before tenderPeriod ends.
+
+ - If tender conditions are modified with less then 7 days left to
+   `tenderPeriod.endDate`, it has to be extended to meet the contraint.
+
+Claims and Complaits
+~~~~~~~~~~~~~~~~~~~~
+
+ - Claims can be submitted only if there is less then 10 or more days left
+   in tenderPeriod.
+
+ - Complaints can be submitted only if there is 4 or more days left in
+   tenderPeriod.