Skip to content

Commit

Permalink
1449 improve examples (#1661)
Browse files Browse the repository at this point in the history
* update buyers_suppliers, convert csv example to json

* consortia_simple.json fix indenting

* update primer/how.md and primer/releases_records.md

* primer/how.md: fix csv tables

* primer/how.md: fix paths for examples/

* primer/how.md: remove nested header from admonition

* merging.md: update example using real example from Ghana

* docs/examples: run ocdskit indent

* add back versioned.json

* build/merging.md: correct typos

* schema/merging.md: update versioned example and fix more typos

* update tests_docs.py, change date to check

* Apply suggestions from code review

Co-authored-by: Duncan Dewhurst <[email protected]>

* apply review suggestions

* fix build errors

* how.md: apply review suggestion

* Apply suggestions from code review

Co-authored-by: Duncan Dewhurst <[email protected]>

* docs/merging updates following review

* docs/merging: apply review suggestions

* docs/guidance/build/merging.md: Replace updates example

* docs/guidance/map/buyers_suppliers.md: Move consortia example to JSON file, simplify

* docs/primer/how.md: Simplify example

* docs/guidance/map/amendments.md: Simplify tender example

* docs/guidance/map/amendments.md: Add paragraph breaks

* docs/examples/amendments/tender.json: Reindent

* docs/guidance/map/amendments.md: Copy edits

* docs/guidance/map/amendments.md: Remove contract example

* docs/schema/merging.md: Update example

* docs/examples/merging/updates: Remove unused examples

* docs/examples/buyers_suppliers/consortia.json: Indent

* tests/test_docs.py: Remove unneeded test

* examples: Fix filenames in readme

* docs: Fix command in README

* docs/guidance/build/merging.md: Update heading

* Apply suggestions from code review

Co-authored-by: James McKinney <[email protected]>

* docs/examples: Remove unused

* docs/schema: Update record and record package examples

* docs/schema/records_reference.md: Update text to match JSON

* Update docs/guidance/map/milestones.md

Co-authored-by: James McKinney <[email protected]>

* examples: Use HTTPS for linked_releases.json

---------

Co-authored-by: Duncan Dewhurst <[email protected]>
Co-authored-by: James McKinney <[email protected]>
  • Loading branch information
3 people authored Mar 28, 2024
1 parent 1ebc554 commit b93ef71
Show file tree
Hide file tree
Showing 30 changed files with 261 additions and 3,843 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,15 @@ Install [OCDS Kit](https://pypi.org/project/ocdskit/)
Update the examples in `docs/examples/merging`:

```shell
cat docs/examples/merging/updates/{tender*,award*}.json | ocdskit --pretty compile --published-date 2016-03-05T13:02:00Z --uri https://standard.open-contracting.org/examples/records/ocds-213czf-000-00002-merge.json --package --linked-releases > docs/examples/merging/updates/merged.json
cat docs/examples/merging/updates/{tender*,award*}.json | ocdskit --pretty compile --published-date 2016-03-05T13:02:00Z --uri https://standard.open-contracting.org/examples/records/ocds-213czf-000-00002-merge.json --package --linked-releases --versioned > docs/examples/merging/updates/versioned.json
```

```shell
cat docs/examples/merging/deletions/field-tender*.json | ocdskit --pretty compile --package --versioned --schema schema/release-schema.json --published-date 2013-07-30T09:00:10.000Z > docs/examples/merging/deletions/field-record.json
cat docs/examples/merging/deletions/object-tender*.json | ocdskit --pretty compile --package --versioned --schema schema/release-schema.json > docs/examples/merging/deletions/object-record.json
cat docs/examples/merging/deletions/array_award*.json | ocdskit --pretty compile --package --versioned --schema schema/release-schema.json > docs/examples/merging/deletions/array-record.json
cat docs/examples/merging/deletions/field_tender*.json | ocdskit --pretty compile --package --versioned --schema schema/release-schema.json --published-date 2013-07-30T09:00:10.000Z > docs/examples/merging/deletions/field_record.json
cat docs/examples/merging/deletions/object_tender*.json | ocdskit --pretty compile --package --versioned --schema schema/release-schema.json > docs/examples/merging/deletions/object_record.json
cat docs/examples/merging/deletions/array_award*.json | ocdskit --pretty compile --package --versioned --schema schema/release-schema.json > docs/examples/merging/deletions/array_record.json
```

Update the examples in `docs/examples/change_history`:

```shell
cat docs/examples/change_history/{tender}.json | ocdskit --pretty compile --published-date 2010-03-15T09:30:00Z --uri https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json --package --versioned --schema schema/release-schema.json > docs/examples/change_history/records/tender.json
cat docs/examples/change_history/tender.json | ocdskit --pretty compile --published-date 2010-03-15T09:30:00Z --uri https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json --package --versioned --schema schema/release-schema.json > docs/examples/change_history/records/tender.json
cat docs/examples/change_history/{tender,tenderUpdate}.json | ocdskit --pretty compile --published-date 2010-03-20T09:45:00Z --uri https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json --package --versioned --schema schema/release-schema.json > docs/examples/change_history/records/tenderUpdate.json
cat docs/examples/change_history/{tender,tenderUpdate,award}.json | ocdskit --pretty compile --published-date 2010-05-10T09:30:00Z --uri https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json --package --versioned --schema schema/release-schema.json > docs/examples/change_history/records/award.json
cat docs/examples/change_history/{tender,tenderUpdate,award,contract}.json | ocdskit --pretty compile --published-date 2010-06-10T10:30:00Z --uri https://standard.open-contracting.org/examples/records/ocds-213czf-000-00001.json --package --versioned --schema schema/release-schema.json > docs/examples/change_history/records/contract.json
Expand Down
Loading

0 comments on commit b93ef71

Please sign in to comment.