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

Tag: Open the codelist #1214

Closed
jpmckinney opened this issue Feb 12, 2021 · 5 comments · Fixed by #1238
Closed

Tag: Open the codelist #1214

jpmckinney opened this issue Feb 12, 2021 · 5 comments · Fixed by #1238
Assignees
Labels
Schema: Fields Relating to adding or deprecating fields in the JSON Schema
Milestone

Comments

@jpmckinney
Copy link
Member

Following from #792 and #1184, we will open the tag codelist.

In terms of guidance, we can recommend that a code from the codelist be used wherever possible, but that additional codes can be used based on the publisher's use cases. The additional codes can closely map the notice types (in a notice-based or paper-based system) or the event types (in an electronic records-based system).

@jpmckinney jpmckinney added this to the 1.2.0 milestone Feb 12, 2021
@jpmckinney jpmckinney added the Schema: Fields Relating to adding or deprecating fields in the JSON Schema label Feb 14, 2021
@ColinMaudry ColinMaudry linked a pull request Mar 8, 2021 that will close this issue
@ColinMaudry
Copy link
Member

ColinMaudry commented Mar 8, 2021

@jpmckinney
Copy link
Member Author

jpmckinney commented Mar 8, 2021

What changes would you make to those pages? Getting started is being rewritten (#1239) and guidance on tags is probably too low-level for the primer/getting started section.

@ColinMaudry
Copy link
Member

In the sections that mention release tags, II would advertise the fact that one can use their own codes to stick to their internal process.

@jpmckinney
Copy link
Member Author

In the sections that mention release tags, II would advertise the fact that one can use their own codes to stick to their internal process.

I don't think tagging is fundamental to the worked example at https://standard.open-contracting.org/latest/en/guidance/build/easy_releases/, so it's not necessary to explain this there.

The new Primer (replacing Getting Started) doesn't discuss tags at all. (The Primer focuses on the concepts needed to understand the rest of the docs. Tags are a more narrow topic that can be addressed later.)

I'll review the PR to see where to include this in the reference section.

@ColinMaudry
Copy link
Member

ColinMaudry commented May 14, 2021

With #1244 merged, the only guidance is in reference/codelists.md and it mentions the fact that one can use their own tags: https://github.com/open-contracting/standard/pull/1244/files#diff-d6958c79ed9293ec0b969c4db1ebbeeeeb6542bc6d2124e25b01769896e5b7fcR25

I can't think of another section in reference were we could mention this possibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Schema: Fields Relating to adding or deprecating fields in the JSON Schema
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants