-
Notifications
You must be signed in to change notification settings - Fork 0
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
Add sustainability modules to mapping documentation #422
Conversation
For spellcheck, change |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a straight split of the content (i.e. without additional changes), plus the addition of the sustainability content (which will continue to change).
If that's the case, then my only comment is with heading levels having changed.
Yep, that's correct. |
I realised that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few small changes, then good to merge :)
docs/cost/ids/core.md
Outdated
|
||
This page documents a mapping from the 'core' CoST IDS elements to OC4IDS fields and codes. The organization of the mapping tables reflects the structure of the CoST IDS. | ||
|
||
The CoST IDS sets out a number of disclosure requirements under the heading of 'information for disclosure upon request', also known as 'reactive disclosure'. You can disclose these elements proactively using OC4IDS. Separate tables are provided for project-level and process-level reactive disclosures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this paragraph also be present in ocds.md
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! Added in a198afb
Co-authored-by: James McKinney <[email protected]>
Related issues
Description
The mapping is stored in
sustainability.yaml
and there are two newmanage.py
commands:update-sustainability-docs
generates the Markdown content indocs/cost/ids/sustainability.md
usingsustainability.yaml
.lint
formats and validates the data insustainability.yaml
and reports missing dataPresently,
lint
reports many additional fields and some missing data. This is expected because the schema is not yet updated and because the mapping for some elements is still under discussion.However, I suggest that we merge this PR as-is and then, as part of each schema or codelist change PR, we can update the relevant mappings and examples in
sustainability.yaml
.Before releasing, OC4IDS 0.9.4 we can do a final copy edit of the mappings and examples for consistency and check that
lint
reports no additional fields or missing data. I'll create a separate issue about that.The spell-check is failing on the "TNE" unit code referenced in the mapping. @jpmckinney is there somewhere that needs to be added to a dictionary?
Merge checklist
If there are changes to
project-schema.json
orproject-package-schema.json
:docs/examples/example.json
docs/examples/blank.json
./manage.py pre-commit
to updatedocs/_static/i8n.csv
If you added a new definition to the schema, run
./manage.py pre-commit
.If you added a new codelist:
docs/reference/codelists.md