Skip to content

Commit

Permalink
Docs: updated contract and tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
sorenabell committed Jun 1, 2016
1 parent 5d33dde commit b55564b
Show file tree
Hide file tree
Showing 8 changed files with 90 additions and 63 deletions.
Binary file modified docs/source/locale/uk/LC_MESSAGES/overview.mo
Binary file not shown.
Binary file modified docs/source/locale/uk/LC_MESSAGES/standard/contract.mo
Binary file not shown.
28 changes: 18 additions & 10 deletions docs/source/locale/uk/LC_MESSAGES/standard/contract.po
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ msgstr ""
"Project-Id-Version: openprocurement.contracting.api 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-04-25 17:09+0300\n"
"PO-Revision-Date: 2016-05-23 11:20+0300\n"
"PO-Revision-Date: 2016-06-01 11:20+0300\n"
"Last-Translator: Zoriana Zaiats <sorenabell@quintagroup.com>\n"
"Language-Team: Ukrainian <support@quintagroup.com>\n"
"MIME-Version: 1.0\n"
Expand Down Expand Up @@ -145,7 +145,7 @@ msgstr ""
"|ocdsDescription| Усі документи та додатки пов’язані з договором, включно з "
"будь-якими повідомленнями."

#: ../../source/standard/contract.rst:111
#: ../../source/standard/contract.rst:114
msgid "Workflow"
msgstr "Схема роботи"

Expand All @@ -161,31 +161,39 @@ msgstr ""
"|ocdsDescription| Об’єкт, що управляє закупівлею. Він не обов’язково є "
"покупцем, який платить / використовує закуплені елементи."

#: ../../source/standard/contract.rst:121
#: ../../source/standard/contract.rst:124
msgid "\\* marks initial state"
msgstr "\\* позначає початковий стан"

#: ../../source/standard/contract.rst:97
msgid "List of :ref:`Change` objects."
msgstr "Список пов’язаних об’єктів :ref:`Change`"

#: ../../source/standard/contract.rst:100
msgid ":ref:`Value` object."
msgstr "об’єкт :ref:`Value`."

#: ../../source/standard/contract.rst:102
#: ../../source/standard/contract.rst:105
msgid "Amount of money actually paid."
msgstr "Дійсно оплачена сума."

#: ../../source/standard/contract.rst:105
#: ../../source/standard/contract.rst:108
msgid "string, required for unsuccessful contract"
msgstr "рядок, обов’язковий для неуспішних договорів"

#: ../../source/standard/contract.rst:107
#: ../../source/standard/contract.rst:110
msgid ""
"Reasons for contract termination. Presence of this field indicates that "
"contract is unsuccessful."
msgstr ""
"Причина припинення договору. Наявність цього поля вказує, що договір є "
"неуспішним."

#: ../../source/standard/contract.rst:101
msgid "float, required"
msgstr "число з рухомою комою, обов’язкове"

#: ../../source/standard/contract.rst:102
msgid "string, required, auto-generated"
msgstr "рядок, обов’язковий, генерується автоматично"

#: ../../source/standard/contract.rst:103
msgid "bool, required , auto-generated"
msgstr "логічний (булевий) тип даних, обов’язковий, генерується автоматично"

Binary file modified docs/source/locale/uk/LC_MESSAGES/standard/util.mo
Binary file not shown.
Binary file modified docs/source/locale/uk/LC_MESSAGES/tutorial.mo
Binary file not shown.
112 changes: 67 additions & 45 deletions docs/source/locale/uk/LC_MESSAGES/tutorial.po
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ msgstr ""
"Project-Id-Version: openprocurement.contracting.api 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-04-25 17:22+0300\n"
"PO-Revision-Date: 2016-05-27 10:15+0300\n"
"PO-Revision-Date: 2016-06-01 11:01+0300\n"
"Last-Translator: Zoriana Zaiats <sorenabell@quintagroup.com>\n"
"Language-Team: Ukrainian <support@quintagroup.com>\n"
"MIME-Version: 1.0\n"
Expand Down Expand Up @@ -56,11 +56,11 @@ msgstr ""
"повної URL-адреси, якщо додати `http://api-"
"sandbox.openprocurement.org/api/0/contracts/`) та його dateModified дату."

#: ../../source/tutorial.rst:100
#: ../../source/tutorial.rst:164
msgid "Uploading documentation"
msgstr "Завантаження документації"

#: ../../source/tutorial.rst:108
#: ../../source/tutorial.rst:172
msgid ""
"`201 Created` response code and `Location` header confirm document creation."
" We can additionally query the `documents` collection API endpoint to "
Expand All @@ -70,19 +70,19 @@ msgstr ""
"документ було створено. Додатково можна зробити запит точки входу API "
"колекції документів, щоб підтвердити дію:"

#: ../../source/tutorial.rst:115
#: ../../source/tutorial.rst:179
msgid "And again we can confirm that there are two documents uploaded."
msgstr "І знову можна перевірити, що є два завантажених документа."

#: ../../source/tutorial.rst:120
#: ../../source/tutorial.rst:184
msgid ""
"In case we made an error, we can reupload the document over the older "
"version:"
msgstr ""
"Якщо сталась помилка, ми можемо ще раз завантажити документ поверх старої "
"версії:"

#: ../../source/tutorial.rst:125
#: ../../source/tutorial.rst:189
msgid "And we can see that it is overriding the original version:"
msgstr "І ми бачимо, що вона перекриває оригінальну версію:"

Expand Down Expand Up @@ -111,13 +111,7 @@ msgstr ""
msgid "Modifying contract"
msgstr "Редагування договору"

#: ../../source/tutorial.rst:72
msgid ""
"Let's update contract by supplementing it with all other essential "
"properties."
msgstr "Оновимо договір шляхом надання йому усіх інших важливих властивостей."

#: ../../source/tutorial.rst:77
#: ../../source/tutorial.rst:123
msgid ""
"We see the added properties have merged with existing contract data. "
"Additionally, the `dateModified` property was updated to reflect the last "
Expand All @@ -127,7 +121,7 @@ msgstr ""
"Додатково оновлена властивість `dateModified`, щоб відображати останню дату "
"модифікації."

#: ../../source/tutorial.rst:102
#: ../../source/tutorial.rst:166
msgid ""
"Procuring entity can upload PDF files into the created contract. Uploading "
"should follow the :ref:`upload` rules."
Expand Down Expand Up @@ -181,97 +175,93 @@ msgstr ""
"``tender_token`` - це токен закупівлі (використовується для генерування "
"токена договору)."

#: ../../source/tutorial.rst:203
#: ../../source/tutorial.rst:213
msgid "Any future modification to the contract are not allowed."
msgstr "Після цього додання змін до договору не дозволяється."

#: ../../source/tutorial.rst:191
#: ../../source/tutorial.rst:200
msgid "Completing contract"
msgstr "Завершення договору"

#: ../../source/tutorial.rst:81
#: ../../source/tutorial.rst:127
msgid "See examples of `items` customization below. You can:"
msgstr "Дивіться приклади зміни елемента (`items`) нижче. Ви можете:"

#: ../../source/tutorial.rst:83
#: ../../source/tutorial.rst:129
msgid "add item:"
msgstr "додати елемент (`items`):"

#: ../../source/tutorial.rst:88
#: ../../source/tutorial.rst:134
msgid "update item:"
msgstr "оновити елемент (`items`):"

#: ../../source/tutorial.rst:93
#: ../../source/tutorial.rst:139
msgid "delete item:"
msgstr "видалити елемент (`items`):"

#: ../../source/tutorial.rst:135
msgid "Submitting contract change"
msgstr "Подання змін до договору"

#: ../../source/tutorial.rst:137
#: ../../source/tutorial.rst:72
msgid ""
"You can make changes to the contract in cases described in the 4th part of "
"Article 36 of the Law \"On the Public Procurement\"."
msgstr ""
"Внесення змін до істотних умов договору можливі у випадках, описаних "
"частиною четвертою статті 36 Закону України “Про публічні закупівлі”."

#: ../../source/tutorial.rst:141
#: ../../source/tutorial.rst:76
msgid "All `changes` are processed by the endpoint `/contracts/{id}/changes`."
msgstr ""
"Всі зміни `change` обробляються точкою входу (endpoint) "
"`/contracts/{id}/changes`."

#: ../../source/tutorial.rst:143
#: ../../source/tutorial.rst:81
msgid "Let's add new `change` to the contract:"
msgstr "Додамо нову зміну `change` до договору:"

#: ../../source/tutorial.rst:150
#: ../../source/tutorial.rst:88
msgid "You can view the `change`:"
msgstr "Ви можете переглянути зміну `change`:"

#: ../../source/tutorial.rst:155
#: ../../source/tutorial.rst:93
msgid "`Change` can be modified while it is in the ``pending`` status:"
msgstr "Зміну `change` можна модифікувати доки вона має статус ``pending``."

#: ../../source/tutorial.rst:160
#: ../../source/tutorial.rst:101
msgid "Document can be added only while `change` is in the ``pending`` status."
msgstr "Документ можна додати доки зміна `change` має статус ``pending``."

#: ../../source/tutorial.rst:162
#: ../../source/tutorial.rst:103
msgid "Document has to be added in two stages:"
msgstr "Документ додається в два етапи:"

#: ../../source/tutorial.rst:164
#: ../../source/tutorial.rst:105
msgid "you should upload document"
msgstr "ви повинні завантажити документ"

#: ../../source/tutorial.rst:174
#: ../../source/tutorial.rst:147
msgid ""
"`Change` has to be applied by switching to the ``active`` status. After this"
" `change` can't be modified anymore."
msgstr ""
"Зміна `change` буде застосована при переключенні в статус ``active``. ПІсля "
"цього модифікувати зміну `change` вже не можна."

#: ../../source/tutorial.rst:179
#: ../../source/tutorial.rst:152
msgid "You can view all changes:"
msgstr "Ви можете переглянути всі зміни:"

#: ../../source/tutorial.rst:184
#: ../../source/tutorial.rst:157
msgid "All changes are also listed on the contract view."
msgstr "Всі зміни присутні при перегляді контракту."

#: ../../source/tutorial.rst:139
#: ../../source/tutorial.rst:74
msgid ""
"**Essential contract terms** can be modified by the submission of a new "
":ref:`change` object to the `Contract.changes` container."
msgstr ""
"**Істотні умови договору** можуть бути змінені поданням нового об’єкта "
":ref:`change` в котейнер `Contract.changes`."

#: ../../source/tutorial.rst:169
#: ../../source/tutorial.rst:110
msgid ""
"you should set document properties ``\"documentOf\": \"change\"`` and "
"``\"relatedItem\": \"{change.id}\"`` in order to bind the uploaded document "
Expand All @@ -285,7 +275,7 @@ msgstr ""
msgid "Let's view contracts."
msgstr "Переглянемо договори."

#: ../../source/tutorial.rst:193
#: ../../source/tutorial.rst:202
msgid ""
"Before contract can be completed ``amountPaid`` field value should be set "
"(regardless whether the contract was successful or unsuccessful). Contract "
Expand All @@ -297,26 +287,58 @@ msgstr ""
"завершити переключенням у статус ``terminated``. Виконаємо ці дії єдиним "
"запитом:"

#: ../../source/tutorial.rst:201
#: ../../source/tutorial.rst:211
msgid ""
"If contract is unsuccessful reasons for termination ``terminationDetails`` "
"should be specified."
msgstr ""
"Якщо договір неуспішний, то потрібно вказати причини його припинення "
"``terminationDetails``."

#: ../../source/tutorial.rst:86
msgid ""
"Note that you can provide more than one value in ``rationaleTypes`` field."
msgstr ""
"Зверніть увагу на те, що ви можете надати більше ніж одне значення для поля "
"``rationaleTypes``."

#: ../../source/tutorial.rst:79
msgid "Submitting a change"
msgstr "Подання зміни"

#: ../../source/tutorial.rst:99
msgid "Uploading change document"
msgstr "Завантаження документа зміни"

#: ../../source/tutorial.rst:116
msgid "Updating contract properties"
msgstr "Оновлення властивостей зміни"

#: ../../source/tutorial.rst:118
msgid "Now you can update contract properties which belong to the change."
msgstr "Тепер ви можете оновити властивості договору, що стосуються зміни."

#: ../../source/tutorial.rst:125
msgid ""
"Fields that can be modified: `title`, `description`, `status`, "
"`value.amount`, `period`, `items`, `amountPaid`, `terminationDetails`."
"`value.amount`, `period`, `items`, `amountPaid.amount`, "
"`terminationDetails`."
msgstr ""
"Поля, які можна модифікувати: `title`, `description`, `status`, "
"`value.amount`, `period`, `items`, `amountPaid`, `terminationDetails`."
"`value.amount`, `period`, `items`, `amountPaid.amount`, "
"`terminationDetails`."

#: ../../source/tutorial.rst:148
#: ../../source/tutorial.rst:145
msgid "Applying the change"
msgstr "Застосування зміни"

#: ../../source/tutorial.rst:209
msgid ""
"Note that you can provide more than one value in ``rationaleTypes`` field."
"Note that you can set/change only ``amountPaid.amount`` value. "
"``amountPaid.currency`` and ``amountPaid.valueAddedTaxIncluded`` fields' "
"values are generated from ``Contract.value`` field."
msgstr ""
"Зверніть увагу на те, що ви можете надати більше ніж одне значення для поля "
"``rationaleTypes``."
"Зверніть увагу, що ви можете встановлювати/змінювати значення "
"``amountPaid.amount``. А значення полів ``amountPaid.currency`` і "
"``amountPaid.valueAddedTaxIncluded`` генеруються з поля ``Contract.value``."

9 changes: 3 additions & 6 deletions docs/source/standard/contract.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,9 @@ Schema

:amountPaid:

:amount:
┆ float, required
:currency:
┆ string, required, autogenerated
:valueAddedTaxIncluded:
┆ bool, required , autogenerated
:amount: float, required
:currency: string, required, auto-generated
:valueAddedTaxIncluded: bool, required , auto-generated

Amount of money actually paid.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Document has to be added in two stages:
Updating contract properties
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Now you can update contract properties which belong to the Change.
Now you can update contract properties which belong to the change.

.. include:: tutorial/contracts-patch.http
:code:
Expand Down Expand Up @@ -206,7 +206,7 @@ Let's perform these actions in single request:
.. include:: tutorial/contract-termination.http
:code:

Note that you can set/change only ``amountPaid.amount`` value. ``amountPaid.currency`` and ``amountPaid.valueAddedTaxIncluded`` fields values are generated from Contract.value field.
Note that you can set/change only ``amountPaid.amount`` value. ``amountPaid.currency`` and ``amountPaid.valueAddedTaxIncluded`` fields' values are generated from ``Contract.value`` field.

If contract is unsuccessful reasons for termination ``terminationDetails`` should be specified.

Expand Down

0 comments on commit b55564b

Please sign in to comment.