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

Add guidance on linking releases from different publications #1430

Closed
duncandewhurst opened this issue Oct 12, 2021 · 3 comments · Fixed by #1646
Closed

Add guidance on linking releases from different publications #1430

duncandewhurst opened this issue Oct 12, 2021 · 3 comments · Fixed by #1646
Assignees
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues
Milestone

Comments

@duncandewhurst
Copy link
Contributor

duncandewhurst commented Oct 12, 2021

We should provide guidance since this issue has come up a couple of times recently

  • In the UK, where Contracts Finder, Find a Tender Service and Public Contracts Scotland all publish releases about the same contracting processes (see CRM-7250, CRM-7262, CRM-7304 and CRM-7512)
  • In Colombia, where Colombia Compra and ANI publish releases about the same contracting processes (see CRM-7263)

Unless the publications use consistent mappings, reusing the same OCIDs across publications could result in unpredictable and nonsensical results. For example, unless they use an identical approach to assigning local identifiers to objects in arrays, then awards, contracts etc. will overwrite and/or duplicate each other in nonsensical ways.

Roughly, the guidance can be:

  • If the publications are distinct (e.g. they cover disjoint sets of fields, different stages, different procedure types etc.) then they should use the same OCID so that users can merge releases.
  • If the publications use a consistent mapping, including the approach to assigning local identifiers to objects in arrays, they should use the same OCID so that users can merge releases.
  • If the publications don't use a consistent mapping, they should use the Links field (added in Add links field #928) so that users can identify that contracting processes are the same, whilst avoiding incorrect merging of releases.

We can also include some of the content from CRM-7250 around the governance and technical considerations for coordinating publications.

cc @yolile

@duncandewhurst duncandewhurst added the Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues label Oct 12, 2021
@duncandewhurst duncandewhurst added this to the 1.2.0 milestone Oct 12, 2021
@jpmckinney
Copy link
Member

Yes, the discussion in the CRM could serve as a worked example.

@yolile
Copy link
Member

yolile commented Oct 13, 2021

Thanks, Duncan for opening this issue.

If the publications don't use a consistent mapping, they should use the Links field

With the "prev" link type, I assume?

@duncandewhurst
Copy link
Contributor Author

Yes, if linking to an individual release I think that would be most appropriate.

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
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants