Gitlab Social Sciences: Difference between revisions

Jump to navigation Jump to search
← Older editNewer edit →
Clarified external users
Got rid of setup, configuration, and usage of Git - instead just point to documentation.
Line 41: Line 41:
<!-- 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.
With GitLab you can easily manage your projects, synchronize your code between computers, or create wiki-pages for documentation.
Whether you write code or a paper, you can review, deploy, or document your project together with others.
Whether you write code or a paper, you can review, deploy, or document your project together with others.
Line 54: Line 54:
Anyone who has a "science login" can also use this service; it's running the same software (just the login page looks different).
Anyone who has a "science login" can also use this service; it's running the same software (just the login page looks different).


==Requirements==
== Requirements ==
1. A GitLab account to log in at https://gitlab.socsci.ru.nl:
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).
* Everyone from Radboud University can login (with their U-, S-, E- or F-number).
Line 60: Line 60:
2. For more than the most basic tasks, you'll also need to install [https://git-scm.com/downloads Git] on your computer.
2. For more than the most basic tasks, you'll also need to install [https://git-scm.com/downloads Git] on your computer.


==External Users==
== External Users ==
If you want to allow people without Radboud University account to access and contribute to your GitLab project, you can request a standard user account by sending an email to
If you want to allow people without Radboud University account to access and contribute to your GitLab project, you can request a standard user account by sending an email to
[mailto:gitlab@socsci.ru.nl gitlab@socsci.ru.nl].
[mailto:gitlab@socsci.ru.nl gitlab@socsci.ru.nl].
Line 69: Line 69:
Once logged in, there are no further differences.
Once logged in, there are no further differences.


==Configuration==
== Setup, Configuration and Usage of Git ==
 
For more advanced tasks, you will need a Git installed on your computer and set it up.
The following instructions are for the command line interface.
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.
If you are using a graphical user interface (e.g. a desktop client), please consult its documentation for further instructions.
It would make little sense to repeat these here.
 
There are many graphical user interfaces available for every major operating system.
===Global Setup===
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;">
$ git config --global user.name "your-username-here"
$ git config --global user.email "your-email-address-here"
</pre>
 
Your username will be visible when pushing a commit to the Gitlab server.
Your email address should be the same as your primary Radboud email address, or if you are an external user, the one provided in your user request.
 
==Usage==
 
The following instructions are for the command line interface. If you are using a graphical user interface (e.g. a desktop client), please consult its documentation for further instructions. When creating a new project in the [https://gitlab.socsci.ru.nl web interface], you will also be given these instructions.
 
===Creating a new repository===
<pre style="background-color:#000; color:#fff;">
$ mkdir newproject
$ cd newproject
$ git init
$ touch README.md
$ git add README.md
$ git commit -m "initial commit"
$ git remote add origin git@gitlab.socsci.ru.nl:username/newproject.git
$ git push -u origin master
</pre>
Substitute 'newproject' with your project name and 'username' with your username.
 
===Push an existing Git repository===
 
<pre style="background-color:#000; color:#fff;">
$ cd existing-git-repo
$ git remote add origin git@gitlab.socsci.ru.nl:username/newproject.git
$ git push -u origin master
</pre>
Substitute 'newproject' with your project name.


=== Troubleshoot ===
=== Troubleshoot ===
Some users will see the  following message when they want to make a remote connection with SSH. (existing repository)
Some users will see the  following message when they want to make a remote connection with SSH. (existing repository)
When you see the below message you will need to say yes.
When you see the below message you will need to say yes.
Line 123: Line 89:
Remote SSH connection should now be established.
Remote SSH connection should now be established.


For other technical issues you can contact [mailto:e.lieffers@ru.nl Eric Lieffers (Server Administrator)]
For other technical issues you can contact [mailto:gitlab@socsci.ru.nl gitlab@socsci.ru.nl].


== Git Clients ==
== Git Clients ==
Retrieved from "https://tsgdoc.socsci.ru.nl/index.php/Gitlab_Social_Sciences"