User training

We want to make a user training for the sms on both the UFZ & the GFZ.

added GFZ UFZ labels

Maybe it helps to think about the topics that we could to cover:

Absolute beginner (aka catalogize your devices):

• how to add a device
• how to find a device
• how to work with measured quantities
• what are the CV entries - and how to add more
• intro into actions
• how to get a PID
• where to get help

Advanced for configs:

• distinction between devices & platforms
• how to add a configuration
• mounting & locations
• sites

Extra for group admins:

• where to add / manage groups
• archiving & restoring

Extra for content contributors:

• how to extend the wiki
• concepts & work on the SMS-CV

Interfaces (pro-level):

• SensorML
• API & apikeys
• SMS-CV api
• (build your own csv / excel / xyz importer)
• gitlab & service desk

Maybe it makes sense to follow the structure / concepts of the software carpentries workshops.

@paul.remmler Do you know those software carpentries workshops? (https://software-carpentry.org/)

They focus mostly on specific software packages (R, python, ...), but they all follow more or less a common framework about how long there are blocks to teach, about excercises etc.

At GFZ we hold those for programming languages in the past - and some former collegues also build some themselves.

I think the excercises are the most important thing for such a user training. While I think it is most interesting for the people to insert their own devices, it still could be helpful to have some excercises for them to insert all the same devices as a start (so they know what to insert in which field).

Later it could make sense to give them the task to insert some of their own devices - but they need to be asked to find some information about their devices before this user training even starts. It wouldn't be helpful if all of them to start searching for manufacturer, serial number etc. in the time of such a training.

CC: @marc.hanisch

Mh, currently I'm not ready to get jekyll running, in order to compile the example workshop that we have here https://git.gfz-potsdam.de/swc-bb/swc-templates/swc-l/software-publishing/workshop-materials

Nevertheless, what would we do? Maybe we can build more on top of the current wiki & extend that one?

What would be the very first steps for the workshop?

• some basic description
• What is it for? What can you do with it?

==> See https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/home

• Productive urls
• staging urls (as this is the sandbox)

==> Partly see https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/FirstStart Must be extended in order to point to the sandboxes.

• Where to get help?

• Explanation of the landing page

==> Currently missing in the wiki. The navbar is explained here https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/How_to_use_SMS

• Login process

==> https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/FirstStart Needs some GFZ content additionally.

• Explaination of the device search page

==> https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/Devices#search-devices

• Explanation on how to create a device (basic data)

==> Also on https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/Devices

• Demo: Add an example device (private in this case).

• Excercise: Let the users add one example themselves (with fixed data that we want them to insert).

• Excercise: Review by neighbor

• Excercise: add your own private device - with your own data (basic data)

• Explanation of contacts page

==> https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/Devices#contacts

• Demo: Add a new contact in the system & add it to the device

• Excercise: Users must add another contact to their device

• Explanation of measured quantity page ==> https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/Devices#measured-quantities

• Demo: Add measured quantities to the demo device

• Excercise: Let the users add a measured quantity to their device

• Explanation: Add custom fields

• Demo: Add custom field

• Excercise. Add a custom field to your device

• Explanation: Add an attachment

• Demo: Add an attachment & a link

• Excercise: Add an attachment & a link yourself

• Explanation to actions

• Demo: Add an generic device action

• Excercise: Add a generic device action to your device

• Intro to CV & show to add more.

==> Here we still miss some infos in the wiki.

• explanation of the visibility & basic group management ==> For UFZ also something here https://codebase.helmholtz.cloud/hub-terra/sms/service-desk/-/wikis/User_management

• Intro to PIDs

I think once we have slides for this very first part, we made a large step.

Maybe we can also work interactively here:

https://notes.desy.de/d1RVQ10oT62B-XKaf64E0g

(And we can use the presentation mode here as well).

Same VO for all participants?

TODO @nils.brinckmann & @marc.hanisch visualize workflows:

• add a device
• mount a device
• ...

I create the following pages: In our entry page ( https://notes.desy.de/d1RVQ10oT62B-XKaf64E0g ) I started a table with the script for the course. The course content itself is (or better will be) here:

https://notes.desy.de/6TyMvGfQTnqFyDYnjXHGpA#

Here I inserted all things which you wrote here in this ticket and and started sorting it out

And then I create two sites for the excercises:

https://notes.desy.de/I6i0QxXcS1-38mcC_NDY8Q https://notes.desy.de/Za0fl3TVSHWmYV4-pi96fw

(all links are also in our first page)