-
Notifications
You must be signed in to change notification settings - Fork 0
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
dex draft #29
dex draft #29
Conversation
Some thoughts re label order and context. As of now, the builder uses and orders the following labels:
I have suggested the addition of Two thoughts:
What about:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the above are built, the webpage doesn't make the label names visible; this could result in a loss of context. The values for related or broader are floating-- requiring user to intuit relationship.
In line with the comment in the review, I didn't flesh out all of skos: Just prefLabel, definition, something else and then everything else goes in the same 'skos' bucket.
The reason being is I think (name, definition) is > 90% of the value and the overhead of full SKOS is too intimidating / time consuming to justify getting the <10% remaining.
If you want to add the handling for additional SKOS terms and customize their rendering, I'm very happy to support it going in (not this PR obvs).
A mistake in the description of 497b631
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally good changes, with a few exceptions:
Overall comments:
- Please keep mandatory fields before optional ones (prefLabel, definition, ... rest)
skos:related
values are not strings, they are references. Same with other skos- Some times there's triple backticks rather than single quotes. Both are valid, but we can choose one.
- Need a style guide on 'ID'
Don't know if you responded regarding help rendering for the additional skos fields?
I would love that! but perhaps we should get feedback from other team members prior to committing the work? |
I don't think there's much to be discussed until there's a solid proposal to put people to say "do you want this" |
@waalge I believe I have addressed your concerns/feedback. Would you do a final review? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some casing divergence
content/feedName.ttl
Outdated
@@ -12,4 +12,4 @@ | |||
|
|||
Each feed type will have its own naming convention. | |||
''' ; | |||
skos:related "feedID". | |||
skos:related :feedID. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use feedId
as per https://github.com/orcfax/glossary/blob/main/CONTRIBUTING.md#style-guide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for catching this! have gone back through and made consistent according to our style guide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
skos:broader "forex"; | ||
skos:related "CEX"; | ||
skos:broader :forex; | ||
skos:related :CEX; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See comment re:casing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
skos:broader "forex"; | ||
skos:related "DEX"; | ||
skos:broader :forex; | ||
skos:related :DEX; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See comment re:casing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
content/versionedFeedId.ttl
Outdated
information. | ||
|
||
It is constructed as `{{feed-id}}/{{feed-version}}` | ||
It is constructed as `{{feed-ID}}/{{feed-version}}` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strictly speaking there is no declared code convention for this section of text. Its psuedo code embedded in text. So this is not wrong. But I think its very weird to case this as it is now.
kebab case is generally all lower.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
This PR proposes 1 new term (dex) while also proposing edits to existing terms.a test pr with content for dex