From 9a0bf2f29efe67aa1d85123e5f0d973f23692013 Mon Sep 17 00:00:00 2001
From: Johannes Keyser <johannes.keyser@sport.uni-giessen.de>
Date: Sat, 12 Sep 2020 14:21:24 +0200
Subject: [PATCH] Refer to CC0 license, and more cleanups, see #12.
---
README.md | 7 ++--
de/Hilfe.md | 82 +++++++++++++++++----------------------------
de/Informationen.md | 22 ++++++------
de/README.md | 2 +-
en/Help.md | 48 +++++++++++++-------------
5 files changed, 72 insertions(+), 89 deletions(-)
diff --git a/README.md b/README.md
index dd716d1..d40f890 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
# JLU GitLab Support
-[Support-Seiten auf Deutsch](de)
+## [Support-Seiten auf Deutsch](de)
-[Support pages in English](en)
+## [Support pages in English](en)
+## License
+All Texts are licensed as CC0, see [LICENSE.md](LICENSE.md).
+Translations are available at https://creativecommons.org/publicdomain/zero/1.0/
diff --git a/de/Hilfe.md b/de/Hilfe.md
index 6d4371c..547961e 100644
--- a/de/Hilfe.md
+++ b/de/Hilfe.md
@@ -1,38 +1,18 @@
+# Hilfe
+
Hier finden Sie erste Hilfe zur Benutzung von JLU GitLab, aber diese kann [die offizielle Nutzerhilfe (auf Englisch)](https://gitlab.test.uni-giessen.de/help/user/index.md) nicht ersetzen.
Für spezifische Informationen zu JLU GitLab, siehe [Informationen](Informationen.md).
-<h2 id=toc>Inhalt</h2>
-
-<!-- NOTE dies ist (derzeit) nur eine manuell verwaltete Liste. -->
-- [Wichtige Konzepte](#essential_terms)
- - [Git Begriffe](#terms_git)
- - [GitLab Begriffe](#terms_gitlab)
-- [Wie benutzt man GitLab?](#how_to_gitlab)
-- [Erste Schritte](#first_steps)
-- [Sichtbarkeit von Projekten](#project_visibility)
-- [Nutzerrollen in Projekten](#project_roles)
- - [Berechtigungen als *Guest*](#project_guest)
- - [Berechtigungen als *Reporter*](#project_reporter)
- - [Berechtigungen als *Developer*](#project_developer)
- - [Berechtigungen als *Maintainer*](#project_maintainer)
- - [Berechtigungen als *Owner*](#project_owner)
-- [Nutzergruppen](#group)
- - [Sichtbarkeit von Gruppen](#group_visibility)
- - [Nutzerrollen in Gruppen](#group_roles)
-- [Einstellungen, die private Informationen betreffen](#settings_privacy)
-- [Letzte Schritte](#last_steps)
-- [Weitere Hilfe](#more_help)
-
[[_TOC_]]
-<h2 id=#essential_terms>Wichtige Konzepte</h2>
+## Wichtige Konzepte
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](#more_help) ist eine Sammlung von Links um sich mit diesen Konzepten vertraut zu machen.
+Dies ist nur eine gutgemeinte Ãœbersicht; unter [weitere Hilfe](#weitere-hilfe) ist eine Sammlung von Links um sich mit diesen Konzepten vertraut zu machen.
-<h3 id=terms_git>Git-Begriffe</h3>
+### Git-Begriffe
- [*Git*](https://de.wikipedia.org/wiki/Git) ist der Name einer Software für Versionskontrolle von Dateien.
- Ein *Repository* ist eine Sammlung von Dateien, deren Bearbeitungsverlauf in Schnappschüssen versioniert wird.
@@ -41,11 +21,11 @@ Dies ist nur eine gutgemeinte Ãœbersicht; unter [weitere Hilfe](#more_help) ist
Beim Erstellen eines Commits werden die eingestellte Email-Adresse, der Name, das Datum, die Uhrzeit und ein beliebiges Kommentar untrennbar mit dem Datei-Inhalten der neuen Version verbunden.
Dies ist eine grundlegende Sicherheitsvorkehrung von Git, um nachträgliche Änderungen dieses Schnappschusses zu verhindern.
[Lesen Sie hier](#settings_privacy), wie sie diese potentiell privaten Einstellungen ändern können.
-- Ein *Branch* ist ein benannter Teilverlauf von Schnappschüssen, um die Übersichtlichkeit eines Repository zu wahren.
-- Die Git-Befehle *pull* und *push* können Branches von Git-Repositorien auf unterschiedlichen Geräten synchronisieren (wie etwa dem eigenen Computer und JLU GitLab).
+- Ein *Branch* ist ein benannter Verlauf von Schnappschüssen, um die Übersichtlichkeit eines Repository zu wahren.
+- Die Git-Befehle `pull` und `push` können Branches von Git-Repositorien auf unterschiedlichen Geräten synchronisieren (wie etwa dem eigenen Computer und JLU GitLab).
Sobald zwei Repositorien synchronisiert wurden, beinhalten beide eine Kopie aller Daten, d.h. den gesamten Verlauf von Schnappschüssen.
-<h3 id=terms_gitlab>GitLab-Begriffe</h3>
+### GitLab-Begriffe
- Ein *Projekt* auf (JLU) GitLab enthält fast immer 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 auszuführen oder eine Webseite (wie diese) zu erstellen.
@@ -58,7 +38,7 @@ Dies ist nur eine gutgemeinte Ãœbersicht; unter [weitere Hilfe](#more_help) ist
<!--NOTE, nicht nötig?: - 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}
+## Wie benutzt man GitLab?
TODO: Viele Kleinigkeiten mit Browser möglich, für umfangreichere Arbeit aber Git lokal installieren.
@@ -67,7 +47,7 @@ TODO: Hinweis auf Git-GUIs (vielleicht mit Empfehlung)?
TODO: Hinweis auf Git-Funktionen in Matlab und anderen IDEs?
-## Erste Schritte {#first_steps}
+## Erste Schritte
TODO: Grobe Ãœbersicht, links auf gute Ressourcen zum Weiterlernen ([siehe unten](#more_help)).
@@ -76,7 +56,7 @@ TODO: Wie man die Sprache einstellt.
TODO: Link zur Führung in GitLab (oder gibt es die nur in EE?).
-## Sichtbarkeit von Projekten {#project_visibility}
+## Sichtbarkeit von Projekten
Jedes Projekt hat eine Sichtbarkeits-Einstellung als entweder *private*, *internal* oder *public*.
Die Sichtbarkeit kann nur von Nutzenden mit der *Owner*-Rolle im Projekt geändert werden (siehe Nutzerrollen [in Projekten](#project_roles) und [in Gruppen](#group_roles)).
@@ -89,7 +69,7 @@ Die Sichtbarkeit kann nur von Nutzenden mit der *Owner*-Rolle im Projekt geände
Für mehr Details lesen Sie bitte die [offizielle Dokumentation (auf Englisch)](https://gitlab.test.uni-giessen.de/help/public_access/public_access.md#public-access).
-## Nutzerrollen in Projekten {#project_roles}
+## Nutzerrollen in Projekten
Beim Hinzufügen von Projektmitgliedern müssen Sie ihnen bestimmte Rollen zuweisen:
Sie können zwischen *Guest*, *Reporter*, *Developer*, *Maintainer* oder *Owner* auswählen.
@@ -97,7 +77,7 @@ Jede dieser Rollen umfasst mehr Berechtigungen als die vorherige, siehe auch in
Für Projekte im Namensraum einer Gruppe haben die Gruppenmitglieder ihre gleichnamigen [Gruppenrolle](#group_roles) inne; z.B. ist ein *Guest* in der Gruppe auch ein *Guest* in allen Gruppenprojekten, sofern dies nicht durch individuelle Projektrollen überschrieben ist.
<!-- NOTE: Lass uns unten die Berechtigungen der GitLab.com-Verträgen STARTER, PREMIUM, ULTIMATE weglassen, die nicht Teil der Community Edition sind. -->
-### Berechtigungen als *Guest* {#project_guest}
+### Berechtigungen als *Guest*
Die *Guest*-Rolle ist für nicht-aktive Mitglieder, die einige Inhalte lesen, und Tickets öffnen und kommentieren können.
@@ -115,7 +95,7 @@ eine Liste der Jobs anschauen,
ein Job-Protokoll ansehen,
und Job-Artefakte durchsehen und herunterladen.
-### Berechtigungen als *Reporter* {#project_reporter}
+### Berechtigungen als *Reporter*
Die *Reporter*-Rolle ist für Mitglieder die mehr Einblick bekommen und im Ticketsystem walten können.
Projektmitglieder mit der *Reporter*-Rolle habe folgende zusätzliche Berechtigungen im Vergleich zur *Guest*-Rolle:
@@ -133,7 +113,7 @@ Projekt-Statistiken ansehen,
und die Error-Tracking-Liste ansehen.
<!-- NOTE: Error Tracking (keine dt. Übersetzung) ist unter Vorgängen zu finden, man muss mit mit einem Sentry-Server verbinden. -->
-### Berechtigungen als *Developer* {#project_developer}
+### Berechtigungen als *Developer*
Die *Developer*-Rolle ist für Projektmitglieder die aktiv 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:
@@ -154,7 +134,7 @@ Sie können Änderungsvorschläge annehmen,
Wikiseiten anlegen und bearbeiten, und
Git-Tags überschreiben/löschen.
-### Berechtigungen als *Maintainer* {#project_maintainer}
+### Berechtigungen als *Maintainer*
Die Rolle *Maintainer* ist für Mitglieder die ein Projekt und dessen Mitglieder verwalten.
Projektmitglieder in der *Maintainer*-Rolle bekommen die folgenden zusätzlichen Berechtigungen im Vergliech zur *Developer*-Rolle:
@@ -179,7 +159,7 @@ das Error Tracking verwalten,
und Wikiseiten löschen.
<!-- "Audit-Ereignisse ansehen": Ist nicht in der CE... -->
-### Berechtigungen als *Owner* {#project_owner}
+### Berechtigungen als *Owner*
Nutzende in der *Owner*-Rolle kontrollieren alle Aspekte eines Projekts, inklusive dessen Löschung.
In persönlichen Projekten (im Namensraum eines Nutzungskontos) hat ausschließlich diese Person die *Owner*-Rolle.
@@ -192,23 +172,23 @@ das Projekt löschen,
Tickets löschen,
und Benachrichtigungs-Emails ausschalten.
-Beachten Sie, dass nach [der Benutzungsordnung von JLU GitLab]({{ '/benutzungsordnung/' | relative_url }}) alle Nutzenden mit der *Owner*-Rolle für den Inhalt ihrer Projekte verantwortlich sind, auch wenn diese von anderen Nutzenden stammen.
+Beachten Sie, dass nach [den Nutzungsbedingungen von JLU GitLab](Nutzungsbedingungen.md) alle Nutzenden mit der *Owner*-Rolle für den Inhalt ihrer Projekte verantwortlich sind, auch wenn diese von anderen Nutzenden stammen.
-## Nutzergruppen {#group}
+## Nutzergruppen
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]({{ '/informationen/#deletion_userdata' | relative_url }}) wenn Sie [die Universität verlassen]({{ '/informationen/#leaving_JLU' | relative_url }}) oder [ihr Nutzungskonto löschen](#deletion_account), solange die [Gruppe mindestens ein Mitglied enthält]({{ '/informationen/#deletion_groups' | relative_url }}).
+Beachten Sie, dass [Daten die Sie zu Gruppenprojekten beitragen nicht gelöscht werden](Informationen.md) wenn Sie [die Universität verlassen](Informationen.md) oder [ihr Nutzungskonto löschen](#wie-kann-ich-mein-nutzungskonto-löschen), solange die [Gruppe mindestens ein Mitglied enthält](Informationen.md).
-Die Zugriffsrechte eines Projekts im Namensraum einer Gruppe hängt von der [Sichtbarkeit](#group_visibility) und den [Rollen](#group_roles) der Gruppe ab.
+Die Zugriffsrechte eines Projekts im Namensraum einer Gruppe hängt von der [Sichtbarkeit](#sichtbarkeit-von-gruppen) und den [Rollen in der Gruppe](#nutzerrollen-in-gruppen) 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}
+### Sichtbarkeit von Gruppen
[Wie die Sichtbarkeit von Projekten](#visibility_projects) 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]({{ '/informationen/#potential_users' | relative_url }}), was die Sichtbarkeitsstufen *internal* und *public* im Fall von JLU GitLab bedeuten.
-### Nutzerrollen in Gruppen {#group_roles}
+### Nutzerrollen in Gruppen
Wenn Sie Nutzende als Gruppenmitglieder hinzugefügen, müssen Sie ihnen auch eine Gruppenrolle zuordnen:
Wie die [Nutzerrollen in Projekten](#project_roles) können Sie wählen zwischen *Guest*, *Reporter*, *Developer*, *Maintainer* oder *Owner*.
@@ -233,17 +213,17 @@ die Gruppe löschen,
die Audit Events der Gruppe einsehen,
und Benachrichtigungs-Emails ausschalten.
-Beachten Sie, dass nach [der Benutzungsordnung von JLU GitLab]({{ '/terms-of-service/' | relative_url }}) alle Nutzenden mit der *Owner*-Rolle für den Inhalt ihrer Projekte verantwortlich sind, auch wenn diese von anderen Nutzenden stammen.
+Beachten Sie, dass nach den [Nutzungsbedingungen von JLU GitLab](Nutzungsbedingungen.md) alle Nutzenden mit der *Owner*-Rolle für den Inhalt ihrer Projekte verantwortlich sind, auch wenn diese von anderen Nutzenden stammen.
-## Einstellungen, die private Informationen betreffen {#settings_privacy}
+## Einstellungen, die private Informationen betreffen
TODO: Beschreibung der Einstellungen von Commit-Namen und -Emailadresse (in GitLab und lokal), Profil und Aktivitäten unsichtbar machen, ...
-## Letzte Schritte {#last_steps}
+## Letzte Schritte
-Bevor Sie [die Universität verlassen]({{ '/informationen/#leaving_JLU' | relative_url }}) oder [Ihr Nutzungskonto löschen](#deletion_account), können Sie einige Optionen bedenken um ihre Projekte zu behalten, oder sie anderen Nutzenden zu übertragen, denn beim Löschen eines Kontos werden auch [alle persönlichen Projekte mitgelöscht]({{ '/informationen/#deletion_userdata' | relative_url }}).
+Bevor Sie [die Universität verlassen](Informationen.md#was-passiert-wenn-ich-die-jlu-verlasse) oder [Ihr Nutzungskonto löschen](#deletion_account), können Sie einige Optionen bedenken um ihre Projekte zu behalten, oder sie anderen Nutzenden zu übertragen, denn beim Löschen eines Kontos werden auch [alle persönlichen Projekte mitgelöscht](Informationen.md).
Bespielsweise werden Sie alle wichtigen Git-Repositorien von JLU GitLab auf Ihren Computer synchronisieren wollen, um Datenverluste zu verhindern.
@@ -254,18 +234,18 @@ Sie können Projekte außerdem exportieren; dies erlaubt Ihnen, (nahezu) alle zu
Im Unterschied zum bloßen Synchronisieren der Git-Repositorien schließt dies auch die Ticketsystem, Wiki, usw. mit ein.
-## Wie kann ich mein Nutzungskonto löschen? {#deletion_account}
+## Wie kann ich mein Nutzungskonto löschen?
Sie können Ihr Nutzungskonto jederzeit löschen, indem Sie [*Einstellungen > Konto > Konto löschen*](https://gitlab.test.uni-giessen.de/profile/account) in ihrem Browser öffnen und mit ihrem Passwort bestätigen.
-Bevor Sie Ihr Konto löschen, lesen Sie bitte diese [Übersicht welche Daten mitgelöscht werden]({{ '/informationen/#deletion_userdata' | relative_url }});
-mit ein paar [letzten Schritten](#last_steps) könnten Sie mögliche Ärgernisse umgehen.
+Bevor Sie Ihr Konto löschen, lesen Sie bitte diese [Übersicht welche Daten mitgelöscht werden](Informationen.md);
+mit ein paar [letzten Schritten](#letzte-schritte) könnten Sie mögliche Ärgernisse umgehen.
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}
+## Weitere Hilfe
TODO: Mehr nützliche Links, evtl. in Kategorien; GitLab selbst hat noch eine Menge.
diff --git a/de/Informationen.md b/de/Informationen.md
index afc5134..abae383 100644
--- a/de/Informationen.md
+++ b/de/Informationen.md
@@ -12,7 +12,7 @@ GitLab bietet für jedes Projekt zusätzlich ein Wiki, ein Ticketsystem, und vie
JLU GitLab ist per Browser unter [https://gitlab.test.uni-giessen.de](https://gitlab.test.uni-giessen.de) erreichbar und wird auf Systemen der [Justus-Liebig-Universität (JLU) Gießen](https://www.uni-giessen.de/fbz/svc/hrz) betrieben.
Die eingesetzte GitLab Community Edition ist als freie Software lizensiert, sodass JLU GitLab technisch und juristisch von [GitLab.com](https://gitlab.com) unabhängig ist.
-JLU GitLab wird von einem [Team freiwilliger Mitarbeitenden](#maintainers) betrieben.
+JLU GitLab wird von einem [Team freiwilliger Mitarbeitenden](#wer-betreibt-jlu-gitlab) betrieben.
## Anwendungsmöglichkeiten
@@ -40,26 +40,26 @@ Dies bedeutet, dass sich Sichtbarkeitsstufe *public* von [Projekten]({{ '/hilfe/
Von außerhalb ist der Zugriff über das [VPN der Universität](https://www.uni-giessen.de/fbz/svc/hrz/svc/netz/campus/vpn) möglich.
-## Wie kann ich JLU GitLab benutzen? {#how_to_use}
+## Wie kann ich JLU GitLab benutzen?
-Information zur konkreten Benutzung von JLU GitLab finden Sie auf [Hilfe zur Benutzung]({{ '/hilfe/' | relative_url }}).
+Information zur konkreten Benutzung von JLU GitLab finden Sie auf [Hilfe zur Benutzung](Hilfe.md).
-## Auflösung des Nutzungskontos {#deletion_account}
+## Auflösung des Nutzungskontos
Nutzungskontos von JLU GitLab können auf verschiedene Weisen aufgelöst werden:
- Nutzende können jederzeit freiwillig ihr Nutzungskonto löschen.
- Falls Sie ihr Nutzungskonto löschen möchten, folgen Sie bitte [diesen Schritten]({{ '/hilfe/#deletion_account' | relative_url }}).
- Sie können auch noch ein paar [letzte Schritte]({{ '/hilfe/#last_steps' | relative_url }}) bedenken, bevor Sie Ihr Konto löschen.
-- Das Konto wird nach einer Frist von 6 Monaten gelöscht, nachdem Ihre [g- oder s-Kennung ungültig geworden ist](#deletion_account_invalid).
- Dies passiert meist dann, wenn Sie die [Universität verlassen](#leaving_JLU).
-- Die [Betreibenden](#maintainers) können ein Nutzungskonto löschen, wenn dessen Aktivitäten die [Benutzungsordnung]({{ '/benutzungsordnung/' | relative_url }}) verletzt.
+ Falls Sie ihr Nutzungskonto löschen möchten, folgen Sie bitte [diesen Schritten](Hilfe.md).
+ Sie können auch noch ein paar [letzte Schritte](Hilfe.md#letzte-schritte) bedenken, bevor Sie Ihr Konto löschen.
+- Das Konto wird nach einer Frist von 6 Monaten gelöscht, nachdem Ihre [g- oder s-Kennung ungültig geworden ist](#was-passiert-wenn-meine-g-oder-s-kennung-ungültig-wird).
+ Dies passiert meist dann, wenn Sie die [Universität verlassen](#was-passiert-wenn-ich-die-jlu-verlasse).
+- Die [Betreibenden](#wer-betreibt-jlu-gitlab) können ein Nutzungskonto löschen, wenn dessen Aktivitäten die [Nutzungsbedingungen](Nutzungsbedingungen.md) verletzt.
Unten finden Sie eine [Übersicht welche Daten mitgelöscht werden](#deletion_userdata), wenn Ihr Konto gelöscht wird.
### Was passiert, wenn ich die JLU verlasse?
-Wenn Sie die Universität verlassen (z.B. Vertragsende, Exmatrikulation), wird auch innerhalb weniger Wochen Ihre [g- oder s-Kennung ungültig](#deletion_account_invalid).
+Wenn Sie die Universität verlassen (z.B. Vertragsende, Exmatrikulation), wird auch innerhalb weniger Wochen Ihre [g- oder s-Kennung ungültig](#was-passiert-wenn-meine-g-oder-s-kennung-ungültig-wird).
Für diesen Vorgang ist das [HRZ](https://www.uni-giessen.de/fbz/svc/hrz) zuständig; bei Fragen dazu kontaktieren bitte dieses.
### Was passiert, wenn meine g- oder s-Kennung ungültig wird?
@@ -117,7 +117,7 @@ Wir arbeiten in Rücksprache mit der [JLU-internen IKM-AG](https://www.uni-giess
Wir sind immer auf der Suche nach weiteren Freiwilligen die uns unterstützen wollen.
Bitte kontaktieren Sie uns, falls Sie mehr über unsere Arbeitsweise und Entscheidungsfindung wissen möchten.
-Wir sind auf verschiedene Weisen erreichbar, siehe [Kontaktinformation](#Kontaktinformation).
+Wir sind auf verschiedene Weisen erreichbar, siehe [Kontaktinformation](#Kontakt).
## Die Ziele von JLU GitLab
diff --git a/de/README.md b/de/README.md
index 20593ab..371135f 100644
--- a/de/README.md
+++ b/de/README.md
@@ -1,7 +1,7 @@
# JLU GitLab Support
-## [Erste Hilfe](Hilfe.md)
+## [Hilfe zur Benutzung](Hilfe.md)
## [Informationen](Informationen.md)
## [Nutzungsbedingungen](Nutzungsbedingungen.md)
diff --git a/en/Help.md b/en/Help.md
index b1c256b..62afa8b 100644
--- a/en/Help.md
+++ b/en/Help.md
@@ -15,7 +15,7 @@ This is only a well-intended overview; [further help](#further-help) provides a
### Git terminology
-- [*Git*](https://en.wikipedia.org/wiki/Git){:target="_blank"} is the name of a software for version control of files.
+- [*Git*](https://en.wikipedia.org/wiki/Git) is the name of a software for version control of files.
- A *repository* is a collection of files where edits are versioned as a history of snapshots.
With Git, you can manage multiple separate repositories.
- A *commit* is one snapshot of the data in the repository.
@@ -26,7 +26,7 @@ This is only a well-intended overview; [further help](#further-help) provides a
- The Git commands *pull* and *push* can synchronize branches of Git repositories across devices (such as your own computer and JLU GitLab).
Once two repositories are synchronized, they have both a copy of all data, i.e. the full history of snapshots.
-### GitLab terminology {#terms_gitlab}
+### GitLab terminology
- A *project* on (JLU) GitLab nearly always contains a Git-Repository, and offers many additional functions for its management.
In addition, GitLab offers multiple systems to automatically execute source code within the project, e.g. to run tests or to generate a website (like this one).
@@ -39,7 +39,7 @@ This is only a well-intended overview; [further help](#further-help) provides a
<!-- NOTE, not needed?: - With a *merge request* you can ask to merge one or multiple commits from one Git repository into another one. -->
-## How to use GitLab? {#how_to_gitlab}
+## How to use GitLab?
TODO: Browser sufficient for many smaller things, for serious work you should install Git locally.
@@ -48,7 +48,7 @@ TODO: Note existence of Git GUIs (maybe including endorsement)?
TODO: Refer to Git functions within Matlab and other IDEs?
-## First steps {#first_steps}
+## First steps
TODO: Rough overview, links to good resources for learning more ([see further help below](#more_help)).
@@ -59,7 +59,7 @@ TODO: Link to guided Tour within GitLab (or is this just an EE feature?).
<!-- TODO, see issue #35 in admin repo; Insert: "Now might be a good time to consider changing your username, if you want to"? -->
-## Visibility of projects {#project_visibility}
+## Visibility of projects
Every project has a visibility setting as either *private*, *internal*, or *public*.
The visibility can only be changed by the *Owner* of the project (see [user roles below](#project_roles)).
@@ -69,18 +69,18 @@ The visibility can only be changed by the *Owner* of the project (see [user role
- Projects with *public* visibility are also visible for people without a user account.
[Please read here]({{ '/information/#potential_users' | relative_url }}) what the visibility levels *internal* and *public* mean in the case of JLU GitLab.
-For more details, please refer to the [official documentation](https://gitlab.test.uni-giessen.de/help/public_access/public_access.md#public-access){:target="_blank"}.
+For more details, please refer to the [official documentation](https://gitlab.test.uni-giessen.de/help/public_access/public_access.md#public-access).
-## User roles in projects {#project_roles}
+## User roles in projects
When adding project members you have to assign them a designated role:
You can pick either *Guest*, *Reporter*, *Developer*, *Maintainer* or *Owner*.
-Each role is associated with an increasing set of permissions, see also the [official documentation](https://gitlab.test.uni-giessen.de/help/user/permissions.md#project-members-permissions){:target="_blank"}.
+Each role is associated with an increasing set of permissions, see also the [official documentation](https://gitlab.test.uni-giessen.de/help/user/permissions.md#project-members-permissions).
For projects in the namespace of a group, the group members will get the respective [group role](#group_roles); e.g. a *Guest* in the group will also be a *Guest* in all group projects, unless it is overwritten by individual project roles.
<!-- NOTE: Let's below exclude the permissions from subscription plans STARTER, PREMIUM, ULTIMATE that are not part of the Community Edition. -->
-### Permissions as *Guest* {#project_guest}
+### Permissions as *Guest*
The *Guest* role is for not-active members who can only read some content, and open issues and leave comments.
@@ -98,7 +98,7 @@ see a list of jobs,
see a job log,
and download and browse job artifacts.
-### Permissions as *Reporter* {#project_reporter}
+### Permissions as *Reporter*
The *Reporter* role is for members who get more insights and can work in the issue tracker.
Project members with the *Reporter* role get the following permissions in addition to the *Guest* role:
@@ -117,7 +117,7 @@ view project statistics,
and view the Error Tracking list.
<!-- NOTE: The error tracking list is part of Operations (de:"Vorgänge"), and you have to integrate with a Sentry server. -->
-### Permissions as *Developer* {#project_developer}
+### Permissions as *Developer*
The *Developer* role is for members who actively contribute, and have access to everything to go from an idea to its execution, unless something has been explicitly restricted (e.g. through branch protection).
Project members with the *Developer* role get the following permissions in addition to the *Reporter* role:
@@ -138,7 +138,7 @@ They can apply code change suggestions,
create and edit wiki pages, and
rewrite/remove Git tags.
-### Permissions as *Maintainer* {#project_maintainer}
+### Permissions as *Maintainer*
The *Maintainer* role is for members who manage a project and its members.
Project members with the *Maintainer* role get the following permissions in addition to the *Developer* role:
@@ -163,7 +163,7 @@ manage Error Tracking,
and delete wiki pages.
<!-- "view project Audit Events": Not available in CE... -->
-### Permissions as *Owner* {#project_owner}
+### Permissions as *Owner*
Users with the *Owner* role control all aspects of a project, including its removal.
In personal projects (within the namespace of a user), exclusively that user has the *Owner* role.
@@ -176,10 +176,10 @@ remove the project,
delete issues,
and disable notification emails.
-Note that according to the [terms of service of JLU GitLab]({{ '/terms-of-service/' | relative_url }}), *Owners* are held responsible for all content in their projects, even it came from other users.
+Note that according to the [terms of service of JLU GitLab](TermsOfService.md), *Owners* are held responsible for all content in their projects, even it came from other users.
-## User groups {#group}
+## User groups
All users can create *groups* to organize multiple projects and people.
Note that [data you contribute to a group project will not be deleted]({{ '/information/#deletion_userdata' | relative_url }}) when you [leave the university]({{ '/information/#leaving_JLU' | relative_url }}) or [delete your account](#deletion_account), as long as the [group has at least one member]({{ '/information/#deletion_groups' | relative_url }}).
@@ -187,19 +187,19 @@ Note that [data you contribute to a group project will not be deleted]({{ '/info
The access permissions of a project within the namespace of a group depend on the group's [visibility](#group_visibility) and [user roles](#group_roles).
Additionally, individual users from outside of the group can be added as members to individual group projects.
-### Visibility of groups {#group_visibility}
+### Visibility of groups
Like the [visibility of projects](#project_visibility), the visibility of a group can be set to 1) *private*, 2) *internal*, or 3) *public* to allow access to 1) explicitly selected users, 2) all logged-in users, or 3) any person, including those without a user account.
[Please read here]({{ '/information/#potential_users' | relative_url }}) what the visibility levels *internal* and *public* mean in the case of JLU GitLab.
-### User roles in groups {#group_roles}
+### User roles in groups
If you include users as a group member, you also have to assign them a designated role:
Like the [roles for project members](#project_roles), you can pick either *Guest*, *Reporter*, *Developer*, *Maintainer* or *Owner*.
The group role of a member determines the permissions of the equivalent [project role](#project_roles) for all group projects.
In addition, the project role of a member can be adapted individually for each project.
-Each group role is associated with an increasing set of permissions about the group itself, see also the [official documentation](https://gitlab.test.uni-giessen.de/help/user/permissions.md#group-members-permissions){:target="_blank"}:
+Each group role is associated with an increasing set of permissions about the group itself, see also the [official documentation](https://gitlab.test.uni-giessen.de/help/user/permissions.md#group-members-permissions):
<!-- NOTE: Let's below exclude the permissions from subscription plans STARTER, PREMIUM, ULTIMATE that are not part of the Community Edition. -->
*Guests* can only browse the group, and not change anything.
@@ -219,12 +219,12 @@ and disable notification emails.
Note that according to the [terms of service of JLU GitLab]({{ '/terms-of-service/' | relative_url }}), *Owners* are held responsible for all content in their projects, even it came from other users.
-## Settings concerning private information {#settings_privacy}
+## Settings concerning private information
TODO: Describe setting of commit name and email address (in GitLab and locally), hiding of activity and profile, changing username?, ...
-## Last steps {#last_steps}
+## Last steps
Before you [leave the university]({{ '/information/#leaving_JLU' | relative_url }}) or [delete your account](#deletion_account), you may consider some options to keep your data, or hand it over to other users, because if your account gets deleted, also [all your personal projects will be deleted]({{ '/information/#deletion_userdata' | relative_url }}).
@@ -237,12 +237,12 @@ You could also export projects; this allows you to migrate (nearly) all their da
Unlike the mere synchronization of the Git repositories, this will include the issue trackers, wikis, etc.
-## How to delete my account? {#deletion_account}
+## How to delete my account?
You can delete your account at any time, by navigating to [*Settings > Account > Delete account*](https://gitlab.test.uni-giessen.de/profile/account) in your browser and confirm with your password.
Before you delete your account, please read this [overview what data will be deleted]({{ '/information/#deletion_userdata' | relative_url }});
-just a few [last steps](#last_steps) could spare you possible annoyances.
+just a few [last steps](#last-steps) could spare you possible annoyances.
Note that you cannot immediately delete your account if you are the only *Owner* of a group.
In this case, you must give the *Owner* role to at least one other member, or delete the group in question (e.g. if you are the only remaining member).
@@ -252,6 +252,6 @@ In this case, you must give the *Owner* role to at least one other member, or de
TODO: More useful links, maybe with explanations. GitLab itself has a bunch more.
-- [The official user help for JLU GitLab](https://gitlab.test.uni-giessen.de/help/user/index.md){:target="_blank"}.
-- [Free online book *Pro Git*](https://git-scm.com/book/){:target="_blank"}
+- [The official user help for JLU GitLab](https://gitlab.test.uni-giessen.de/help/user/index.md).
+- [Free online book *Pro Git*](https://git-scm.com/book/)
--
GitLab