#7 Use case-based document (re)organization

Currently the content is no more than what is already there on Gin Wiki. To make it filled with more hands-on information, one option is to organize it in a set of use case-based work flows.

In doing so, we need to think about:

1. More particular use cases (and its order?)
2. The format of description

For the format of description, there are several (non-exclusive) possibilities:

• Markdown-based
• Slide show-based
• Video-based

Right now, we don't know which is better, or which is easier.

For the time being, let's start by using the nice and old Markdown-based documentation.

Prerequisites

• The reader has created a Gin account.
• The reader has created a lab-repository.

Possible topics

1. Get access to your repository
   • Checking the up-to-date repository on the web
2. Fill the repository with documents
   • What is a "commit"?
   • Adding a file (e.g. a panel, a presentation)
   • Adding a group of files (e.g. manuscript)
   • Make notes directly on the repository, and what is nice about it
   • Keeping files up-to-date (version-control)
3. Keep a copy of a repository on your computer(s)
   • Concepts, how it works
   • Possible solutions, goods and bads of each
   • Connection via Charité-network

I would look into a small introduction first: why we chose to use GIN

For matthew/lab organisation:

• one place to backup all your files, available via the browser, privately.
• folder template to find stuff faster
• path to FAIR open data

For you:

• big files accepted
• upload files from different computers
• tools to synchronise your desktop copy with the server one.
• bring data, code and reports into one repository

For data curation:

• in development, with neuroscience in sight.
• publish data in one click.
• git based version control:
  • most used tech around for software and open culture (Github)
  • keep track of changes via commits with messages -> get an history of changes
    

use case: We created a repository for you, what next?

demo means we do not go into the details of the installation here, just show how the workflow goes once you have everything installed. We can add an estimate of how long it takes to install stuff, though. The point would be to show them the possibilities offered here.

1. Add files (for example, ppt file + figure before your next meeting with Matthew)

   (note: this is using VPN to HU network?)

   • Using the web browser
   • Using gin-cli (demo)
   • using Rstudio (demo)
   • using wingin (demo)

2. Download files

3. Collaborative working (this includes you on different machines)

   • intro: the power of git for collaboration
   • pull/push, history
   • using issues (+ markdown intro)

4. Charité network problem.

I moved the whole here: https://cryptpad.fr/code/#/2/code/edit/Vsxxq9ow4-qJfhD4160GpmsI/

I will be easier to work on it, there is a chat attached to it, too