open-contracting / standard

Documentation of the Open Contracting Data Standard (OCDS)
http://standard.open-contracting.org/
Other
136 stars 46 forks source link

Update guidance on naming of classification schemes #1690

Open jpmckinney opened 1 month ago

jpmckinney commented 1 month ago

https://standard.open-contracting.org/staging/1.2-dev/en/guidance/map/organization_classifications/

The general guidance ought to be along the lines of:

This is consistent with https://extensions.open-contracting.org/en/extensions/coveredBy/master/#guidance

We should link to the new guidance from https://extensions.open-contracting.org/en/extensions/organizationClassification/master/

In the examples, we should change "COL" to "CO". We can add an admonition about TED_CE_ACTIVITY and TED_CA_TYPE, to explain that they don't conform to our guidance, because we aimed for consistency with the XML elements in the TED Schema. (At the same time, we can update to the 'eu-main-activity' and 'eu-buyer-legal-type' schemes).

Related, we should change this page to use alpha-2: https://standard.open-contracting.org/staging/1.2-dev/en/guidance/map/organization_personal_identifiers/


For reference, https://github.com/open-contracting/standard-maintenance-scripts/blob/main/schema/codelist-schema.json sets the allowed patterns for codes, some of which are relevant for scheme codes:

Exceptional patterns, to match multinational standards:

These patterns are not relevant for scheme codes (they are examples of being consistent with other standards):

odscjen commented 1 month ago

We can add an admonition about TED_CE_ACTIVITY and TED_CA_TYPE, to explain that they don't conform to our guidance, because we aimed for consistency with the XML elements in the TED Schema. (At the same time, we can update to the 'eu-main-activity' and https://github.com/open-contracting/european-union-support/issues/208 schemes).

Do you mean that the example (2.1) on https://standard.open-contracting.org/staging/1.2-dev/en/guidance/map/organization_classifications/ should be updated to the use the eForms codes/schemes rather than the TED ones? So the admonition should mention both TED and eForms schemes?

odscjen commented 1 month ago

In the examples, we should change "COL" to "CO".

Noting that the examples that will be affected by this are included in https://github.com/open-contracting/standard/pull/1680 so it's probably best to wait until that PR has been merged before creating a PR for this issue to avoid merge conflicts

jpmckinney commented 1 month ago

Do you mean that the example (2.1) on https://standard.open-contracting.org/staging/1.2-dev/en/guidance/map/organization_classifications/ should be updated to the use the eForms codes/schemes rather than the TED ones? So the admonition should mention both TED and eForms schemes?

We should update it to eForms, in which case we only have an admonition for the eForms schemes (since the TED schemes will no longer be part of the examples).