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

All TODOs from documentation #583

Closed
jpmckinney opened this issue Sep 29, 2017 · 1 comment · Fixed by #1019
Closed

All TODOs from documentation #583

jpmckinney opened this issue Sep 29, 2017 · 1 comment · Fixed by #1019
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Sep 29, 2017

These are in HTML comments on the following pages:

  • getting_started/building_blocks.md: Add section on mapping - including links to mapping tools
  • getting_started/index.md: You can find samples of OCDS data, and information on using OCDS in the implementation handbook.
  • schema/index.md: Consider adding diagram here
  • schema/reference.md: Add example (milestones)
@jpmckinney jpmckinney added the Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues label Sep 29, 2017
@jpmckinney jpmckinney added this to the 1.1.x Clarifications milestone Sep 18, 2018
@jpmckinney jpmckinney modified the milestones: 1.1.x Clarifications, 1.2 Nov 29, 2018
@jpmckinney jpmckinney modified the milestones: 1.2, 1.1.5 Feb 2, 2019
@jpmckinney
Copy link
Member Author

getting_started/building_blocks.md: Add section on mapping - including links to mapping tools

This is covered in the Map phase of the new Guidance section.

You can find samples of OCDS data, and information on using OCDS in the implementation handbook.

We no longer provide real sample data in the sample-data repository (only fictional data), as our strategy is to develop worked examples as a more useful way to explain how to model data in OCDS (rather than leave it up to the implementer to reverse-engineer from existing data, which is error-prone, considering much data has conformance issues).

Specific guidance on using OCDS data is covered by the OCP website and is not in scope for the OCDS documentation. https://www.open-contracting.org/data/data-use/

schema/index.md: Consider adding diagram here

It's not clear what diagram was intended for this page. #991 is the more general issue about diagrams and other visuals.

schema/reference.md: Add example (milestones)

See #949. I created an issue to link to examples from reference pages #1018.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant