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

Best Practice 2 and 3 not specific to YAML-LD #72

Open
ioggstream opened this issue Aug 5, 2022 · 7 comments
Open

Best Practice 2 and 3 not specific to YAML-LD #72

ioggstream opened this issue Aug 5, 2022 · 7 comments
Labels
spec Issue on specification

Comments

@ioggstream
Copy link
Contributor

ioggstream commented Aug 5, 2022

Question

BP2
While this is reasonable, I think it's not specific to YAML-LD and not related to YAML, and is thus off-topic.

Do not force users to author contexts
Instead, provide pre-built contexts that the user can reference by URL for a majority of common use cases

Best Practice 3: Use a default context

This is not specific to YAML-LD, and is thus off-topic.

@ioggstream ioggstream changed the title Best Practice 2 not specific to YAML-LD Best Practice 2 and 3 not specific to YAML-LD Aug 5, 2022
@gkellogg
Copy link
Member

gkellogg commented Aug 5, 2022

I agree that these are not specific to YAML-LD, and it is the author who chooses to use a context, not typically the end user (except for the case of re-compating/framing). These can be folded in to the general concepts of BP1, which is a living document.

@anatoly-scherbakov
Copy link
Contributor

My idea in writing those is the following. If someone writes a JSON-LD document manually (for whatever reason), they probably know what the standard is — and do not have any issues with writing their own @context.

In my mind, YAML-LD is a way to include domain experts, students, professionals who are not IT people at all. They might not be interested in diving into the technological intricacies of writing contexts.

And even the IT people might find it nice if the system knows what context to use and doesn't bother them with that copy-paste file per file.

Hence the proposed recommendation.

@ioggstream
Copy link
Contributor Author

@anatoly-scherbakov I think it's worth discussing the above points in a dedicated document providing considerations about context independently on the serialization format.

@anatoly-scherbakov
Copy link
Contributor

@ioggstream do you mean moving them into JSON-LD Best Practices document?

@ioggstream
Copy link
Contributor Author

Yes, something unrelated to YAML and instead, related to how managing contexts in different kinds of ecosystems.

@anatoly-scherbakov
Copy link
Contributor

I am not sure how related it is to JSON-LD... In fact, if a JSON-LD document is published on the web or if JSON-LD messages are sent from one subsystem to another in a distributed software infrastructure, — then I'd say most likely these documents will contain a @context reference.

WDYT?

@gkellogg gkellogg added the spec Issue on specification label Aug 17, 2022
@gkellogg
Copy link
Member

Given a new push towards creating a YAML-LD Best Practices as a separate document, I suggest we create a new repository: https://github.com/json-ld/yaml-ld-bp which we can set up with PR-preview, which makes it much easier to see the effect of PRs on the state of the document.

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

No branches or pull requests

3 participants