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

#94 Unify examples #100

Merged
merged 10 commits into from
Jul 11, 2023
Merged

#94 Unify examples #100

merged 10 commits into from
Jul 11, 2023

Conversation

anatoly-scherbakov
Copy link
Contributor

@anatoly-scherbakov anatoly-scherbakov commented May 4, 2023

What is done here?

  • Comparison table of JSON vs YAML: Added new block — "Features"
  • All examples now tell us about the specification itself
  • Section about Comments from the FAQ moved to the dedicated section of the spec
  • .yaml extension added
  • Fragment Identifiers section moved to the Addendum about the Extended Profile.

A few fragments of the spec were transcribed into YAML-LD files as examples:

  • Comparison of JSON vs YAML,
  • List of namespace prefixes,
  • Description of the specification itself based on schema.org vocabulary.

Preview | Diff

@anatoly-scherbakov anatoly-scherbakov self-assigned this May 4, 2023
@anatoly-scherbakov anatoly-scherbakov changed the base branch from main to issue-97-converter May 4, 2023 18:11
Base automatically changed from issue-97-converter to main June 7, 2023 19:01
@anatoly-scherbakov
Copy link
Contributor Author

@TallTed 🖖

spec/index.html Outdated Show resolved Hide resolved
<dd>
<ul>
<li><code>.yaml</code></li>
<li><code>.yamlld</code></li>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ioggstream what do you think of this include of .yaml extension?

@@ -1214,9 +1160,9 @@ <h2>Best Practices</h2>

<aside class="example" title="Convenience Context">
<p>Code of the <a>convenience context</a>. Available as:
<a href="https://yaml-ld.dev/context">https://yaml-ld.dev/context</a>.
<a href="https://github.com/json-ld/convenience-context">https://github.com/json-ld/convenience-context</a>.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: replace with json-ld.github.io/…

Where is the context, in fact?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be at https://json-ld.org/contexts/yaml-ld.jsonld or similar.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have submitted a PR to json-ld.org for that.

@anatoly-scherbakov
Copy link
Contributor Author

TODO

  • schema.org/ — slash is unnecessary

@TallTed
Copy link
Contributor

TallTed commented Jun 29, 2023

  • schema.org/ — slash is unnecessary

This needs more context, to know whether the above is accurate or not.

@anatoly-scherbakov
Copy link
Contributor Author

@TallTed here is the change: #104

@anatoly-scherbakov anatoly-scherbakov merged commit e3b1a09 into main Jul 11, 2023
@anatoly-scherbakov anatoly-scherbakov deleted the issue-94-examples branch July 11, 2023 20:56
@anatoly-scherbakov anatoly-scherbakov restored the issue-94-examples branch July 12, 2023 15:47
@TallTed
Copy link
Contributor

TallTed commented Jul 12, 2023

Please change this PR title from #94 Unify examples to Unify examples (for issue #94), to reduce confusion when viewing PR/issue lists.

@anatoly-scherbakov anatoly-scherbakov deleted the issue-94-examples branch July 13, 2023 14:56
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

Successfully merging this pull request may close these issues.

3 participants