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

credential repository vs repository, and definitions in _1.2 Ecosystem Overview_ vs _2. Terminology_ #1475

Closed
TallTed opened this issue Apr 11, 2024 · 6 comments
Assignees
Labels
CR1 This item was processed during CR1 editorial Purely editorial changes to the specification.

Comments

@TallTed
Copy link
Member

TallTed commented Apr 11, 2024

Originally posted by @TallTed in #1467 (comment)

We define repository but not credential repository. Bare repository is used 3 times in the text; credential repository is used 4 times. I think all occurrences of the bare repository should be changed to credential repository.

While investigating the above, I discovered that we have two competing definitions for holder (and several other things) — in 1.2 Ecosystem Overview (which I think should either point to the other section, or exactly duplicate the other definition) and 2. Terminology (which I think is meant to be authoritative).

Then, the definition of repository — "A program, such as a storage vault or personal verifiable credential wallet, that stores and protects access to holders' verifiable credentials." Can I not store a VC in a simple filesystem directory, that is on my personal storage device? I thought I could...

@msporny msporny added editorial Purely editorial changes to the specification. CR1 This item was processed during CR1 labels Apr 16, 2024
@msporny
Copy link
Member

msporny commented Apr 16, 2024

@TallTed wrote:

I think all occurrences of the bare repository should be changed to credential repository.

Agreed.

Can I not store a VC in a simple filesystem directory, that is on my personal storage device? I thought I could...

You can. I think we were presuming some functionality would have to exist for that thing (like digital signature capability), which is why we picked "program" before. Perhaps we should replace "A program" to "A location" and include "file system", "database", and/or "website" as a place that could be a credential repository?

@iherman
Copy link
Member

iherman commented May 1, 2024

The issue was discussed in a meeting on 2024-05-01

  • no resolutions were taken
View the transcript

3.2. credential repository vs repository, and definitions in 1.2 Ecosystem Overview vs 2. Terminology (issue vc-data-model#1475)

See github issue vc-data-model#1475.

Brent Zundel: Ted, could you jump on the queue and walk us through this -- and to the group, who would be willing to be assigned to make it happen?

Ted Thibodeau Jr.: One item here is a quick search and replace PR, another is rephrasing a sentence, the third is rationalizing some competing definition of things. Ecosystem and terminology do the same thing partly -- but with different definitions.
… That one I hadn't resolved at all. That's not in the comment from Manu either.

Brent Zundel: Is this something you could begin to address in a PR?

Ted Thibodeau Jr.: I don't think it needs discussion, just heads down.

Brent Zundel: Can I assign you?

Ted Thibodeau Jr.: Sure.

@TallTed
Copy link
Member Author

TallTed commented May 2, 2024

While investigating the above, I discovered that we have two competing definitions for holder (and several other things) — in 1.2 Ecosystem Overview (which I think should either point to the other section, or exactly duplicate the other definition) and 2. Terminology (which I think is meant to be authoritative).

I'm sure the definitions in 1.2 Ecosystem Overview and 2. Terminology should first be synchronized. I will address that, once I know how to handle what's below.

Then, should 1.2 Ecosystem Overview continue to hold the full wording of these definitions (which must be thenceforth kept in sync with 2. Terminology), or should there be some link from the terms used in 1.2 Ecosystem Overview to their definitions in 2. Terminology? Assuming the latter, what markup should be used in 1.2 Ecosystem Overview? (Hoping @msporny has a quick and easy answer, here.)

msporny pushed a commit that referenced this issue May 13, 2024
@msporny
Copy link
Member

msporny commented May 27, 2024

Assuming the latter, what markup should be used in 1.2 Ecosystem Overview? (Hoping @msporny has a quick and easy answer, here.)

Use the <dfn>term</dfn> syntax in Terminology and the[= term =]` syntax when using the term in Ecosystem Overview. Did that answer your question, @TallTed?

@msporny
Copy link
Member

msporny commented Jun 1, 2024

We define repository but not credential repository. Bare repository is used 3 times in the text; credential repository is used 4 times. I think all occurrences of the bare repository should be changed to credential repository.

Fixed in 29f431d.

Then, the definition of repository — "A program, such as a storage vault or personal verifiable credential wallet, that stores and protects access to holders' verifiable credentials." Can I not store a VC in a simple filesystem directory, that is on my personal storage device? I thought I could...

Fixed in 27d2761.

While investigating the above, I discovered that we have two competing definitions for holder (and several other things) — in 1.2 Ecosystem Overview (which I think should either point to the other section, or exactly duplicate the other definition) and 2. Terminology (which I think is meant to be authoritative).

Fixed in 9ecd2c1.

@msporny
Copy link
Member

msporny commented Jun 1, 2024

The first fix was done in a reviewed PR. The other two fixes were purely editorial, literally just adding uncontroversial text or moving existing text around; I just committed those two to main.

This issue has been addressed, if you disagree, please re-open the issue.

@msporny msporny closed this as completed Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR1 This item was processed during CR1 editorial Purely editorial changes to the specification.
Projects
None yet
Development

No branches or pull requests

3 participants