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

Glossary Terms #117

Merged
merged 9 commits into from
Jan 12, 2024
Merged

Glossary Terms #117

merged 9 commits into from
Jan 12, 2024

Conversation

darrellodonnell
Copy link
Contributor

I am working to get some closure on definitions and terms that should help simplify a few things. The work is not complete, but this PR starts aims to show what needs to be done (and completes a few things).

One item that popped up as a surprise was that spec-up was added to package.json and package-lock.json. I think that is ok, but I was surprised that it wasn't already there. I suppose nobody is doing builds locally.

Signed-off-by: Darrell O'Donnell <[email protected]>
Signed-off-by: Darrell O'Donnell <[email protected]>
spec/appendix.md Outdated
### Trust Over IP Glossary - Controlled Terms

NOTE:
* The following set of identifiers are from the current [ToIP Glossary](https://docs.google.com/document/d/1fZByfuSOwszDRkE7ARQLeElSYmVznoOyJK4sxRvJpyM/edit?usp=sharing) (Google Doc). These definitions need to be moved over to the (under development) ToIP Terms tool (aka TEv2).
Copy link
Contributor

Choose a reason for hiding this comment

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

It’s not clear what definitions “need to be moved” — the ones in this spec or the ones in the ToIP Glossary. I think you mean that the “ToIP Glossary definitions are being moved to the (under development) ToIP Terms tool (aka TEv2).

Suggest you clarify.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's going to be an ongoing effort as we edit this (and other specs).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

relates to this Issue: #116

Copy link
Contributor

Choose a reason for hiding this comment

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

@darrellodonnell I believe this should be moved out into a separate issue and PR (its basically a TODO)

spec/appendix.md Outdated

NOTE:
* The following set of identifiers are from the current [ToIP Glossary](https://docs.google.com/document/d/1fZByfuSOwszDRkE7ARQLeElSYmVznoOyJK4sxRvJpyM/edit?usp=sharing) (Google Doc). These definitions need to be moved over to the (under development) ToIP Terms tool (aka TEv2).
* TODO: not all ToIP definitions are fully linked here. This whole section is more of an exemplar as of the time of writing.
Copy link
Contributor

Choose a reason for hiding this comment

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

Presumably you mean “not all the relevant ToIP definitions…”. Presumably, the ToIP Glossary is much bigger than this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

correct

Copy link
Contributor

Choose a reason for hiding this comment

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

@darrellodonnell I believe this TODO line should be removed. The addition of any other terms can be included in a future PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

noted - I have made edits to remove the NOTE as well as removed a few definitions that go too far (i.e. really belong in an external glossary). Added issue to GH as well: #121

update coming shortly

spec/appendix.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
Signed-off-by: Darrell O'Donnell <[email protected]>
Signed-off-by: Darrell O'Donnell <[email protected]>
spec/appendix.md Outdated Show resolved Hide resolved
Signed-off-by: Darrell O'Donnell <[email protected]>
Signed-off-by: Darrell O'Donnell <[email protected]>
Copy link
Contributor

@2byrds 2byrds left a comment

Choose a reason for hiding this comment

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

specup related changes should be removed.

@@ -38,6 +38,7 @@
"merge-stream": "2.0.0",
"pkg-dir": "4.2.0",
"prismjs": ">=1.24.0",
"spec-up": "^0.10.6",
Copy link
Contributor

Choose a reason for hiding this comment

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

@darrellodonnell this is what i referred to in the slack message

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed

@@ -3567,6 +3568,43 @@
"resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.11.tgz",
"integrity": "sha512-Ctl2BrFiM0X3MANYgj3CkygxhRmr9mi6xhejbdO960nF6EDJApTYpn0BQnDKlnNBULKiCN1n3w9EBkHK8ZWg+g=="
},
"node_modules/spec-up": {
Copy link
Contributor

Choose a reason for hiding this comment

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

This as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok - removed these (unnecessary) changes to package-lock.json.

Signed-off-by: Darrell O'Donnell <[email protected]>
Copy link
Contributor

@2byrds 2byrds left a comment

Choose a reason for hiding this comment

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

Remove these two tentative changes and create new issues/PRS.

spec/appendix.md Outdated
### Trust Over IP Glossary - Controlled Terms

NOTE:
* The following set of identifiers are from the current [ToIP Glossary](https://docs.google.com/document/d/1fZByfuSOwszDRkE7ARQLeElSYmVznoOyJK4sxRvJpyM/edit?usp=sharing) (Google Doc). These definitions need to be moved over to the (under development) ToIP Terms tool (aka TEv2).
Copy link
Contributor

Choose a reason for hiding this comment

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

@darrellodonnell I believe this should be moved out into a separate issue and PR (its basically a TODO)

spec/appendix.md Outdated

NOTE:
* The following set of identifiers are from the current [ToIP Glossary](https://docs.google.com/document/d/1fZByfuSOwszDRkE7ARQLeElSYmVznoOyJK4sxRvJpyM/edit?usp=sharing) (Google Doc). These definitions need to be moved over to the (under development) ToIP Terms tool (aka TEv2).
* TODO: not all ToIP definitions are fully linked here. This whole section is more of an exemplar as of the time of writing.
Copy link
Contributor

Choose a reason for hiding this comment

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

@darrellodonnell I believe this TODO line should be removed. The addition of any other terms can be included in a future PR.

Signed-off-by: Darrell O'Donnell <[email protected]>
Copy link
Contributor

@2byrds 2byrds left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you @darrellodonnell !

spec/appendix.md Outdated
~ A single attribute—typically a character string—that uniquely identifies an entity within a specific context (which may be a global context). Examples include the name of a party, the URL of an organization, or a serial number for a man-made thing. Supporting definitions: eSSIF-Lab: a character string that is being used for the identification of some entity (yet may refer to 0, 1, or more entities, depending on the context within which it is being used).

[[def: self-certifying identifier (SCID), SCID, SCIDs]]
~ A subclass of verifiable identifier ([[ref: VID]]) that is [[def: cryptographically verifiable]] without the need to rely on any [[ref: third party]] for [[ref: verification]] because the [[ref: identifier]] is cryptographically bound to the [[ref: cryptographic keys]] from which it was generated. Also known as: [[ref: autonomous identifier]].
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the [[def: crypto…] should be a a [[ref: …], correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch. Caused me to remove a few of the refs that I had removed defs for (e.g. third party, verification). change committed.

Copy link
Contributor

@swcurran swcurran left a comment

Choose a reason for hiding this comment

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

A quick tweak and this looks ready.

Signed-off-by: Darrell O'Donnell <[email protected]>
@2byrds 2byrds merged commit 1cecada into trustoverip:main Jan 12, 2024
1 check passed
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