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

Update files to 0.4.0 plus some cleanup #8

Merged
merged 5 commits into from
Oct 22, 2024
Merged

Conversation

samleeflang
Copy link

@samleeflang samleeflang commented Oct 16, 2024

Updates the documentation pages based on the 0.4.0 version of openDS on https://schemas.dissco.tech

Contains the feedback from the Public Review

Copy link

@southeo southeo left a comment

Choose a reason for hiding this comment

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

only a few things!! 🔥

ods:,MachineAnnotationService,Machine Annotation Service,A machine agent which will perform an action on the Digital Object potentially resulting in a new annotation on the object,,,,http://www.w3.org/2000/01/rdf-schema#Class,ods:MachineAnnotationService,True,True,MachineAnnotationService,http://rs.dissco.eu/opends/terms/,http://rs.dissco.eu/opends/terms/MachineAnnotationService,ods:MachineAnnotationService,,
schema:,schema:identifier,Identifier,Handle of the Machine Annotation Service,,,https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX| https://hdl.handle.net/20.5000.1025/JH1-C37-E7F,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,ods:MachineAnnotationService,True,False,MachineAnnotationService.identifier,http://schema.org/,http://schema.org/identifier,schema:identifier,string,
ods:,ods:fdoType,Fdo Type,The DOI to the FDO type of the object,,,https://doi.org/21.T11148/417a4f472f60f7974c12,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,ods:MachineAnnotationService,True,False,MachineAnnotationService.fdoType,http://rs.dissco.eu/opends/terms/,http://rs.dissco.eu/opends/terms/fdoType,ods:fdoType,string,
ods:,ods:status,Status,"The status of the Digital Object. A digital object can be in ods:Draft, when it is not published yet. ods:Active when it is published and the object is active and ods:Tombstone which means the object has been archived.",,,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,ods:MachineAnnotationService,False,False,MachineAnnotationService.status,http://rs.dissco.eu/opends/terms/,http://rs.dissco.eu/opends/terms/status,ods:status,string,Draft| Active| Tombstone
Copy link

Choose a reason for hiding this comment

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

The description says: " digital object can be in ods:Draft.. ods:Active...ods:tombstone..." but the enums for this term are Draft | Active | Tombstone, can you align these?

Copy link
Author

Choose a reason for hiding this comment

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

Oh yeah, we decided to remove the ods: part but I haven't fixed the description. Will do, is probably on all descriptions of this term

@@ -1,24 +1,35 @@
namespace,term_local_name,label,definition,usage,notes,examples,rdf_type,class_name,is_required,is_repeatable,compound_name,namespace_iri,term_iri,term_ns_name,datatype,enum
Copy link

Choose a reason for hiding this comment

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

as far as I could find, the usage and notes cols aren't used anywhere, maybe remove them?

Copy link
Author

Choose a reason for hiding this comment

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

hmm yeah but if I remember correctly it uses the column position somewhere so it might mess things up. Would like to keep this for now, if we switch to an ontology we could start using these things.

dcterms:,dcterms:issued,Issued,The date and time when the annotation was generated. Generated is here seen as when the object was stored/indexed. In most case this will be the annotation-processing-service. Following the ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX,,,2023-09-02T13:31:34.806Z,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,ods:Annotation,True,False,Annotation.issued,http://purl.org/dc/terms/,http://purl.org/dc/terms/issued,dcterms:issued,string,
as:,as:generator,Generator,Object containing information on who generated the object. Generated is here seen as who stored/indexed the object. In most case this will be the annotation-processing-service. Contains an ods:Agent object.,,,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,ods:Annotation,True,False,Annotation.generator,http://www.w3.org/ns/activitystreams#,http://www.w3.org/ns/activitystreams#generator,as:generator,object,
ods:,ods:hasAggregateRating,Has Aggregate Rating,The average rating based on multiple ratings or reviews,,,,http://www.w3.org/2000/01/rdf-schema#Class,ods:Annotation,False,False,Annotation.hasAggregateRating,http://rs.dissco.eu/opends/terms/,http://rs.dissco.eu/opends/terms/hasAggregateRating,ods:hasAggregateRating,object,
schema:,schema:ratingCount,Rating Count,The count of total number of ratings,,,3,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,ods:ods:hasAggregateRating,True,False,ods:hasAggregateRating.ratingCount,http://schema.org/,http://schema.org/ratingCount,schema:ratingCount,integer,
Copy link

Choose a reason for hiding this comment

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

typo? ods:ods:hasAggregateRating

Copy link
Author

Choose a reason for hiding this comment

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

No corner case, it is a nested class that is already prefixed. Now do a check for the prefix so we don't add it twice.

Copy link

Choose a reason for hiding this comment

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

(Not on this page but related issue)

In routes.py -> line 427, you name the data mapping resource page "mapping resources" instead of "data mapping resources"

  return render_template('resources.html',
                           headerMarkdown=Markup(marked_text),
                           sssomRefMarkdown=Markup(marked_sssom),
                           pageTitle='Mapping Resources ', // Here!
                           classDiagram=class_diagram,
                           erDiagram=er_diagram,
                           title='Mapping Resources', // here too!
                           slug='data-mapping-resources'
                           )

Copy link
Author

Choose a reason for hiding this comment

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

👍

@samleeflang samleeflang requested a review from southeo October 17, 2024 12:33
Copy link

@southeo southeo left a comment

Choose a reason for hiding this comment

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

💯

@samleeflang samleeflang merged commit 02fda70 into main Oct 22, 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.

2 participants