Skip to content

Commit 44c39a5

Browse files
author
Tim Davies
committed
Deprecation of milestone documents. Addresses #355
1 parent 4251d01 commit 44c39a5

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

standard/docs/en/schema/reference.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ The identifier block provides a way to [identify the legal entities](../../ident
265265

266266
### Document
267267

268-
Documents may be attached at a number of points within the standard: to planning, tenders, awards, contracts and milestones. Each document block can consist of multiple documents, classified using the [documentType](../../codelists/#document-type) codelist.
268+
Documents may be attached at a number of points within the standard: to planning, tenders, awards, contracts and implementation Each document block can consist of multiple documents, classified using the [documentType](../../codelists/#document-type) codelist.
269269

270270
The document block is also used to link to legal notices, which should have a documentType of 'notice'.
271271

@@ -361,7 +361,7 @@ The ```unit``` block allows detailed specification of the parameters and price o
361361

362362
Milestone information can be included in the [tender](#tender) and [contract implementation](#implementation) blocks.
363363

364-
In the context of a tender block, milestones describe the key deliverables of a contract, or key points during the lifetime of the contract. These may have associated documentation.
364+
In the context of a tender block, milestones describe the key deliverables of a contract, or key points during the lifetime of the contract.
365365

366366
In the context of a contract implementation block, milestones are used to track progress towards those deliverables and key events set out in the tender.
367367

@@ -376,6 +376,11 @@ Notes:
376376

377377
* The ```dateModified``` field should be changed whenever the progress towards a milestone is reviewed, and the ```status``` either updated, or re-confirmed.
378378

379+
```eval_rst
380+
.. extensionlist:: The following extensions to milestone are available
381+
:list: milestones
382+
```
383+
379384
<!-- ToDo: Add example -->
380385

381386
### Value

standard/schema/release-schema-1.1.json

+4
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,10 @@
557557
"title":"Documents",
558558
"description": "List of documents associated with this milestone.",
559559
"type": "array",
560+
"deprecated":{
561+
"deprecatedVersion":"1.1",
562+
"description":"Inclusion of documents at the milestone level is now deprecated. Documentation should be attached in the tender, award, contract or implementation sections, and titles and descriptions used to highlight the related milestone. Publishers who wish to continue to provide documents at the milestone level should explicitly declare this by using the milestone documents extension."
563+
},
560564
"mergeStrategy": "arrayMergeById",
561565
"mergeOptions": { "idRef": "id" },
562566
"items": { "$ref": "#/definitions/Document" },

0 commit comments

Comments
 (0)