Cross-Domain-Interoperability-Framework / cdif-core

A repository to host the core interoperability specifications for CDIF
Creative Commons Zero v1.0 Universal
0 stars 1 forks source link

Refactor import odis--alternate approach to building CDIF-core #3

Closed smrgeoinfo closed 8 months ago

smrgeoinfo commented 10 months ago

Provided as an alternative repo organization for CDIF-core.

There are two top level subdirectories:

in_review: hosts proposed templates and guidance documents for different resource types or metadata components.

adopted: host templates that have been reviewed and tested by the CDIF working group and are recommended for use.

Subdirectories in these top level directories host templates and guidance documents for particular resource types or metadata components. Each subdirectory has three folders: Examples, Templates, and Validation. Guidance documents (preferably using Markdown) should be in in the root subdirectory for the resource type.

pbuttigieg commented 8 months ago

Provided as an alternative repo organization for CDIF-core.

There are two top level subdirectories:

in_review: hosts proposed templates and guidance documents for different resource types or metadata components.

adopted: host templates that have been reviewed and tested by the CDIF working group and are recommended for use.

I think this is redundant with the normative GitHub functions. PRs (especially those in draft) are, in effect, " in_review". What is merged will be adopted.

Subdirectories in these top level directories host templates and guidance documents for particular resource types or metadata components. Each subdirectory has three folders: Examples, Templates, and Validation. Guidance documents (preferably using Markdown) should be in in the root subdirectory for the resource type.

  • Examples are valid schema.org JSON-LD documents documenting actual data.

  • Templates are typically JSON_LD docs with explanatory text for the content of the keys in the JSON doc. The templates are serialised in JSON-LD using the schema.org vocabulary. JSON Schema or SHACL/SHEX rule sets might also be provided for validation.

  • Validation folder contains JSON schema, SHACL rule sets or similar docs that can be used to validate JSON-LD following recommendations.

In the CDIF call unfolding now, we agreed to split up the original PR into one PR per pattern (e.g. one for Dataset, one for Person, etc)

This will make the thing easier to handle.

pbuttigieg commented 8 months ago

@smrgeoinfo the proposed workflow in your last commit departs from the normative issue-to-branch-to-PR workflow.

smrgeoinfo commented 8 months ago

abandon this update, see #7