Tools for collaboration

Size: px

Start display at page:

Download "Tools for collaboration"

Vivian Skinner
6 years ago
Views:

1 Tools for collaboration Decoda meeting 4 November 2015

2 Outline Redmine Repositories (version control) GIT for paper writing 2 / 27

3 Overview Redmine Repositories (version control) GIT for paper writing 2 / 27

4 Some facts Open-source project management platform Web-based interface Developed since 2006 Many developers from France (main developer: Jean-Philippe Lang) Now has a GIPSA installation 3 / 27

5 GIPSA-lab Redmine installation Address: https is important! 4 / 27

6 Main features Projects, which can contain subprojects Projects are public or private Each project/subproject contains Wiki pages News Issue tracker Activity report / notifications Repositories 5 / 27

7 Main features Projects, which can contain subprojects Projects are public or private Each project/subproject contains Wiki pages News Issue tracker Activity report / notifications Repositories Go to 5 / 27

8 Projects and subproject Main project (DECODA, public) created by SI (service informatique) Subprojects can be created by the users with Manager rights Subprojects (private) can be accessed by different people 6 / 27

9 Documents (Fichiers) Just a tool for sharing files. 7 / 27

10 Wiki Page(s) with special formatting Uses Textile and WikiNG (lists, tables, etc.) Supports L A TEXsyntax Images can be added Supports multiple pages Contains history of changes 8 / 27

11 News Just news 9 / 27

12 Issues (Demandes) Initially designed for reporting bugs (for example, support/issues) Can open/closed/assigned to a person Users can comment on issues Can be used to manage tasks (for example, nuclear-norm-matrix-completion/issues) You can select people who will be notified 10 / 27

13 Activity/notifications You receive notifications by about issues You can watch Wiki pages (should be fixed soon by the SI) Notifications about mentions of people. Settings for notifications in your profile A summary of activity: for the whole project, for sub-projects... decoda/activity 11 / 27

14 Repositories Probably the main thing in Redmine! 12 / 27

15 Overview Redmine Repositories (version control) GIT for paper writing 12 / 27

16 An example: collaborative working on a file Suppose, you are working on a file paper.tex Typical collaboration workflow: Exchange files by /dropbox One person can edit at a time Name versions of the file: paper 01.tex, paper 02.tex, paper final.tex, paper final v01.tex, paper final v01 corrections.tex,... Problems appear when you have N people 13 / 27

17 What if you have a set of files? For example, set of MATLAB functions: algebraicfit.m geometricfit.m multpolynomials.m quasihankel.m... Collaboration workflow: Exchange files by ? Versioning? What if we want to work simultaneously on different files 14 / 27

18 Repository: a single user example Repository: an organized collection of snapshots of directory A jargon: working copy: set of your files commit/changeset: a saved snapshot of your files to commit: create a snapshot of your data 15 / 27

set of your files commit/changeset: a saved snapshot of your

19 Repository: a single user example Repository: an organized collection of snapshots of directory A jargon: working copy: set of your files commit/changeset: a saved snapshot of your files to commit: create a snapshot of your data Show an example 15 / 27

20 Version control systems: multiple users Generation 2: centralized VCS (like Subversion, or SVN) Generation 3: decentralized VCS (like GIT) 16 / 27

21 One central repository Subversion (SVN) + Only linear history is allowed: easy to start Needs a central server Rigid structure 17 / 27

22 Distributed VCS (GIT) Local repositories + remote repositories + Acyclic directed graph of changes: very flexible + Local commits (history can be stored locally) Too many features, steep learning curve 18 / 27

23 Distributed VCS (GIT) Initially, command line program Included in the MacOS developer tools (and in Linux by default) Has many graphic user interfaces (GUIs) Many servers for hosting GIT repositories GitHub many features, but paid private repositories Bitbucket, Gitlab free private repositories Now there is a GIPSA server, integrated with Redmine 19 / 27

24 Distributed VCS (GIT) Initially, command line program Included in the MacOS developer tools (and in Linux by default) Has many graphic user interfaces (GUIs) Many servers for hosting GIT repositories GitHub many features, but paid private repositories Bitbucket, Gitlab free private repositories Now there is a GIPSA server, integrated with Redmine Show an example of changes + GIPSA server 19 / 27

25 Resolving conflicts in one file: merging If changes in different files: no problem 20 / 27

26 Resolving conflicts in one file: merging If changes in different files: no problem If changes in one file? 20 / 27

27 Resolving conflicts in one file: merging If changes in different files: no problem If changes in one file? 3-way merge 20 / 27

28 An example of 3-way merge An illustration: 21 / 27

29 An example of 3-way merge An illustration: Show a real-life example. 21 / 27

30 Manual conflict resolution Just edit the text file use GUI (for example, kdiff3) 22 / 27

31 Version control systems: usage A backup/synchronization tool Almost a must for code Now a standard way to distribute code: (the concept of rolling beta version) An example: 23 / 27

32 Version control systems: usage A backup/synchronization tool Almost a must for code Now a standard way to distribute code: (the concept of rolling beta version) An example: A possible way of collaborative paper writing 23 / 27

33 Overview Redmine Repositories (version control) GIT for paper writing 23 / 27

34 Collaborative paper writing Success story: HoTT book 40 mathematicians collaborating on Homotopy type theory They use GIT (public GitHub repository) 24 / 27

35 Personal experience I use it since 2013 for papers (since 2009 for software) Of course, private repositories 25 / 27

36 Personal experience I use it since 2013 for papers (since 2009 for software) Of course, private repositories Examples: IEEE TSP JstatSoft LVA-ICA paper Nuclear norm 25 / 27

37 Other collaborative paper writing software Mostly paid services: TexPad app in Mac Authorea ShareLatex can be installed on own server, based on GIT inside Why should we pay for that? 26 / 27

38 References A basic introduction into VCS: edu/~mernst/advice/version-control.html An overview of SVN and GIT A detailed book on GIT Collaborative paper writing tools: collaborative-paper-writing-in-latex/, With GIT: Collaborative_Writing_of_LaTeX_Documents Pierre Pignede is working on Redmine for CHESS maybe we can ask for his help 27 / 27

Getting started with GitHub

Getting started with GitHub A beginner s guide. (There s no code in this slide deck!) Presented by Quinn Supplee https://github.com/quinns What is GitHub? GitHub is a code hosting platform for version