Documentation of our activities

[aalbino2]

Conclusions from TF meeting on Area A homepage, see also the dedicated Documentation repo: https://github.com/FAIRmat-NFDI/AreaA-Documentation and github Pages website: https://fairmat-nfdi.github.io/AreaA-Documentation/

Area A homepage

Idea/concept:

The idea is to have an internet page where we can present what we do in Area A within FAIRmat:

• what are we currently working on,
• what have we already achieved,
• what do we plan to do,
• showcasing examples of Area A schemas,
• how to collaborate with us
• ?

FAIRmat homepage:

Area F+G are working on a new FAIRmat homepage which will host a sub-page for each area. They are happy to receive our input/needs/ideas for the Area page. Sebastian will update them after our meeting.

Main page:

• Title:
• side bar: important links to FAIRmat NOMAD etc
• description: what is Area A --> highlight box, from project proposal Martin
• what are the different tasks --> from project proposal --> Martin
• each task gets an own sub page --> each task will write a summary
• link to NOMAD and FAIRmat --> sidebar
• link to Github as our working space and where you can find example schemas
• news, updates, current activities, events only if it is not on FAIRmat page
• How to collaborate with Area A, how to get connected with us
• ???

Research data management

• NOMAD Oasis --> example of our implementation
  • link to NOMAD Oasis page
  • why NOMAD OAsis
• data schema --> most imnportant section
  • why schema
  • schema examples
  • our concept of synthesis schema
  • how to write a schema?
  • data revision
  • adopt to our synthesis schema concept
• helpful tools to get to structured data: --> to help people undestand/reproduce what we do
  • yaml format
  • editor software
  • useful examples

general Stuff

• max 2 screens per page
• style sheet by area F+G
• when is the new FAIRmat homepage available? --> probably end of this year
• Florian will be responsible for the technical stuff, build a sceleton
• github repo: link from Readme to github page, and link from github page to repo
• tidy up current github repo --> update add readme --> Andrea
• new repo: Area_A_sample_preparation
  • from docs
• raise issues in the repo for any content

Collaboration and cooperation with Area A --> link to main page

• how can interested people collaborate with us?
  • contact information
• what is the typical procedure?

Publications

• articles, talks, etc.

Specific tasks to accomplish:

• [ ] description on main page: what is Area A doing? a highlight box, maybe a shortened text from project proposal --> Martin
• [ ] find a good title for the main page
• [x] Write short description for each Area A task shortened text from project proposal
• [ ] NOMAD Oasis --> example of our implementation
• [ ] why nomad oasis -ple understand/re [ ] what is aschema; why schema; schema examples; our concept of synthesis schema; how to write a schema?; data revision; adopt to our synthesis schema concept --> Andrea
• [ ] hel people understand/reproduce what we do. yaml format; editor software; useful examples; other tools/formats/things? --> Sebastian, Tamas, Andrea

[aalbino2]

I started putting some video to help users to instantiate entries and use the ELN, so far you find it in MOVPE_STO and MBE_SiGe

I will keep updating the README file in the future pointing to these videos,

tell me if you think it is okay.

At some point these videos and stuff will converge in the documentation

[hampusnasstrom]

I started putting some video to help users to instantiate entries and use the ELN, so far you find it in MOVPE_STO and MBE_SiGe

I will keep updating the README file in the future pointing to these videos,

tell me if you think it is okay.

At some point these videos and stuff will converge in the documentation

I think videos a great idea! We should probably consider hosting them somewhere else (FAIRmat youtube?) though as they are not version controlled well by git and maybe a bit big for github.