Merge pull request #1 from yevheniimoroziuk/master

Docs: Add SGC documentation

README.md

@@ -1,25 +1,15 @@
-![alt text](https://img.shields.io/hexpm/l/plug.svg "License Apache Version 2.0")
-[![Documentation Status](https://readthedocs.org/projects/mepps-mdtor/badge/?version=latest)](http://tor.mepps.openprocurement.io/en/latest/?badge=latest)
+![alt text](https://github.com/prozorro-sale/tor.ea/blob/master/LICENSE.txt "License Apache Version 2.0")
+[![Documentation Status](https://readthedocs.org/projects/torea/badge/?version=latest)](https://propertylease.readthedocs.io/uk_UA/latest/)
 
-Terms of Reference
+# Introduction
 
-Philosophy
-==========
-Three founding blocks of the <> include:
+`tor.ea` repository contains documentation for propertyLease procedure.
 
-1. Hybrid electronic system based on an open-source model. 
-2. "Everyone eyes everything" principle.
-3. Golden triangle of partnership - a unique form of collaboration between business, state and
-civil society where functions are split between different stakeholders to ensure independence
-and mutual control.
+## Documentation
 
+Documentation can be found here 
 
-Documentation
-=============
-
-
-Building documentation
-----------------------
+### Building documentation
 
 Use the following commands to build documentation from `docs/source` into `docs/html`:
 

SGC/source/AuctionEnd.rst

@@ -0,0 +1,10 @@
+.. _AuctionEnd:
+
+Завершення аукціону
+===================
+
+Якщо упродовж 3 хвилин не зроблено жодної ставки, аукціон завершується та переходить до етапу Оголошення результатів.
+
+Також аукціон завершується у разі настрання 17:00.
+
+В момент коли завершується останній раунд аукціону лунає гонг, та висвітлюється повідомлення "Лунає гонг". Після чого аукціон завершується та переходить до наступного етапу.

SGC/source/AuctionModuleOption5.rst

@@ -0,0 +1,6 @@
+.. _AuctionModuleOption5:
+
+Модуль аукціонів
+================
+
+У даній документації міститься інформація щодо модуля аукціонів для процедури landLease.

SGC/source/auctionStart.rst

@@ -0,0 +1,11 @@
+.. _AuctionStart:
+
+Початок аукціону
+================
+
+Після закінчення періоду подачі пропозицій на сторінці модулю аукціонів з'являється:
+  * auctionID
+  * description
+  * value.amount
+
+На сторінці модуля аукціонів зверху відображається таймер, що повідомляє про кількість хвилин до початку торгів. Сам аукціон розпосинається в проміжку між 10:00 та 10:30. Конкретний час початку аукціону визначається при публікації процедури. В момент початку процедури на сторінці модуля аукціону висвітлюється повідомлення "Лунає гонг", що супроводжується звуковим сигналом. Після чого розпочинається аукціон.

SGC/source/authorization.rst

@@ -0,0 +1,11 @@
+.. _authorization:
+
+Авторизація учасника
+====================
+
+Єдиною відмінністю від існуючих процесів є поява у дисклеймері фрази накшталт:
+
+       `Погоджуючись з умовами проведення аукціону ви приймаєте та погоджуєтесь зі 
+       стартовою ціною об’єкту, що продається`
+
+Ця ж фраза міститиметься у дисклеймері для решти існуючих типів аукціону.Решта процесу залишається незмінною.

SGC/source/bids.rst

@@ -0,0 +1,31 @@
+.. _bids:
+
+Подача пропозиції учасником
+===========================
+
+Після того, як учасника було авторизовано, він потрапляє на сторінку модуля аукціону, де знизу з’являються кнопки, які відповідають за виконання дій: підвищення поточної ціни та погодження з поточною ціною.
+
+Натискання на відповідну кнопку призводить до різної поведінки модуля аукціонів.
+
+В аукціоні присутнє обмеження на передану кількість запитів від користувача - 1 запит/секунду.
+
+Варіації натискання кнопок
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Учасник натичнув кнопку `підвищити`
+-----------------------------------
+
+Якщо учасник натисне кнопку підвищити, на сторінці модулю аукціонів з'явиться блок з можливими варіантами ставок. Кожен пропонований варіант зі списку більший за суму `ціна потчного раунду + minimalStep.amount`, та кратний `minimalStep.amount`.
+
+З введенням суми, система приймає передане значення, після чого поточний раунд завершується. Завершення раунду зупиняє таймер.
+
+Ціна наступного раунду більша за ставку учасника на `minimalStep.amount`.
+
+Учасник натиснув кнопку `погодитися`
+------------------------------------
+
+Для того, аби аукціон перейшов до наступного раунду, необхідно й достатньо аби 1 учасник натиснув на кнопку “погодитись”. З виконанням цих дій, поточний раунд завершується.
+
+Завершення раунду зупиняє таймер зверху.
+
+Ціна наступного раунду калькулюється автоматично та є рівною `ціні попереднього раунду + minimalStep.amount`.

SGC/source/duration.rst

@@ -0,0 +1,18 @@
+.. _duration:
+
+Тривалість раунду
+=================
+
+Після того, як лунає гонг розпочинається перший раунд аукціону. Ціна на першому раунді рівна сумі (`value.amount + minimalStep.amount`).
+
+Зверху сторінки відображається таймер, що повіцдомляє про час до завершення поточного раунду.
+
+Максимальна тривалість кожного з раундів рівна трьом хвилинам. При цьому тривалість кожного з раундів є невизначеною та залежить від дій учасників, що описані в умовах.
+
+По завершенню раунду наступає 15-ти секундна пауза, після якої починається наступний раунд.
+
+Наступні дії системи є аналогічними до описаних вище.
+
+.. important:: 
+
+   Тривалість раунду, що припадає на час ~17:00 різниться від стандартної та може тривати менше 3 хвилин (ситуація, коли раунд “обривається” не дочекавшись виконання умов або сходження 3-ох хвилин).

SGC/source/index.rst

@@ -6,3 +6,12 @@
 
 .. toctree::
    :maxdepth: 2
+
+   AuctionModuleOption5
+   auctionStart
+   duration
+   authorization
+   bids
+   results
+   AuctionEnd
+   scenario

SGC/source/results.rst

@@ -0,0 +1,6 @@
+.. _Results:
+
+Оголошення результатів
+======================
+
+Під час оголошення результатів відбувається відкриття імен учасників (зі збереженням порядкового номеру учасника), що подавали пропозиції упродовж аукціону, та визначення переможця торгів. 

SGC/source/scenario.rst

@@ -0,0 +1,64 @@
+.. _scenario:
+
+Сценарії можливого розвитку подій
+=================================
+
+Scenario I: "Increase" has been pushed within the 1st stage
+
++---------+-----------+----------+----------+
+|         | Biddrer X | Bidder Y |  Winner  |
++=========+===========+==========+==========+
+|Stage I  | Increase  |     -    |     X    |
++---------+-----------+----------+          |
+|Stage II |     -     |     -    |          |
++---------+-----------+----------+----------+
+
++---------+-----------+----------+----------+
+|         | Biddrer X | Bidder Y |  Winner  |
++=========+===========+==========+==========+
+|Stage I  | Increase  |     -    |          |
++---------+-----------+----------+          |
+|Stage II |     -     |   Agree  |     Y    |
++---------+-----------+----------+          |
+|Stage III|     -     |     -    |          |
++---------+-----------+----------+----------+
+
++---------+-----------+----------+----------+
+|         | Biddrer X | Bidder Y |  Winner  |
++=========+===========+==========+==========+
+|Stage I  | Increase  |    -     |          |
++---------+-----------+----------+          |
+|Stage II |   Agree   |    -     |     X    |
++---------+-----------+----------+          |
+|Stage III|     -     |    -     |          |
++---------+-----------+----------+----------+
+
+Scenario II: "Agree" has been pushed within the 1st stage
+
++---------+-----------+----------+----------+
+|         | Biddrer X | Bidder Y |  Winner  |
++=========+===========+==========+==========+
+|Stage I  | Agree     |     -    |     X    |
++---------+-----------+----------+          |
+|Stage II |     -     |     -    |          |
++---------+-----------+----------+----------+
+
++---------+-----------+----------+----------+
+|         | Biddrer X | Bidder Y |  Winner  |
++=========+===========+==========+==========+
+|Stage I  |     -     |   Agree  |          |
++---------+-----------+----------+          |
+|Stage II |   Agree   |     -    |     X    |
++---------+-----------+----------+          |
+|Stage III|     -     |     -    |          |
++---------+-----------+----------+----------+
+
++---------+-----------+----------+----------+
+|         | Biddrer X | Bidder Y |  Winner  |
++=========+===========+==========+==========+
+|Stage I  |   Agree   |    -     |          |
++---------+-----------+----------+          |
+|Stage II |   Agree   |    -     |     X    |
++---------+-----------+----------+          |
+|Stage III|     -     |    -     |          |
++---------+-----------+----------+----------+

propertyLease/source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# mepps-md.tor documentation build configuration file, created by
+# propertyLease.tor documentation build configuration file, created by
 # sphinx-quickstart on Fri Dec  30 01:00:13 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -48,7 +48,7 @@
 
 # General information about the project.
 project = u'propertyLease'
-copyright = u'2016-2017, Quintagroup, Ltd'
+copyright = u'2018, Quintagroup, Ltd'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -181,7 +181,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'meppsmdtor'
+htmlhelp_basename = 'propertyLease'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -201,7 +201,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'meppsmdtor.tex', u'mepps-md TOR',
+  ('index', 'propertyLease.tex', u'propertyLease TOR',
    u'Myroslav Opyr', 'manual'),
 ]
 
@@ -231,7 +231,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'meppsmdtor', u'mepps-md TOR',
+    ('index', 'propertyLease', u'propertyLease TOR',
      [u'Myroslav Opyr'], 1)
 ]
 
@@ -245,8 +245,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'meppsmdtor', u'mepps-md TOR',
-   u'Myroslav Opyr', 'meppsmdtor', 'Terms of reference',
+  ('index', 'propertyLease', u'propertyLease TOR',
+   u'Myroslav Opyr', 'propertyLease', 'Terms of reference',
    'Miscellaneous'),
 ]