Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • work-in-progress
2 results
Blame Permalink
de_help.md 15.42 KiB 
layout: page
title: Hilfe
permalink: /hilfe/
ref: help
lang: de

Hier finden Sie erste Hilfe zur Benutzung von JLU GitLab, aber diese kann die offizielle Nutzerhilfe (auf Englisch){:target="_blank"} nicht ersetzen. Für spezifische Informationen zu JLU GitLab, siehe Informationen.

Inhalt {#toc}

Notwendige Begriffe {#essential_terms}

Git und GitLab sind vielschichtige Werkzeuge mit vielen technischen Konzepten und Begriffen. Da deren Entwicklung und Namensschöpfung auf Englisch stattfindet, sind diese bisher nur teilweise in andere Sprachen übersetzt worden. Um die weiteren Hilfestellungen (z.B. bezüglich Lese- und Schreibzugriff) kurz und verständlich zu halten, werden hier die wichtigsten Begriffe allgemeinverständlich erklärt. Dies ist nur eine gutgemeinte Übersicht; unter weitere Hilfe ist eine Sammlung von Links um sich mit diesen Konzepten vertraut zu machen.

Git-Begriffe {#terms_git}

  • Git{:target="_blank"} ist der Name einer Software für Versionskontrolle von Dateien.
  • Ein Repository bezeichnet eine Sammlung von Dateien, deren Bearbeitungsverlauf in Schnappschüssen versioniert wird. Mit Git kann man beliebig viele unterschiedliche Repositories verwalten.
  • Ein Commit ist ein Schnappschuss der Daten im Repository. Beim Erstellen eines Commits werden die eingestellte Email-Adresse, der Name, das Datum, die Uhrzeit und ein beliebiges Kommentar untrennbar mit den Daten der neuen Version verbunden. Dies ist eine grundlegende Sicherheitsvorkehrung von Git, um nachträgliche Änderungen dieses Schnappschusses zu verhindern. Lesen Sie hier, wie sie diese privaten Einstellungen ändern können.
  • Ein Branch ist ein benannter Teilverlauf von Schnappschüssen um die Übersichtlichkeit eines Repository zu wahren.
  • Mit den Git-Kommandos pull und push werden Branches von Git-Repositories an unterschiedlichen Orten synchronisiert (wie etwa dem eigenen Computer und JLU GitLab). Sobald zwei Repositories synchronisiert wurden, beinhalten beide alle Daten, d.h. den gesamten Verlauf von Schnappschüssen.

GitLab-Begriffe {#terms_gitlab}

  • Ein Projekt auf (JLU) GitLab enthält ein Git-Repository, und bietet viele zusätzliche Funktionen für dessen Verwaltung. Zusätzlich bietet GitLab mehrere Systeme um Quellcode eines Projekts automatisch auszuführen, z.B. um Tests laufen zu lassen oder eine Webseite zu erstellen.
  • Jedes Projekt ist einem Namensraum zugeordnet. Alle Nutzenden und -gruppen haben jeweils einen eigenen Namensraum. Der Lese- und Schreibzugriff eines Projekts hängt ab von dessen Sichtbarkeit und der eigenen Rolle als Projektmitglied, bzw. der Sichtbarkeit und der Rolle in der Nutzergruppe der es zugeordnet ist.
  • Mit einem Merge-Request kann man anfragen, einen oder mehrere Commits von einem Git-Repository in ein anderes zu übernehmen.

Wie benutzt man GitLab? {#how_to_gitlab}

TODO: Viele Kleinigkeiten mit Browser möglich, für umfangreichere Arbeit aber Git lokal installieren.

TODO: Hinweis auf Git-GUIs (vielleicht mit Empfehlung)?

TODO: Hinweis auf Git-Funktionen in Matlab und anderen IDEs?

Erste Schritte {#first_steps}

TODO: Grobe Übersicht, links auf gute Ressourcen zum Weiterlernen (siehe unten).

TODO: Wo man die Sprache einstellt.

TODO: Link zur Führung in GitLab (oder gibt es die nur in EE?).

Sichtbarkeit von Projekten {#project_visibility}

Jedes Projekt hat eine Sichtbarkeits-Einstellung als entweder private, internal oder public. Die Sichtbarkeit kann nur vom Owner des Projekts geändert werden (siehe Nutzerrollen unten).

  • Projekte mit Sichtbarkeit private sind nur für die Mitglieder des Projekts einsehbar.
  • Projekte mit Sichtbarkeit internal sind für alle Personen mit einem Nutzungskonto einsehbar, die eingeloggt sind.
  • Projekte mit Sichtbarkeit public sind auch für alle Personen einsehbar, die kein Nutzungskonto haben.

Bitte lesen Sie hier, was die Sichtbarkeitsstufen internal und public im Fall von JLU GitLab bedeuten. Für mehr Details lesen Sie bitte die offizielle Dokumentation (auf Englisch){:target="_blank"}.

Nutzerrollen in Projekten {#project_roles}

Wenn Sie andere Nutzende als Projektmitglied hinzufügen wollen, müssen Sie diesen auch eine bestimmte Rolle zuweisen: Sie können zwischen Guest, Reporter, Developer, Maintainer oder Owner auswählen. Jede dieser Rollen umfasst mehr Berechtigungen als die vorherige, siehe auch in der offiziellen Dokumentation (auf Englisch){:target="_blank"}.

Berechtigungen als Guest {#project_guest}

Die Guest-Rolle ist für nicht-aktive Mitglieder die einige Inhalte lesen, und Tickets öffnen und kommentieren können.

Projektmitglieder in der Guest-Rolle können das Projekt herunterladen, Kommentare einbringen, Projektdateien ansehen und Git-pullen, Wikiseiten ansehen, neue Tickets erstellen, verwandte Tickets ansehen, vertrauliche Tickets erstellen, und selbsterstellte vertrauliche Tickets ansehen. Wenn Öffentliche Pipelines in den Projekteinstellungen > CI/CD aktiviert ist, können sie zusätzlich eine Liste der Jobs anschauen, ein Job-Protokoll ansehen, und Job-Artefakte durchsehen und herunterladen.

Berechtigungen als Reporter {#project_reporter}

Die Reporter-Rolle ist für Mitglieder die mehr Einblick bekommen und im Ticketsystem arbeiten können. Projektmitglieder mit der Reporter-Rolle habe folgende zusätzliche Berechtigungen im Vergleich zur Guest-Rolle:

Im Ticketsystem können Reporter Tickets zuweisen und mit Labels versehen, Kommentare sperren, und die Ticketliste und Labels verwalten. Reporter können außerdem Codeausschnitte speichern, den Status eines Commits einsehen, die Container Registry ansehen, Umgebungen ansehen, eine Liste von Merge-Requests ansehen, Projekt-Statistiken ansehen, und die Error-Tracking-Liste ansehen.

Berechtigungen als Developer {#project_developer}

Die Developer-Rolle ist für Projektmitglieder die direkt beitragen, und allen nötigen Zugriff haben um eine Idee umzusetzen, solange etwas nicht explizit beschränkt wurde (z.B. durch Branch-Protection). Projektmitglieder mit der Developer-Rolle haben die folgenden zusätzlichen Berechtigungen im Vergleich zur Reporter-Rolle:

Im Git-Repository können Developer neue Branches anlegen, und auf nicht-schreibgeschützte Branches pushen, oder diese löschen. Sie können neue Merge-Requests anlegen, bestehende verwalten/akzeptieren, sie anderen zuweisen und mit Labels versehen, und deren Kommentarverlauf sperren. Sie können neue Umgebungen anlegen und diese stoppen. Zusätzlich können Developer Jobs abbrechen und neustarten, und den Commit-Status anlegen oder aktualisieren. Sie können die Container-Registry aktualisieren, oder ein Image in der Container-Registry löschen. Im Ticketsystem können sie Meilensteine anlegen, bearbeiten, und löschen, und Label hinzufügen. Sie können Änderungsvorschläge annehmen, Wikiseiten anlegen und bearbeiten, und Git-Tags überschreiben/löschen.

Berechtigungen als Maintainer {#project_maintainer}

Die Rolle Maintainer ist für Personen die ein Projekt und dessen Mitglieder verwalten. Projektmitglieder in der Maintainer-Rolle bekommen die folgenden zusätzlichen Berechtigungen im Vergliech zur Developer-Rolle:

Maintainer können neue Projektmitglieder hinzufügen, Umgebungs-Terminals verwenden, Branch-Schreibschutz ein/ausschalten, auf schreibgeschützte Branches pushen, den Schreibschutz für push durch Developer an/ausschalten, Schreibschutz von Tags an/ausschalten. Maintainer können die Projekteinstellungen bearbeiten, Deploy-Schlüssel zu dem Projekt hinzufügen, und Projekt-Hooks konfigurieren. Sie können Runners verwalten, Job-Trigger verwalten, und Umgebungs-Variablen verwalten. Falls GitLab Pages aktiviert ist, können sie diese verwalten und löschen, und deren Domains und Zertifikate verwalten. Sie können Cluster verwalten, Kommentare von beliebigen Nutzenden bearbeiten, das Error Tracking verwalten, und Wikiseiten löschen.

Berechtigungen als Owner {#project_owner}

Nutzende in der Owner-Rolle kontrollieren alle Aspekte eines Projekts, inklusive dessen Löschung. In persönlichen Projekten (im Namensraum eines/einer Nutzenden) hat ausschließlich diese Person die Owner-Rolle. In Gruppen-Projekten (im Namensraum einer Gruppe) kann es mehrere Owner geben, sofern mehrere Gruppenmitglieder die Gruppenrolle Owner innehaben. Projektmitglieder in der Owner-Rolle haben die folgenden zusätzlichen Berechtigungen im Vergleich zur Maintainer-Rolle:

Owner können die Sichtbarkeitsstufe des Projekts ändern, das Projekt in einen anderen Namensraum transferieren, das Projekt löschen, Tickets löschen, und Benachrichtigungs-Emails ausschalten.

Nutzergruppen {#group}

Alle Nutzenden könnten Gruppen anlegen um mehrere Projekte und Personen zu organisieren. Beachten Sie, dass Daten die Sie zu Gruppenprojekten beitragen nicht gelöscht werden wenn Sie die Universität verlassen oder ihr Nutzungskonto löschen, solange die Gruppe aktive Mitglieder enthält.

Die Zugriffsrechte eines Projekts im Namensraum einer Gruppe hängt von der Sichtbarkeit und den Rollen der Gruppe ab. Außerdem können individuelle Nutzende auch von außerhalb der Gruppe als Projektmitglied zu individuellen Gruppenprojekten hinzugefügt werden.

Sichtbarkeit von Gruppen {#group_visibility}

Wie die Sichtbarkeit von Projekten kann die Sichtbarkeit von Gruppen auf 1) private, 2) internal oder 3) public gesetzt werden, um den Zugriff entweder 1) nur explizit ausgewählten Mitgliedern zu gewähren, oder 2) allen eingeloggten Nutzenden, oder 3) allen Personen, inklusive solchen ohne Nutzungskonto. Bitte lesen Sie hier, was die Sichtbarkeitsstufen internal und public im Fall von JLU GitLab bedeuten.

Nutzerrollen in Gruppen {#group_roles}

Wenn Sie Nutzende als Gruppenmitglieder hinzugefügen, müssen Sie ihnen auch eine Gruppenrolle zuordnen: Wie die Nutzerrollen in Projekten können Sie wählen zwischen Guest, Reporter, Developer, Maintainer oder Owner. Die Gruppenrolle eines Mitglieds setzt die Berechtigungen der gleichnamigen Projekt-Rolle für alle Gruppenprojekte. Zusätzlich kann die Projekt-Rolle eines Mitglieds individuell pro Projekt angepasst werden.

Jede Gruppenrolle kommt mit zusätzlichen Berechtigungen innerhalb der Gruppe selbst, siehe auch in der offiziellen Dokumentation (auf Englisch){:target="_blank"}:

Guests können eine Gruppe nur einsehen, nichts verändern.

Reporter können zusätzlich die Gruppen-Label verwalten.

Developer können zusätzlich Projekte in der Gruppe anlegen, und können Meilensteine der Gruppe anlegen/ändern/löschen.

Maintainer können zusätzlich Untergruppen anlegen.

Owners können zusätzlich die Gruppeneinstellungen ändern, Gruppenmitglieder verwalten, die Gruppe löschen, die Audit Events der Gruppe einsehen, und Benachrichtigungs-Emails ausschalten.

Einstellungen die private Informationen betreffen {#settings_privacy}

TODO: Beschreibung der Einstellungen von Commit-Namen und -Emailadresse (in GitLab und lokal), Profil und Aktivitäten unsichtbar machen, ...

Letzte Schritte {#last_steps}

Bevor Sie die Universität verlassen oder Ihr Nutzungskonto löschen, können Sie einige Optionen bedenken um ihre Daten zu behalten, oder sie anderen Nutzenden zu übertragen, denn alle persönlichen Projekte werden mitsamt ihrem Konto gelöscht.

Zuerst werden Sie alle wichtigen Repositories von JLU GitLab auf Ihren Computer synchronisieren wollen, um Datenverluste zu verhindern.

Um das Löschen eines persönlichen Projekts im eigenen Namensraum zu verhindern, können Sie es in den Namensraum einer anderen Person oder Gruppe transferieren.

Sie können Projekte außerdem exportieren; dies erlaubt Ihnen, (nahezu) alle zugehörigen Daten auf eine andere GitLab-Instanz zu übersiedeln. Im Unterschied zum bloßen Synchronisieren der Git-Repositories schließt dies auch die Ticketsystem, Wiki, usw. mit ein.

Wie kann ich mein Nutzungskonto löschen? {#deletion_account}

Sie können Ihr Nutzungskonto jederzeit löschen, indem Sie Einstellungen > Konto > Konto löschen in ihrem Browser öffnen und mit ihrem Passwort bestätigen.

Bitte lesen Sie die Übersicht welche Daten gelöscht werden bevor Sie Ihr Konto löschen; Sie könnten ein paar letzte Schritte bedenken, um möglichen Ärgernissen auszuweichen.

Beachten Sie, dass Sie ihr Konto nicht sofort löschen können, falls Sie die einzige Person mit Owner-Rolle in einer Gruppe sind. In diesem Fall müssen Sie mindestens ein anderes Mitglied als Owner einstellen, oder die betreffende Gruppe löschen (z.B. falls Sie das einzige Mitglied sind).

Weitere Hilfe {#more_help}

TODO: Mehr nützliche Links, evtl. in Kategorien; GitLab selbst hat noch eine Menge.