Skip to content

Documentation: updated main pages (w/o models)#6

Open
wowkalucky wants to merge 14 commits into
openprocurement:masterfrom
raccoongang:documentation-pr2
Open

Documentation: updated main pages (w/o models)#6
wowkalucky wants to merge 14 commits into
openprocurement:masterfrom
raccoongang:documentation-pr2

Conversation

@wowkalucky
Copy link
Copy Markdown

@ivanka-jakimchuk @leits

this PR is cumulative - to be rebased after the previous ones are closed.

  • Documentation index updated (dgf => lease)
  • New Glossary page added;
  • Overview page updated;

@wowkalucky wowkalucky changed the title Documentation: Documentation: updated main pages (w/o models) May 29, 2018
@leits leits requested a review from ivanka-jakimchuk May 29, 2018 16:22
@leits leits added this to the v0.1 milestone May 30, 2018
Comment thread docs/source/overview.rst Outdated
========

openprocurement.auctions.dgf contains documentaion for Deposit Guarantee Fund auctions.
This ``openprocurement.auctions.lease`` package documentation contains information for Participants
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not participants but users

Comment thread docs/source/overview.rst Outdated

openprocurement.auctions.dgf contains documentaion for Deposit Guarantee Fund auctions.
This ``openprocurement.auctions.lease`` package documentation contains information for Participants
of the PROZORRO.SALE system and intended to discover all aspects of ``lease procedure``.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

intends

Comment thread docs/source/overview.rst Outdated
* enterprises, institutions and organizations.


In order to perform state property lease specialized procedure is available:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pay attention to the word order

Comment thread docs/source/overview.rst Outdated

* `State Property Fund of Ukraine`_;

* state enterprises;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

state-owned enterprises

Comment thread docs/source/overview.rst Outdated

* state enterprises;

* authorities, which are authorized by the Verkhovna Rada of the Autonomous Republic of Crimea;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. which can't be used with the authorities. Either who or that
  2. I would go with "that" to treat "the authorities" as a monolithic entity.
  3. Either Verhovna Rada of Crimea or the Supreme Council of the Autonomous Republic of Crimea (the last one is much better)

Comment thread docs/source/overview.rst Outdated

* The minimum desired participants' count by default is 2, but there is option to decrease it explicitly to 1 participant;

* Optionally an Organizer can set ``tenderPeriod.endDate`` - if so, auction can't start earlier 3 days after.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

auction can't start earlier 3 days after - too much complicated semantics/
Please make it more user-friendly

Comment thread docs/source/overview.rst Outdated

* Organizer can add and edit documents only during ``rectificationPeriod``.

* As soon as the action is edited, the status of all of the submitted bids will be switched to ``invalid``.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the procedure

Comment thread docs/source/overview.rst Outdated

* Optionally an Organizer can set ``enquiryPeriod.endDate``, if not provided - it will be calculated automatically.

* An Organizer can edit procedure only during ``rectificationPeriod`` (increase and decrease ``value.amount``, ``guarantee.amount``, ``minimalStep.amount``).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the procedure

Comment thread docs/source/overview.rst Outdated

* There is obligatory participant qualification via guarantee payment.

* The only criterion for choosing a winner is the price, provided the tenderer complies with the qualifying criteria determined by the Organizer.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bidder

Comment thread docs/source/overview.rst
API stability
-------------

API is highly unstable, and while API endpoints are expected to remain
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

API is relatively stable.

Comment thread docs/source/overview.rst Outdated
* Procedure can be switched from ``draft`` status to ``active.tendering``.

* The minimum desired participants' count by default is 2, but there is option to decrease it explicitly to 1 participant;
* During ``tenderPeriod`` participants can ask questions, submit proposals, and upload documents.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Conceptually, the period for bidders to ask questions is enquiryPeripod.

Comment thread docs/source/overview.rst Outdated
* All of the identifiers within the scheme ``CPVS`` can be chosen. ``PA01-7`` is the one to be added automatically.

* Optionally an Organizer can set ``rectificationPeriod.endDate``, if not provided - it will be calculated automatically.
* The minimum desired participants' count by default is 2, but there is option to decrease it explicitly to 1 participant;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace count with number please

Comment thread docs/source/overview.rst Outdated
* The only currency (``value.currency``) for this procedure is hryvnia (UAH).

* Organizer can add and edit documents only during ``rectificationPeriod``.
* The items within an auction are allowed to be from different CAV groups.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

within a procedure
from different CAV-PS groups

@leits leits modified the milestones: v0.1, v0.2 Jun 22, 2018
@leits leits added the docs label Jul 4, 2018
@antonkorobko antonkorobko deleted the documentation-pr2 branch November 1, 2018 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants