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

Add "Getting Started" section. #1111

Merged
merged 2 commits into from May 10, 2023
Merged

Add "Getting Started" section. #1111

merged 2 commits into from May 10, 2023

Conversation

msporny
Copy link
Member

@msporny msporny commented May 1, 2023

This PR adds a "Getting Started" section that highlights usage of the new default @vocab and guides developers on how to use it and then upgrade to defining a vocabulary and JSON-LD Context file.


Preview | Diff

Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

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

Suggested changes look bigger than they are. Moved a paragraph to better logical placement. Tweaked some language.

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@andresuribe87 andresuribe87 left a comment

Choose a reason for hiding this comment

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

Much needed, thanks Manu

index.html Outdated
<p>
Once a developer has prototyped their credential to a point where they believe
all of the credential properties are stable, it is advised that they generate a
vocabulary and context file for their application and publish it at a stable URL
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible to link to resources that teach developers how to generate the vocabulary and context file?

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you have a link to those resources? Unless they're exceedingly stable, we try to avoid linking to external content. For example, there is a video series I did that explains how to do this on YouTube as well as a few tutorials online to do so... however, those are on sites that may or may not stick around over the many years to decades that this specification might exist on the web (leading to broken links).

I guess we could link to the JSON-LD Specification? Would that work for you?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, linking to the json-ld spec would make sense to me.

I would love for specs to include explanatory videos in order to make them more accessible and easier to understand for folks, but that's outside of scope.

Copy link
Contributor

@dlongley dlongley left a comment

Choose a reason for hiding this comment

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

Thanks! I added a couple sentences on reusing existing work and where it can be found.

index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@OR13 OR13 left a comment

Choose a reason for hiding this comment

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

@msporny thanks for this PR, I closed the one that removes the broken links, please correct that issue in this PR as well.

@OR13
Copy link
Contributor

OR13 commented May 3, 2023

ahh, nvm I see you have already raised a separate PR for that:

As long as they are merged together, I am ok with this.

@msporny msporny requested a review from OR13 May 3, 2023 17:49
Copy link
Member

@brentzundel brentzundel left a comment

Choose a reason for hiding this comment

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

approved with Ted and Dave's suggestions.

Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Dave Longley <dlongley@digitalbazaar.com>
@msporny msporny requested a review from TallTed May 4, 2023 16:43
@msporny
Copy link
Member Author

msporny commented May 7, 2023

This PR is blocked based on a review of PR #1110 by @OR13. If @OR13 is ok w/ PR #1110, then this PR will be merged after that one is merged.

@msporny msporny merged commit c40f375 into main May 10, 2023
1 check passed
@msporny
Copy link
Member Author

msporny commented May 10, 2023

Editorial, multiple reviews, changes requested and made, no objections, merging.

@iherman
Copy link
Member

iherman commented May 11, 2023

The issue was discussed in a meeting on 2023-05-10

  • no resolutions were taken
View the transcript

1.2. update json schema to accurately reflect context defn (pr vc-data-model#1064)

See github pull request vc-data-model#1064.

Manu Sporny: continuing with other PRs: next item "update json schema to accurately reflect context definition".

Gabe Cohen: this is blocked by a PR that's now been merged, which fixed the example context, which should reserve opposition.

Michael Prorock: +1.

Orie Steele: Manu opened a PR an example context that makes it no longer return a 404.

Brent Zundel: The PR has been merged that makes it a 404.

Michael Prorock: i have approved.

Orie Steele: changing to no objection.

See github pull request vc-data-model#1111.

Gabe Cohen: can this be merged with 1111?

Michael Prorock: please!!!!

Orie Steele: can be merged this.

Michael Prorock: yes to merge this and with 1111.

Brent Zundel: 1064 should be merged? No opposition. Merge it.

Gabe Cohen: it's merged.

@iherman
Copy link
Member

iherman commented May 11, 2023

The issue was discussed in a meeting on 2023-05-10

  • no resolutions were taken
View the transcript

1.3. Add "Getting Started" section (pr vc-data-model#1111)

See github pull request vc-data-model#1111.

Manu Sporny: next is 1111 and the one that Orie wish it to merged.

Brent Zundel: Objections? None - merged.

Manu Sporny: merges 1111.

Gabe Cohen: manu: is rebase and merge our practice? I have been squashing and merging.

@msporny msporny deleted the msporny-getting-started branch July 27, 2023 21:07
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.

None yet

9 participants