search

earthcubearchitecture-project418 / p418Docs

Documentation on Project 418. Includes publishing guideline, example JSON-LD, and presentations about the project.
7 stars 2 forks source link

updates to repository markup #7

Open smrgeoinfo opened 6 years ago

smrgeoinfo commented 6 years ago

type as [service, organization]. The links are in potentialAction key, not availableChannel. There doesn't seem to be any benefit of using availableChannel, and it adds more levels of nesting in the docs.

ashepherd commented 6 years ago

Hi @smrgeoinfo, the benefit of using the Service class over just the Action class is that not all services offered by a repository are machine actionable which is what the Action class was built for. An example of this would be a data submission process that starts with an email or phone call: 

{
            "@type": "ServiceChannel",
            "availableLanguage": "en-US",
            "servicePhone": "508-289-2439",
            "serviceUrl": "mailto:info@bco-dmo.org",
            "providesService": {
                "@type": "Service",
                "additionalType": "gdx:SubmissionService",
                "name": "Submit Data to BCO-DMO",
                "description": "Submit data to BCO-DMO"
            }
        }

I think the Service class affords more flexibility to situations we might not be able to anticipate. But I'm happy to accept the merge if that how you want to represent your repos. The big idea here is self-publishing for repos. Our docs here are just a guide.

smrgeoinfo commented 6 years ago

Thanks for the clarification, it makes sense. Since we're typing as organization and service, there could be potentialActions for machine actionable affordances, and serviceChannels for non-machine actionable offerings. The concern about different repos using different conventions is that the search aggregators might behave differently for different repos then--less interoperability.

ashepherd commented 6 years ago

most definitely! these issues could be researched and hardened with community input in a follow-on project by the next set of unfortunate souls :)

On Jan 17, 2018, at 4:53 PM, Stephen Richard notifications@github.com wrote:

Thanks for the clarification, it makes sense. Since we're typing as organization and service, there could be potentialActions for machine actionable affordances, and serviceChannels for non-machine actionable offerings.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/earthcubearchitecture-project418/p418Docs/pull/7#issuecomment-358460156, or mute the thread https://github.com/notifications/unsubscribe-auth/ACBPyLkXyHxmc-4nUz93LFvpYuZydVywks5tLmvGgaJpZM4Rh2kz.

smrgeoinfo commented 6 years ago

UPdates to xslt for DataCitexml to sdo JSON-LD