search

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

1 import core odis patterns specifications #2

Open pbuttigieg opened 11 months ago

pbuttigieg commented 11 months ago

This PR is where we'll ship the ODIS-Arch domain-neutral specifications and patterns into the CDIF Environment

smrgeoinfo commented 10 months ago

there are many files here dealing with different aspects of data documentation. I suggest we split these up into separate pull requests focused on different resource types, or perhaps CDIF workgroup focus?

smrgeoinfo commented 10 months ago

Looking at the dataset examples, the documents have many properties that are outside the scope of the current Discovery recommendation draft. These would not be part of CDIF-core as I understand the idea.

smrgeoinfo commented 10 months ago

I ran through the JSON files in the https://github.com/Cross-Domain-Interoperability-Framework/cdif-core/tree/1-import-core-odis-patterns-specifications/json-ld/schema folder from the PR, and I'd suggest that some more curation is needed-- there are repeated files, not all the json files seem to be in the subdirectory where they belong. It's not obvious what is a 'specification', ''template' or 'example'. I've generated a refactor of the content (PR #3) that's a start towards what I'd propose as a repo structure for a 'CDIF-core' set of recommendations/guidance. The CDIF workgroup needs to discuss and make decisions about how to manage these kind of recommendations, in parallel with the documents that WG's are generating (e.g. Discoverability )

pbuttigieg commented 8 months ago

there are many files here dealing with different aspects of data documentation. I suggest we split these up into separate pull requests focused on different resource types, or perhaps CDIF workgroup focus?

Yes, as described in #3

pbuttigieg commented 8 months ago

Looking at the dataset examples, the documents have many properties that are outside the scope of the current Discovery recommendation draft. These would not be part of CDIF-core as I understand the idea.

We covered all properties in the schema.org Type - we do this under an open world assumptsion: we don't know what is useful to all of our stakeholders, so we're exhaustive. I recommend that CDIF do the same.

That being said, we'll also offer the minimal recommended version of the graph, with far fewer properties. This again would be a good idea for CDIF.

As time goes on, and metadata becomes richer, I anticipate that more content from the exhaustive pattern will end up in the minimal one.

pbuttigieg commented 8 months ago

I ran through the JSON files in the https://github.com/Cross-Domain-Interoperability-Framework/cdif-core/tree/1-import-core-odis-patterns-specifications/json-ld/schema folder from the PR, and I'd suggest that some more curation is needed-- there are repeated files, not all the json files seem to be in the subdirectory where they belong. It's not obvious what is a 'specification', ''template' or 'example'. I've generated a refactor of the content (PR #3) that's a start towards what I'd propose as a repo structure for a 'CDIF-core' set of recommendations/guidance. The CDIF workgroup needs to discuss and make decisions about how to manage these kind of recommendations, in parallel with the documents that WG's are generating (e.g. Discoverability )

I think this will be cleaned up as we split the PR into its components - thanks for catching this.