Studienleistungen in GitLab hochladen

Die folgende Anleitung erklärt,

• wie Sie GitLab für den Gebrauch in der Veranstaltung einrichten
• wie Sie wöchentlich Ihre Studienleistungen hochladen
• wie und wo Sie Feedback auf Ihre Arbeit erhalten
• welche Möglichkeiten der Kollaboration mit anderen Sie auf diese Weise haben

Inhalt

• Grundsätzliches zu GitLab
• Die eigene Subgroup finden
• Projekte anlegen
• Ordner anlegen
• Dateien hochladen und ersetzen
  • Dateien hochladen
  • Dateien ersetzen
• Feedback bekommen und darauf antworten
• Feedback bemerken und anzeigen

Grundsätzliches zu GitLab

GitLab ist wie GitHub eine browserbasierte Software, die dafür gedacht ist, gemeinsam an Text- und Codeprojekten zu arbeiten. Im ersten Teil der zweisemestrigen Veranstaltung Einführung in die Informationstechnik werden wir nicht alles ausreizen, was mit der Software möglich ist, sondern uns in kleinen Schritten diesen Möglichkeiten nähern.

Hinter GitLab steckt die Versionskontrollsoftware Git. Was damit wiederum möglich ist, ist Gegenstand des zweiten Semesters - für Neugierige auch früher - und spielt im folgenden noch keine Rolle.

Die Motivation, GitLab für diese Veranstaltung einzusetzen, liegt darin, dass zum einen Kenntnisse von Git, GitHub und GitLab mittlerweile vorteilhaft, wenn nicht sogar erforderlich sind. Zum anderen bietet GitLab eine hervorragende Möglichkeit, Feedback zu Texten, Code- und Markupdateien zu geben. Darum geht es in erster Linie in den folgenden Schritten.

Die eigene Subgroup finden

Für alle Teilnehmer_innen wurde ein so genannte Subgroup in GitLab eingerichtet. Sie ist der Subgroup der Veranstaltung, itbh-inf-wise201718, untergeordnet. Eine Subgroup gibt dem Owner, also dem jeweiligen Teilnehmer, volle Rechte in dieser Gruppe. Er/sie kann andere einladen, Projekte anlegen und verschiedene andere Operationen durchführen.

Die eigene Subgroup findet man am besten durch den Einstieg in die Gruppe der Veranstaltung, itbh-inf-wise201718 und anschließend durch einen Klick auf Subgroups.

Projekte anlegen

Benutzer_innen in GitLab können eine bestimmte Anzahl von Projekten anlegen, in der Regel fünf.

Im Folgenden werden Sie ein neues Projekt anlegen und ihm den Namen Studienleistungen_[Ihr Name] geben. Hier kann alles hochgeladen werden, was Sie im Laufe der kommenden Sitzungen erarbeiten.

Für das Anlegen eines Projekts starten Sie in der Subgroup Ihres Namens.

Eine Beschreibung ist optional. Achten Sie darauf, dass das Projekt Private ist, dann hat niemand außer eingeladenen Benutzer_innen Einsicht in Ihre Arbeit.

Erstellen Sie anschließend noch eine Datei README.md, in die Sie z.B. folgenden Text eintragen:

# Studienleistungen

Hier lade ich meine Studienleistungen hoch.

Wichtig! Ohne eine erste Datei werden einige entscheidende Navigationselemente Ihres Projekts nicht angezeigt.

Ordner anlegen

Sie können im Browser beliebig viele Ordner anlegen. Beachten Sie, dass dabei immer eine Datei .gitkeep entsteht. Das ist dadurch begründet, dass Git keine Ordner ohne Inhalt überwachen kann. Stören Sie sich nicht an der Datei, sie tut nichts.

Vorschlag für ein Ordnungssystem. Legen Sie zu jedem Auftrag einen neuen Ordner mit der Namenskonvention zu-[Zahl der kommenden Veranstaltung]-Mo-[JJJJ-MM-TT], also z.B. zu-[03]-Mo-2017-04-24. Darin können Sie weitere Ordner anlegen, die Sinn machen.

Dateien hochladen und ersetzen

Git funktioniert nur mit text- bzw. zeilenbasierten Dateien. Alle binären Dateien und Dateien, die in Containern verpackt sind, können mit Git nicht detailliert unterschieden werden. Was das konkret bedeutet, wird weiter unten noch erklärt.

Laden Sie daher keine Word-, LibreOffice- und PDF-Dateien hoch. Sie werden im Laufe der Veranstaltung lernen, dass es sinnvoll ist, auch Textdateien als einfachen Text anzufertigen und mit Markdown zu formatieren. Aus Markdown-Dateien können Sie anschließend Word-, LibreOffice- und PDF-Dateien erzeugen. Sogar HTML-Dateien entstehen aus Markdown.

Dateien hochladen

Navigieren Sie zunächst in das entsprechende Projekt, hier Studienleistungen, und anschließend in den Ordner, in den Sie die Dateien hochladen wollen.

Wählen Sie nun über den Button mit dem "+"-Zeichen die Option Upload file. Sie werden aufgefordert, eine oder mehrere Dateien per Drag & Drop oder durch Auswahl im Finder/Explorer hochzuladen. Den Upload können Sie nach Wunsch noch mit einer Beschreibung kennzeichnen, das ist aber nicht zwingend notwendig.

Wichtig! Laden Sie keine ZIP-Dateien hoch, da GitLab diese nicht entpackt. Ein Feedback auf Ihre Arbeit ist so nicht möglich!

Dateien ersetzen

Dateien können in GitLab auf ähnliche Weise ersetzt werden, wie sie auch hochgeladen werden. Dabei ist folgendes zu sagen und zu beachten:

• Es können keine kompletten Ordner ersetzt werden.
• Dateien können nur einzeln gelöscht werden.
• Dateien gleichen Namens können nicht durch erneuten Upload überschrieben werden, dazu ist das folgende Vorgehen notwendig.

Auch wenn das zunächst einmal unkomfortabel erscheint, ist es GitLab nicht wirklich anzulasten, denn eigentlich erfolgt der Up- und Download von Dateien und überhaupt die gesamte Kollaboration an einem Projekt auf eine andere Art und Weise, z.B. mit GitKraken oder ähnlicher Software. Wir kommen dazu im zweiten Semester.

Um eine Datei zu ersetzen, klicken Sie auf den Namen der Datei, um sie anzuzeigen. Rechts über der Datei finden Sie den Button Replace. Wenn Sie ihn klicken, folgt ein analoger Vorgang wie beim Upload von Dateien.

Feedback bekommen und darauf antworten

Wenn Sie sich fragen, warum wir den ganzen Aufwand mit GitLab betreiben und nicht weiterhin per Mail arbeiten oder gar Dateien in einer Dropbox teilen: Das Killerfeature haben Sie noch nicht gesehen! Da Git zeilen- und wortweise Änderungen verfolgen kann, lassen sich diese Zeilen detailliert kommentieren. Dadurch wird für Sie als kommende Lehrende, aber auch für das Dozententeam dieser Veranstaltung eine Form von Feedback möglich, die mit anderen Kommunikationstools wie Mail und Dropbox nicht möglich ist.

Die folgende Animation vermittelt einen Eindruck von den Möglichkeiten, über Zeilen eines Textes oder HTML-Dokuments zu diskutieren:

Feedback bemerken und anzeigen

Die Kommentare zu Dateien in einem Projekt sind über verschiedene Wege zu erreichen. Fürs Erste bekommen Sie eine Nachricht in Mattermost, wenn das Dozententeam sich Ihre Arbeit angeschaut und diese kommentiert hat.

Sie erreichen die Liste der Kommentare stets über den Klickpfad Project -> Activity -> Comments. Dann klicken Sie auf den im folgenden Screenshot markierten Bereich. Er steht für den Zeitpunkt, zu dem ein Kommentar abgegeben wurde. Wenn mehrmals dieselbe Zeichenfolge als Link untereinander steht, bedeutet das, dass es in einer Ihrer Dateien mehrere Kommentare gibt. Es reicht dann, wenn Sie einen der Links anklicken, denn anschließend werden Sie alle Kommentare finden.