From 770b280b77ddc6da429fe5fd5e2282044b8eb503 Mon Sep 17 00:00:00 2001 From: duncandewhurst Date: Wed, 24 Jul 2019 12:34:59 +0100 Subject: [PATCH 1/4] remove content relating to core standard --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5e06c11..7d9c574 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,17 @@ # Documentation details -Contracting processes involve many different documents. There should be a presumption of 'open by default' when it comes to publishing these documents as part of an Open Contracting process. - The OCDS documentation block, which is used widely through the different sections of the standard, provides a means to link out to externally hosted documents. -These should generally be provided at their own stable URL, without requirements to log-in or authenticate. Redactions should be kept to a minimum. - ## Providing enhanced documentation and document links A number of implementations of OCDS, notable OCDS for PPPs, explicitly require a number of key items of information to be disclosed. These items are articulated as an extended list of entries for the `documentType` codelist. However, rather than just linking out to the entire document where the information is found, this extension describes a way to: -* Summarize the information in the `description` field of the relevant document block; * Link to specific page numbers; * Describe any additional arrangements required to access the document or find the relevant information; * Record the author of the document; -Providing clear summaries allows applications to display this information in a user-interface, allowing users to access key facts and justifications without clicking through to download and search for the information in a full document. - Linking to the specific page where information is found supports quality assurance of disclosure. Describing `accessDetails` for a document ensures that, even when documents are only accessible through attendance at a location (for example), that users can find how to discover them - and so that auditors can check documents have been made accessible in the appropriate ways. @@ -31,6 +24,10 @@ Report issues for this extension in the [ocds-extensions repository](https://git ## Changelog +### 2019-07-24 + +* Remove references to core fields from README.md + ### 2019-01-30 * Remove obsolete `mergeStrategy` properties From ca4f5cf3eaae3dd54aa227a260ff7dc9c5d6eb3a Mon Sep 17 00:00:00 2001 From: duncandewhurst Date: Wed, 24 Jul 2019 12:52:18 +0100 Subject: [PATCH 2/4] add example --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 7d9c574..18198ad 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,26 @@ Describing `accessDetails` for a document ensures that, even when documents are Recording the author of a document is important for checking whether there are potential conflicts of interest to be aware of: for example, when the author of a feasibility study is later involved in the team submitting a bid. +## Example + +```json +{ + "documents": [ + { + "id": "1", + "documentType": "equityTransferCaps", + "title": "Equity transfer cap terms", + "description": "No equity transfer is permitted until construction is completed. See document for more details.", + "url": "http://example.com/ppp_unit/documents/contracts/4g_network_signed_contract.pdf", + "pageStart": "334", + "pageEnd": "336", + "accessDetails": "You must register for document access via the following url: http://example.com/ppp_unit/registration/", + "author": "Contract department, PPP unit" + } + ] +} +``` + ## Issues Report issues for this extension in the [ocds-extensions repository](https://github.com/open-contracting/ocds-extensions/issues), putting the extension's name in the issue's title. From 97fc21632ae793200bf61caf20fe046cf4d96d5b Mon Sep 17 00:00:00 2001 From: Yohanna Lisnichuk Date: Wed, 15 Apr 2020 13:22:19 -0400 Subject: [PATCH 3/4] Update readme Signed-off-by: Yohanna Lisnichuk --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 18198ad..8e058fd 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,17 @@ # Documentation details -The OCDS documentation block, which is used widely through the different sections of the standard, provides a means to link out to externally hosted documents. +The OCDS `documentations` block, which is used widely through the different sections of the standard, provides a means to link out to externally hosted documents. However, some publishers have more detailed information about these documents. +This extension describes a way to: -## Providing enhanced documentation and document links +* Indicate document's specific page numbers +* Describe any additional arrangements required to access the document or find the relevant information +* Record the author of the document -A number of implementations of OCDS, notable OCDS for PPPs, explicitly require a number of key items of information to be disclosed. These items are articulated as an extended list of entries for the `documentType` codelist. +Indicating the specific pages where information is found supports quality assurance of disclosure. -However, rather than just linking out to the entire document where the information is found, this extension describes a way to: +Describing `accessDetails` for a document ensures, even when documents are only accessible through attendance at a location (for example), that users can find how to discover them - and also ensures that auditors can check documents that have been made accessible in the appropriate ways. -* Link to specific page numbers; -* Describe any additional arrangements required to access the document or find the relevant information; -* Record the author of the document; - -Linking to the specific page where information is found supports quality assurance of disclosure. - -Describing `accessDetails` for a document ensures that, even when documents are only accessible through attendance at a location (for example), that users can find how to discover them - and so that auditors can check documents have been made accessible in the appropriate ways. - -Recording the author of a document is important for checking whether there are potential conflicts of interest to be aware of: for example, when the author of a feasibility study is later involved in the team submitting a bid. +Recording the `author` of a document is important for checking whether there are potential conflicts of interest to be aware of: for example, when the author of a feasibility study is later involved in the team submitting a bid. ## Example From 1c5de5850dbc7ceac62a7f9c373747ca99801d67 Mon Sep 17 00:00:00 2001 From: Yohanna Lisnichuk Date: Wed, 15 Apr 2020 13:29:21 -0400 Subject: [PATCH 4/4] Update readme Signed-off-by: Yohanna Lisnichuk --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8e058fd..092b19c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Documentation details -The OCDS `documentations` block, which is used widely through the different sections of the standard, provides a means to link out to externally hosted documents. However, some publishers have more detailed information about these documents. +The OCDS `documents` block, which is used widely through the different sections of the standard, provides a means to link out to externally hosted documents. However, some publishers have more detailed information about these documents. This extension describes a way to: * Indicate document's specific page numbers @@ -17,19 +17,21 @@ Recording the `author` of a document is important for checking whether there are ```json { - "documents": [ - { - "id": "1", - "documentType": "equityTransferCaps", - "title": "Equity transfer cap terms", - "description": "No equity transfer is permitted until construction is completed. See document for more details.", - "url": "http://example.com/ppp_unit/documents/contracts/4g_network_signed_contract.pdf", - "pageStart": "334", - "pageEnd": "336", - "accessDetails": "You must register for document access via the following url: http://example.com/ppp_unit/registration/", - "author": "Contract department, PPP unit" - } - ] + "tender": { + "documents": [ + { + "id": "1", + "documentType": "equityTransferCaps", + "title": "Equity transfer cap terms", + "description": "No equity transfer is permitted until construction is completed. See document for more details.", + "url": "http://example.com/ppp_unit/documents/contracts/4g_network_signed_contract.pdf", + "pageStart": "334", + "pageEnd": "336", + "accessDetails": "You must register for document access via the following url: http://example.com/ppp_unit/registration/", + "author": "Contract department, PPP unit" + } + ] + } } ```