From b91294af7d74075e4ab01031d87653006ec3a785 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leon=20Michel=20Gori=C3=9Fen?= <leon.gorissen@llt.rwth-aachen.de> Date: Thu, 23 May 2024 10:20:31 +0200 Subject: [PATCH] Docs: Update metadata page --- coscine_watchdog/coscine_app_profile.ttl | 20 ++++++-- docs/metadata.rst | 64 ++++++++++++------------ 2 files changed, 47 insertions(+), 37 deletions(-) diff --git a/coscine_watchdog/coscine_app_profile.ttl b/coscine_watchdog/coscine_app_profile.ttl index 02d12ee..58d07cd 100644 --- a/coscine_watchdog/coscine_app_profile.ttl +++ b/coscine_watchdog/coscine_app_profile.ttl @@ -6,7 +6,7 @@ @prefix sh: <http://www.w3.org/ns/shacl#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . @prefix aps: <https://purl.org/coscine/ap/> . -@prefix fwwl: <https://franka-wwl-demonstrator-iop-workstreams-ws-a3-55c043b308e72e51f.pages.git-ce.rwth-aachen.de/metadata/>. +@prefix fwwl: <https://franka-wwl-demonstrator-iop-workstreams-ws-a3-55c043b308e72e51f.pages.git-ce.rwth-aachen.de/metadata.html#>. @prefix dc: <http://purl.org/dc/elements/1.1/>. <https://purl.org/coscine/ap/27b71923-e2f5-41cd-aefd-16962a777ef0/> dcterms:created "2024-05-16"^^xsd:date ; @@ -70,7 +70,7 @@ sh:description "Enter the velocity scaling factor."@en, "Geben Sie den Geschwindigkeitsskalierungsfaktor an."@de ; sh:name "Geschwindigkeitsskalierungsfaktor"@de, "Velocity scaling factor"@en ; sh:order 6 ; - sh:path <> ; # TODO These URLs should ideally be unique and point to definitions or resources that precisely describe these specific fields. If no such URLs exist, you might need to create or find them. + sh:path fwwl: ; # TODO These URLs should ideally be unique and point to definitions or resources that precisely describe these specific fields. If no such URLs exist, you might need to create or find them. sh:datatype xsd:float ; sh:minCount 1 ; sh:minLength 1 ; @@ -78,7 +78,7 @@ sh:description "Enter the acceleration scaling factor."@en, "Geben Sie den Beschleunigungsskalierungsfaktor an."@de ; sh:name "Acceleration scaling factor"@en, "Beschleunigungsskalierungsfaktor"@de ; sh:order 7 ; - sh:path <> ; # TODO These URLs should ideally be unique and point to definitions or resources that precisely describe these specific fields. If no such URLs exist, you might need to create or find them. + sh:path fwwl: ; # TODO These URLs should ideally be unique and point to definitions or resources that precisely describe these specific fields. If no such URLs exist, you might need to create or find them. sh:datatype xsd:float ; sh:minCount 1 ; sh:minLength 1 ; @@ -86,7 +86,7 @@ sh:description "Enter the robot UUID. To get a robot UUID for your robot please use: https://www.uuidgenerator.net/api/version4"@en, "Geben Sie die Roboter UUID an. Um eine Roboter UUID für Ihren Roboter zu erhalten nutzen Sie bitte: https://www.uuidgenerator.net/api/version4"@de ; sh:name "Robot UUID"@en, "Roboter UUID"@de ; sh:order 8 ; - sh:path dc:identifier ; # Use Dublin Core Identifier for Robot UUID + sh:path fwwl: ; # Use Dublin Core Identifier for Robot UUID sh:datatype xsd:string ; sh:minCount 1 ; sh:minLength 1 ; @@ -94,10 +94,20 @@ sh:description "Enter the robot description. E.g. model and manufacturer"@en, "Geben Sie die Roboter Beschreibung an. Das kann bspw. Model und Hersteller sein."@de ; sh:name "Robot description"@en, "Roboter Beschreibung"@de ; sh:order 9 ; - sh:path <> ; # TODO These URLs should ideally be unique and point to definitions or resources that precisely describe these specific fields. If no such URLs exist, you might need to create or find them. + sh:path fwwl: ; # TODO These URLs should ideally be unique and point to definitions or resources that precisely describe these specific fields. If no such URLs exist, you might need to create or find them. sh:datatype xsd:string ; sh:minCount 1 ; sh:minLength 1 ; + ], [ + sh:description "Enter the git commit hash of the running version."@en ; + sh:description "Geben Sie den Git-Commit-Hash der laufenden Version an."@de ; + sh:name "Git Commit"@en ; + sh:name "Git-Commit"@de ; + sh:order 10 ; + sh:path fwwl: ; + sh:datatype xsd:string ; + sh:minCount 1 ; + sh:minLength 1 ] ; sh:targetClass <https://purl.org/coscine/ap/base/> . diff --git a/docs/metadata.rst b/docs/metadata.rst index 0b6ca61..72860d4 100644 --- a/docs/metadata.rst +++ b/docs/metadata.rst @@ -13,13 +13,12 @@ Robot UUID * - Vocabulary: - Custom * - URI - - - * - Label - - + - https://franka-wwl-demonstrator-iop-workstreams-ws-a3-55c043b308e72e51f.pages.git-ce.rwth-aachen.de/metadata.html#robot-uuid * - Comment - - + - A Universally Unique identfier obtained from https://www.uuidgenerator.net/api/version4 for a specific physical instance of a robot. * - Datatype - - + - string + ******** Datatype @@ -30,15 +29,13 @@ Datatype :header rows: 1 * - Vocabulary: - - + - ISO 8373 * - URI - - - * - Label - - + - https://franka-wwl-demonstrator-iop-workstreams-ws-a3-55c043b308e72e51f.pages.git-ce.rwth-aachen.de/metadata.html#datatype * - Comment - - + - This can either be ``command`` Trajectory, i.e. specified by the task program or ``attained`` Trajectory which is achieved by the robot in response to the command Trajectory. * - Datatype - - + - string ********************* Velocityscalingfactor @@ -49,15 +46,9 @@ Velocityscalingfactor :header rows: 1 * - Vocabulary: - - + - http://docs.ros.org/en/jade/api/moveit_ros_planning_interface/html/classmoveit_1_1planning__interface_1_1MoveGroup.html * - URI - - - * - Label - - - * - Comment - - - * - Datatype - - + - http://docs.ros.org/en/jade/api/moveit_ros_planning_interface/html/classmoveit_1_1planning__interface_1_1MoveGroup.html#a24f5ed1dad9e46d114c0c895b241ddc9 ************************* Accelerationscalingfactor @@ -68,15 +59,28 @@ Accelerationscalingfactor :header rows: 1 * - Vocabulary: - - + - http://docs.ros.org/en/jade/api/moveit_ros_planning_interface/html/classmoveit_1_1planning__interface_1_1MoveGroup.html * - URI - - - * - Label - - + - http://docs.ros.org/en/jade/api/moveit_ros_planning_interface/html/classmoveit_1_1planning__interface_1_1MoveGroup.html#ac82f6937c4a43690bc9fef08c42cee7e + + +***************** +Robot description +***************** + +.. list-table:: Robot description + :width: 30 70 + :header rows: 1 + + * - Vocabulary: + - Custom + * - URI + - https://franka-wwl-demonstrator-iop-workstreams-ws-a3-55c043b308e72e51f.pages.git-ce.rwth-aachen.de/metadata.html#robot-description * - Comment - - + - The robot description: model and manufacturer. * - Datatype - - + - string + ********** Git Commit @@ -87,12 +91,8 @@ Git Commit :header rows: 1 * - Vocabulary: - - + - https://git-scm.com/docs/git-commit * - URI - - - * - Label - - - * - Comment - - + - https://git-scm.com/docs/git-commit * - Datatype - - \ No newline at end of file + - string -- GitLab