2. Projekte

HinweisÜberblick

Dauer: ca. 20 min Input, 15 min Übungen

Frage: Wie lege ich ein Projekt an, ändere es und archiviere es?

Lernziele:

  • Ein Projekt anlegen
  • Name, Beschreibung, Sichtbarkeit und Avatar ändern
  • Ein Projekt archivieren (oder löschen)

Ein Projekt anlegen

  1. Oben rechts auf „+“ klicken und „New project/repository“ wählen.
  2. „Create blank project“ wählen.

Im Formular füllen wir aus:

  • Project name: der Name, z. B. „Forschungstagebuch“. Er lässt sich jederzeit ohne Folgen ändern.
  • Project URL: wo das Projekt liegt. Standard ist euer Benutzername, also euer persönlicher Bereich. Gehört ihr zu Gruppen, könnt ihr auch eine Gruppe wählen.
  • Project slug: der letzte Teil der Webadresse. Er wird aus dem Namen vorgeschlagen.
WarnungProject URL und Slug

Das sind die einzigen Felder, deren spätere Änderung Probleme machen kann. Sie bestimmen die Adresse des Projekts, und Links oder Lesezeichen können danach ins Leere führen.

  • Visibility Level: die Sichtbarkeit. Wir wählen „Private“.
HinweisSichtbarkeit
  • Private: nur Mitglieder sehen das Projekt.
  • Internal: alle, die auf der Instanz angemeldet sind. Auf gitlab.com gibt es diese Stufe nicht, weil sich dort ja jede:r anmelden kann.
  • Public: alle, auch ohne Login.

Instanzen können Stufen abschalten. Viele Einrichtungen sperren zum Beispiel „Public“, damit nichts versehentlich im ganzen Internet landet.

  • Initialize repository with a README: Hier entfernen wir den Haken. Die README legen wir in Episode 3 selbst an.
HinweisAuf anderen Instanzen: ohne Web IDE

Manche Instanzen haben die Web IDE abgeschaltet. Dann lasst den Haken bei „Initialize repository with a README“ drin. So hat das Projekt von Anfang an eine Datei, die ihr in Episode 3 mit dem Einzeldatei-Editor bearbeiten könnt.

HinweisWas ist eine README?

Die README beschreibt das Projekt: was drin ist, wie man es nutzt, wie man mitmacht und unter welcher Lizenz es steht. Meist ist sie in Markdown geschrieben (Endung .md). GitLab zeigt sie formatiert auf der Startseite des Projekts an.

Weitere Felder ignorieren wir und klicken auf „Create project“.

Die Projektseite

  • Links steht die Seitenleiste des Projekts mit Bereichen wie Manage, Plan, Code, Build, Deploy und Settings. Man muss nicht alles kennen. Wir nutzen vor allem „Manage“, „Plan“, „Code“ und „Settings“.
  • In der Mitte steht bei einem leeren Projekt der Hinweis, dass das Repository leer ist, mit Buttons zum Hinzufügen von Dateien. Sobald es Dateien gibt, erscheinen hier die Dateiliste und darunter die README.
  • Oben rechts sind die Buttons Star, Fork und das Aktionsmenü (⋮).
TippÜbung: Projekt einstellen (5 min)

Öffnet links Settings → General.

  1. Setzt die Beschreibung auf „Mein Forschungstagebuch, eine Sammlung von Markdown-Dateien“.
  2. Ändert außerdem Name, Avatar oder Sichtbarkeit.
  3. Klickt auf „Save changes“.

Die Beschreibung erscheint in Listen und unter dem Projektnamen.

HinweisMarkdown

Markdown ist eine Auszeichnungssprache. Man schreibt normalen Text mit ein paar Zeichen, etwa # für Überschriften oder * für Listen, und GitLab zeigt ihn formatiert an. Markdown funktioniert in GitLab nicht nur in Dateien, sondern auch in vielen Textfeldern, zum Beispiel in Issues und Kommentaren.

Ein Projekt archivieren

Am Ende seines Lebens wird ein Projekt archiviert oder gelöscht. Wir schauen uns das nur an.

  1. Auf der Projektseite oben rechts das Aktionsmenü (⋮) öffnen.
  2. Dort stehen „Archive“ und „Delete“.

Archivieren löscht nichts. Das Projekt wird schreibgeschützt: alles bleibt erhalten, aber nichts lässt sich mehr ändern. Es erscheint auch nicht mehr unter den aktiven Projekten. Gerade bei Forschungsprojekten ist Archivieren meist besser als Löschen.

Löschen geht in zwei Schritten. Nach dem ersten „Delete“ ist das Projekt „pending deletion“, also zur Löschung vorgemerkt. Über das Aktionsmenü holt man es mit „Restore“ zurück. Endgültig weg ist es erst nach einer Frist oder nach „Delete permanently“.

Warnung

Archiviert euer Projekt jetzt nicht! Wir arbeiten den ganzen Kurs damit.

HinweisAuf anderen Instanzen

In älteren GitLab-Versionen liegen Archivieren und Löschen unter Settings → General → Advanced, mit roten Buttons.

Kernaussagen

  • Ein Projekt braucht nur ein paar Klicks und einen Namen.
  • Name und Beschreibung kann man später ohne Folgen ändern, URL und Slug besser nicht.
  • Projekte sind privat, intern oder öffentlich.
  • Projekte kann man archivieren (und löschen, sollte es aber oft nicht).