learningtapestry / metadataregistry

DEPRECATED - THIS CODE BASE IS NO LONGER MAINTAINED. Metadata Registry
Apache License 2.0
7 stars 5 forks source link

Provide paradata schemas in json-ld/schema.org #13

Closed science closed 8 years ago

science commented 8 years ago

LR 1.0 paradata is using JSON schemas based on activitystrea.ms. Probably we should provide alternative schemas based on json-ld/schema.org. Activitystrea.ms 2.0 is using JSON-LD: https://www.w3.org/TR/activitystreams-core/ - Probably we just need to provide a specific structure for handling our aggregate data elements.

Reference to LR 1.0 paradata: https://docs.google.com/document/d/19ZkVpxQn1O1dLhCZClkQkzvypziBI7gBytszTxgXmX0/edit?hl=en_US#heading=h.to4n0dgvtvb7

Examples/quick start for LR 1.0 paradata: http://learningregistry.org/wp-content/uploads/2013/06/ParadataTwenty.pdf

science commented 8 years ago

From Adam Blum:

science commented 8 years ago

Note: "Resource Ratings" and "Resource Reviews" might be 100% activitystreams format - no adaptation required.. If so, just cite the appropriate format and put it in json-schema

science commented 8 years ago

@joehobson suggests that we also need a statement that includes a "second object." Such as:

joehobson commented 8 years ago

This doc has a variety of examples that may be helpful: https://docs.google.com/document/d/19ZkVpxQn1O1dLhCZClkQkzvypziBI7gBytszTxgXmX0/edit?pref=2&pli=1#heading=h.to4n0dgvtvb7

Some of the statements modeled in that doc include the "second object" that @science mentions above, and sometimes also a "context" for where the activity took place (since you may not want to infer that the activity happened on the platform of the publisher of the paradata).

Examples:

See the full doc for many, many more examples.

RonDrabkin commented 8 years ago

We had thought to limit it for now. Perhaps keep it a four elements suggested by Adam+ a comment field that could be used for other context. Limiting the number of elements would make it easier to get various companies to agree to use it. But, we would like Steve/Joe/James to make the final decision/spec.

adamblum commented 8 years ago

The attributes I mentioned were those that were discussed at DoE GoOpen meeting. Basically concentrating purely on hits/usage/ratings/reviews and not on "compositional usage" (resource is used in some wider context) for now

andersoncardoso commented 8 years ago

In case anyone wants to review, the proposed changes to be compliant with activitystreams 2.0 are here https://github.com/learningtapestry/metadataregistry/blob/paradata/docs/paradata.md and the corresponding json-schema https://github.com/learningtapestry/metadataregistry/blob/paradata/app/schemas/paradata.json.erb

andersoncardoso commented 8 years ago

I'm marking this as closed since we have both the spec and a working implementation. But if anyone else thinks we should add/change anything, let me know. tks

RonDrabkin commented 8 years ago

I'm getting a 404 on the links from Anderson above (maybe I don't have access?) But a couple of questions on the spec: -for the resource consumed count, does it count if say, a video is played for just a couple of seconds? or does it need to be watched to the end? If not decided, I'd suggest the event be on hitting play -note that catalogs have both embedded resources and resources that are linked. For linked resources there is probably not a way of capturing if they are consumed or not.

andersoncardoso commented 8 years ago

Hello @RonDrabkin ,

these links were from a feature-branch I've merged already (that's why the 404s). The correct ones are:

https://github.com/learningtapestry/metadataregistry/blob/master/docs/04_paradata.md

https://github.com/learningtapestry/metadataregistry/blob/master/app/schemas/paradata/schema.json.erb