Changes

Jump to navigation Jump to search
4,296 bytes added ,  17:06, 15 February 2019
m
Shorter initial sentences
Line 1: Line 1:  
{{Infobox software
 
{{Infobox software
| name                  = Gitlab Community Edition
+
| name                  = Gitlab Social Sciences
 
| logo                  = wm_no_bg.svg
 
| logo                  = wm_no_bg.svg
 
| logo size              = 150px
 
| logo size              = 150px
Line 14: Line 14:  
| installed version      =  
 
| installed version      =  
 
| installed version date = <!-- {{Start date and age|YYYY|MM|DD|df=yes}} -->
 
| installed version date = <!-- {{Start date and age|YYYY|MM|DD|df=yes}} -->
| status                = Active
  −
| programming language  = Ruby
  −
| operating system      =
   
| platform              = Microsoft Windows, MacOSX, Linux
 
| platform              = Microsoft Windows, MacOSX, Linux
| size                  =
  −
| language              =
  −
| genre                  =
   
| license                = [https://en.wikipedia.org/wiki/MIT_License MIT License]
 
| license                = [https://en.wikipedia.org/wiki/MIT_License MIT License]
| website                = [http://about.gitlab.com www.gitlab.com]
+
| website                = [https://gitlab.socsci.ru.nl/ gitlab.socsci.ru.nl]
| resources              =  
+
| resources              = <!-- Infobox -->
 
   {{Infobox tsg
 
   {{Infobox tsg
 
     | child              = yes
 
     | child              = yes
 
     | downloads          = {{bulleted list
 
     | downloads          = {{bulleted list
 
         | [https://git-scm.com/downloads Git Download]
 
         | [https://git-scm.com/downloads Git Download]
         | [https://git-scm.com/download/gui/linux Git Desktop Clients]
+
         | [https://git-scm.com/downloads/guis Git Desktop Clients]
 
     }}
 
     }}
 
     | manuals            = {{bulleted list
 
     | manuals            = {{bulleted list
         | [[:File:Xkcd_git.png | Quick start guide]]
+
         | [https://git-scm.com/documentation Git] Git Documentation.
         | [http://doc.gitlab.com/ce/ Gitlab documentation]
+
         | [http://doc.gitlab.com/ce/ Gitlab Documentation]
 +
        | [https://www.youtube.com/watch?v=7p0hrpNaJ14 Video Tutorial]
 
     }}
 
     }}
 
   }}
 
   }}
 
}}
 
}}
 +
 +
The [https://gitlab.socsci.ru.nl Social Sciences GitLab server] offers [[wikipedia:Git|Git]] repository management, code reviews, issue tracking, and wikis.
 +
With the [[Mattermost Social Sciences]] you can chat with your colleagues and interact with your projects.
    
<!-- Table of Contents will be generated here -->
 
<!-- Table of Contents will be generated here -->
   −
==Features==
+
== Features ==
 
+
With GitLab you can easily manage your projects, synchronize your code between computers, or create wiki-pages for documentation.
GitLab offers git repository management, code reviews, issue tracking, activity feeds and wikis.  
+
Whether you write code or a paper, you can review, deploy, or document your project together with others.
 
+
You can create at least 50 projects, make them private or share them with your lab members, or even the entire Internet.
With Gitlab you can:
+
With [[Mattermost Social Sciences]] you can chat with your colleagues and even manage the project through chat commands.
* Create code together
  −
* Review code together
  −
* Deploy code together
  −
* Document code together
  −
 
  −
You can access the Gitlab within the campus network. From outside the campus you will need a VPN connection <ref>[http://www.ru.nl/isc/medewerkers/externe-toegang/veilige-verbinding/@965054/vpn/ Radboud University VPN Manual]</ref>.
  −
 
  −
===Requirements===
  −
* For more information about usage requirements for various operation systems you can click [http://doc.gitlab.com/ce/gitlab-basics/start-using-git.html here]
  −
 
  −
===User Login===
  −
 
  −
You can logon on the environment with your University number or student number and password.
  −
 
  −
'''https://gitlab.socsci.ru.nl'''
  −
 
  −
====External Users====
  −
 
  −
You can send a request with the following information to [mailto:c.lieu@socsci.ru.nl Chi Lieu] or contact [mailto:j.keyser@donders.ru.nl Johannes Keyser]
  −
 
  −
{| class="wikitable"
  −
| Username
  −
|-
  −
| Email adres
  −
|-
  −
| Full Name
  −
|-
  −
|}
  −
 
  −
==Configuration==
  −
 
  −
===Command Line Instructions===
     −
Git Global Setup
+
Think of GitLab as a "Facebook" around your projects.
 +
Similar services include e.g. [https://github.com GitHub.com] or [https://gitlab.com GitLab.com] (which also runs the GitLab software on their servers).
 +
In contrast to these services, GitLab Social Sciences is self-hosted on a server on the Radboud campus.
 +
That means we determine our own terms of use; for example, you can get private projects for free - on GitHub, you would have to pay.
   −
<pre style="background-color:#000; color:#fff;">
+
Note that there's another self-hosted [https://gitlab.science.ru.nl GitLab service running at the Faculty of Science].
$ git config --global user.name "username"
+
Anyone who has a "science login" can also use this service; it's running the same software - just the login page looks different.
$ git config --global user.email "email address"
  −
</pre>
      +
== Requirements ==
 +
1. A GitLab account to log in at https://gitlab.socsci.ru.nl:
 +
* Everyone from Radboud University can login (with their U-, S-, E- or F-number). Members of UMC with Z-numbers have to request external accounts, see below.
 +
* External users can ask for an account and then login with their username (switch to the "Standard" tab in the Sign-In page).
 +
2. For more than the most basic tasks, you'll also need to install [https://git-scm.com/downloads Git] on your computer.
   −
Create a new repository
+
== Login for external users ==
 +
External user accounts should be requested from a member of Radboud University.
 +
If you want to allow people without RU account to join your Mattermost team or GitLab project, please request an account by sending an email to
 +
[mailto:gitlab@socsci.ru.nl gitlab@socsci.ru.nl].
 +
Please provide the full name of the user, a requested username, and a valid email address, preferably from the university or organization the person is working at.
   −
<pre style="background-color:#000; color:#fff;">
+
''Note that with an external account, the user has to switch to the "Standard" tab on the Sign-In page.''
$ mkdir newproject
+
From GitLab's point of view, all accounts have the same rights and restrictions.
$ cd newproject
+
Once logged in, there are no further differences.
$ git init
  −
$ touch README.md
  −
$ git add README.md
  −
$ git commit -m "first commit"
  −
$ git remote add origin git@gitlab.socsci.ru.nl:username/newproject.git
  −
$ git push -u origin master
  −
</pre>
     −
Push an existing Git repository
+
== Setup, Configuration and Usage of Git clients ==
 +
For more advanced tasks, you will need a Git installed on your computer.
 +
There is excellent documentation for this available throughout the Internet, for example https://git-scm.com/documentation or https://docs.gitlab.com/ce/gitlab-basics/README.html.
 +
It would make little sense to repeat these here.
 +
There are many graphical user interfaces available for every major operating system.
 +
In addition, many development software packages (including Matlab) are aware of Git repositories and you can set them up to work with GitLab.
 +
Note that for most daily tasks, only about 5 Git operations are necessary to know about.
   −
<pre style="background-color:#000; color:#fff;">
+
== Frequently asked questions ==
$ cd existing_git_repo
  −
$ git remote add origin git@gitlab.socsci.ru.nl:username/newproject.git
  −
$ git push -u origin master
  −
</pre>
     −
*You can also create a new project within the webinterface in Gitlab.
+
=== Who has access to gitlab.socsci.ru.nl? ===
*Within the project on the webinterface you will also find the command line instructions.
+
Short answer: Anyone from Radboud University, and some people from other universities.
   −
=== Git Clients ===
+
Longer answer: All employees and students of Radboud University have access (with their U-, S-, E- or F-number).
 +
Members from Radboud UMC with Z-numbers have to request external accounts, see above.
 +
If you log in the first time, a corresponding account will be created.
 +
In addition, you can request accounts for people from other universities, for example to collaborate with them on confidential projects.
 +
See External Users above.
   −
You can find the git clients for various operating systems [https://git-scm.com/downloads here]
+
=== Who can see my project(s) within GitLab? ===
 +
Short answer: You decide for each project (if you're the project owner).
   −
=== Editor support ===
+
Longer answer: GitLab distinguishes read-access within 3 layers, and you can choose for each project individually.
 +
Each project can be either
 +
* ''private'': only you and your hand-picked users (and groups) can read it,
 +
* or ''internal'': anyone with a GitLab account can read it,
 +
* or ''public'': anyone on the Internet can read it.
 +
For more information, see https://gitlab.socsci.ru.nl/help/public_access/public_access#visibility-of-projects.
   −
==== Brackets ====
+
=== What can/should be stored on GitLab? ===
 +
Short answer: Scripts, documentation, theses, figures etc. '''No research data please!''' For research data, use https://data.donders.ru.nl/.
 +
For some niche cases, GitLab's Large File Storage (LFS) might be useful, see below.
   −
* [https://github.com/zaggino/brackets-git Git plugin]
+
Longer answer: Git and GitLab are meant primarily for smaller amounts of data (think Megabytes, not Gigabytes).
 +
Most features, like comparing versions, only really make sense with changing text-based files.
 +
Git keeps track of every change you make in its history, and thus content is never really deleted.
 +
That means Git repositories only grow larger, and even if you "delete" files, you can go back and un-delete them.
 +
That's a main feature, you get an "unlimited undo" for all kinds of files (and across different editors and computers).
   −
===Documentation===
+
Keeping an unchangeable history makes it impractical for binary data - you can't really delete them, comparing versions of them makes little sense.
 +
And potentially you later want to make the project available to more people - but maybe without sharing all data.
 +
For these reasons, please use https://data.donders.ru.nl/ for your research data.
   −
====Git Documentation====
+
In case you need certain large data files for your development, GitLab offers Large File Storage (LFS).
For Git documentation click [https://git-scm.com/documentation here]
+
Please only use this feature after careful consideration, for files that are integral to your project and for which no other data repository makes sense.
 +
Note that you need to install the LFS extension on your local machine to use this.
 +
For more documentation, please refer to https://docs.gitlab.com/ce/workflow/lfs/manage_large_binaries_with_git_lfs.html.
   −
====GitLab Documentation====
+
=== What happens to my GitLab projects when I leave? ===
For step-by-step tutorial click [http://doc.gitlab.com/ce/gitlab-basics/README.html here]
+
First, if you use Git on your computer, you will have the entire history also locally on your machine.
 +
Without a valid RU account, also your GitLab access will become inactive.
 +
If you want to retain access, you are welcome to ask for an External User account.
 +
There are currently no plans to delete any content when an account becomes inactive.
   −
====Video Tutorial====
+
=== Who decides the GitLab policies? ===
 +
Since the GitLab service is still quite new, not all policies have been fully been worked out yet.
 +
You are welcome to contribute to our Terms Of Use and shape the future of the service.
 +
We are certainly open to any suggestions, and want to make it as useful as possible for everyone.
 +
Just send an email to [mailto:gitlab@socsci.ru.nl gitlab@socsci.ru.nl].
   −
Or you can watch the following tutorial on the following youtube video.
     −
{{#ev:youtube|https://www.youtube.com/watch?v=7p0hrpNaJ14}}
+
== Troubleshooting ==
 +
For technical issues you can contact [mailto:gitlab@socsci.ru.nl gitlab@socsci.ru.nl].
   −
== Contact ==
+
=== Known issues ===
   −
For techincal issues you can contact [mailto:c.lieu@socsci.ru.nl Chi Lieu] or [mailto:e.lieffers@ru.nl Eric Lieffers (Server Administrator)]
+
* Login does not work with (some) versions of the Safari web browser. ''The only solution we know of is to use another browser, sorry for the inconvenience.''
   −
==References==
+
<!-- ==References==
{{reflist}}
+
{{reflist}} -->
    
==External Links== <!-- Optional -->
 
==External Links== <!-- Optional -->
 
*{{Official website|http://www.gitlab.com}}
 
*{{Official website|http://www.gitlab.com}}
*[https://git-scm.com/documentation Git] &nbsp;– Techincal documentation.
  −
*[http://doc.gitlab.com/ce/ Gitlab]&nbsp;– Technical documentation.
 

Navigation menu