Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1449 improve examples #1661

Merged
merged 43 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
762a12b
update buyers_suppliers, convert csv example to json
odscjen Oct 23, 2023
87c2ac1
consortia_simple.json fix indenting
odscjen Oct 23, 2023
26891a4
update primer/how.md and primer/releases_records.md
odscjen Nov 20, 2023
1707563
Merge remote-tracking branch 'origin/1.2-dev' into 1449-improve-examples
odscjen Nov 20, 2023
eb37438
primer/how.md: fix csv tables
odscjen Nov 20, 2023
50f81f4
primer/how.md: fix paths for examples/
odscjen Nov 20, 2023
36cf585
primer/how.md: remove nested header from admonition
odscjen Nov 20, 2023
b3ecff3
merging.md: update example using real example from Ghana
odscjen Nov 20, 2023
cf172f0
docs/examples: run ocdskit indent
odscjen Nov 20, 2023
fe6dc74
add back versioned.json
odscjen Nov 20, 2023
aaa066d
build/merging.md: correct typos
odscjen Nov 20, 2023
bebdcaf
schema/merging.md: update versioned example and fix more typos
odscjen Nov 28, 2023
21173b6
update tests_docs.py, change date to check
odscjen Nov 30, 2023
d86b34a
Apply suggestions from code review
odscjen Dec 1, 2023
aa5b810
apply review suggestions
odscjen Dec 1, 2023
348945d
fix build errors
odscjen Dec 1, 2023
522ace7
how.md: apply review suggestion
odscjen Dec 1, 2023
83eff56
Apply suggestions from code review
odscjen Dec 12, 2023
d393426
docs/merging updates following review
odscjen Dec 12, 2023
7c81ba5
docs/merging: apply review suggestions
odscjen Dec 15, 2023
b565973
Merge branch '1.2-dev' into 1449-improve-examples
odscjen Feb 28, 2024
95575f9
docs/guidance/build/merging.md: Replace updates example
duncandewhurst Mar 4, 2024
253c3f6
docs/guidance/map/buyers_suppliers.md: Move consortia example to JSON…
duncandewhurst Mar 4, 2024
058b50a
docs/primer/how.md: Simplify example
duncandewhurst Mar 4, 2024
5be5324
docs/guidance/map/amendments.md: Simplify tender example
duncandewhurst Feb 28, 2024
4618ed4
docs/guidance/map/amendments.md: Add paragraph breaks
duncandewhurst Feb 28, 2024
5b26351
docs/examples/amendments/tender.json: Reindent
duncandewhurst Feb 28, 2024
fe30b27
docs/guidance/map/amendments.md: Copy edits
duncandewhurst Feb 28, 2024
9923fae
docs/guidance/map/amendments.md: Remove contract example
duncandewhurst Feb 29, 2024
5d99ef6
docs/schema/merging.md: Update example
duncandewhurst Mar 4, 2024
a3c727f
docs/examples/merging/updates: Remove unused examples
duncandewhurst Mar 4, 2024
a14cace
docs/examples/buyers_suppliers/consortia.json: Indent
duncandewhurst Mar 4, 2024
5575637
tests/test_docs.py: Remove unneeded test
duncandewhurst Mar 4, 2024
30fdb79
Merge branch '1.2-dev' into 1449-improve-examples (conflicts due to r…
jpmckinney Mar 27, 2024
92f6391
examples: Fix filenames in readme
jpmckinney Mar 27, 2024
fca40c7
docs: Fix command in README
jpmckinney Mar 27, 2024
bd3b4a5
docs/guidance/build/merging.md: Update heading
duncandewhurst Mar 27, 2024
4af6cce
Apply suggestions from code review
duncandewhurst Mar 27, 2024
fa9161a
docs/examples: Remove unused
duncandewhurst Mar 27, 2024
e6a89cb
docs/schema: Update record and record package examples
duncandewhurst Mar 27, 2024
e8be637
docs/schema/records_reference.md: Update text to match JSON
duncandewhurst Mar 27, 2024
2140e6c
Update docs/guidance/map/milestones.md
duncandewhurst Mar 27, 2024
3d95f6a
examples: Use HTTPS for linked_releases.json
jpmckinney Mar 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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