Browse Source

add gin-vre discussion doc

julien colomb 1 year ago
parent
commit
665969c9d6
1 changed files with 40 additions and 0 deletions
  1. 40 0
      01_project_management/internaldiscussions/gin-vre.md

+ 40 - 0
01_project_management/internaldiscussions/gin-vre.md

@@ -0,0 +1,40 @@
+This document tries to summarise ways to interact (and alternative workflow) from the VRE to GIN.
+
+
+# Objectives: include project management for VRE projects
+
+While datasets are stored in the VRE, project managment data are/could/should be kept outside of the VRE. The use of git platforms (GitHub/GitLab and others) have proven to be extremely useful for collaborative work and team science. We would therefore like to implement or propose some workflows, so that users can use these platforms from inside the VRE itselft. 
+
+# The Why
+
+
+- Joining both datasets and project management data in one place would be valuable.
+- This would allow to pull code from git repositories to be used on VRE saved data.
+- Accessible project management files from outside the Charité network is valuable, especially for collaborations.
+- Using these tools from a Charité computer is difficult, but easy inside the VRE VM.
+
+
+
+# Technological issue.
+
+- The VRE can only reach the outside of the Charité network via http, https
+- The VRE provides virtual machines (VM, guacamole here) that allows the use of git, datalad and other applications
+
+
+# Putative solutions: 
+
+1. Using the HU GIN instance, with only https
+  - pros: our own server, same tool as for other groups in the SFB (keep overview, contact data curator via issues), template with submodules, using datalad
+  - cons: large file need to be pushed in git, or not be pushed
+  
+2. Using a Gitlab instance
+  - pros: advanced administrative possibilities, clear that gin-cli does not work, own server or external, template without submodules, 
+  - pros?: use of git-lfs.
+  - pros?: integration in VRE (internal gitlab?)
+  - cons: different tool, no easy overview possible for data curator.
+  
+# Abbreviations
+
+VRE: virtual research environment of the Charité
+VM: virtual machine, here meant for guacamole inside the VRE
+GIN: g-node infrastructure for neuroscience, gogs (git platform) extension allowing git-annex functionalities