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

Case study: name #5

Open
mslw opened this issue Nov 27, 2023 · 1 comment
Open

Case study: name #5

mslw opened this issue Nov 27, 2023 · 1 comment

Comments

@mslw
Copy link
Contributor

mslw commented Nov 27, 2023

This is a question about providing "generic" descriptions for slots that come from external sources and are reused by several classes.

We are using a name slot (property), with slot_uri: schema:name on several classes (Dataset, DataController, and Author, see generated docs), with different definitions ("Identifies the dataset uniquely..." vs "The full name of the responsible entity"... vs. "The full name of the author").

This is modelled in yaml as a slot with just the URI:

slots:
  name:
    slot_uri: schema:name

and each class listing it in slots and defining description in slot_usage.

This means that we do not define any description for the name slot, see generated docs: name but also the slot table in the docs home page.

Should we:

  • add a generic description, like "name of something or someone"
  • use the definition from https://schema.org/name, since that's the URI we use ("The name of the item")
    • how to acknowledge reuse, to satisfy the CC-BY-SA license of schema.org (see schema FAQ)
    • e.g. linkml has created_by property that can be used (not included in default doc page template)
  • have no generic description for name, define it only per-class
@mslw
Copy link
Contributor Author

mslw commented Dec 14, 2023

A snapshot from a whiteboard discussion, to refresh our memories:

PXL_20231213_134731378

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant