-
Notifications
You must be signed in to change notification settings - Fork 46
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
Feature contracing process and planning process definitions in the reference documentation #1714
Comments
Good idea! |
Looking at it again, I think that most of the rest of the content on the worked example page is pretty fundamental to understanding OCDS. Presently, that page is only linked from the list of 'hard cases' in the mapping guidance and from the related process codelist reference. To increase the chances of readers seeing it and to reduce repetition, I think it would make sense to retire the worked example page altogether and instead integrate the content into the schema and reference documentation as follows:
@jpmckinney does that sound good? If we decide to keep the worked example, we should fix the erroneous code formatting on |
For the bold changes, the singular like in the original is preferred, as a tag is only ever about one process. I think we can upgrade this to must (since a planning process is, by definition, a process with one of the planning tags and none of the others), and draw out the real intention of the pre-existing last sentence: "A planning process must use either the 'planning' or 'planningUpdate' code, and must not use any other code from the releaseTag codelist." And we can draw out the real intention of the contracting process phrase: "A contracting process should not use the 'planning' or 'planningUpdate' codes." We should correct " Also, the language of "set to 'planning'" is incorrect, since the field is an array not a string. Let's also fix the "the the" repetition in the Other changes sound good. Edit: Ideally, the shoulds would be musts, but that would mean existing data fails structural checks. |
Just to double check, from your suggestions in #1714 (comment) @jpmckinney we're keeping https://standard.open-contracting.org/staging/1.2-dev/en/guidance/map/contracting_planning_processes/ as a worked example as well as making the changes to the schema and reference page? |
I think we can eliminate the worked example. My understanding is that essentially all content will have been copied/adapted into the reference section. |
That guidance was introduced in e6bc88b as part of #1216, to resolve #1159 (which was guidance that mixed up the definition of contracting processes with a discussion of unsuccessful processes). In other words, I don't think there was a strong motivation for this content to be under guidance – it was more that it shouldn't be mixed into the unsuccessful process guidance. |
Presently, the following definitions from the
description
field of the release schema only appear in the implementation guidance:The page on which they appear (
docs/guidance/map/contracting_planning_processes.md
) is only expected to be (optionally) read during the mapping phase of an OCDS implementation, but I think it would aid understanding if these definitions were featured prominently in the reference documentation. The primer does include a definition of a contracting process, but I think this kind of detail more properly belongs in the reference section, since it is something that implementers might need to refer back to when thinking about different kinds of contracting process.The text was updated successfully, but these errors were encountered: