From 2bb9883451e0fe6836b4867fde195c96c2b7cfeb Mon Sep 17 00:00:00 2001 From: Daniel Jettka <daniel.jettka@uni-hamburg.de> Date: Thu, 18 Feb 2021 15:27:15 +0100 Subject: [PATCH] minor changes in documentation --- LAMA-German/LAMA _de.md | 8 ++++---- README.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/LAMA-German/LAMA _de.md b/LAMA-German/LAMA _de.md index bfb278d..43fdb98 100644 --- a/LAMA-German/LAMA _de.md +++ b/LAMA-German/LAMA _de.md @@ -10,7 +10,7 @@ Vor Beginn der Arbeit an den Daten muss zunächst sichergestellt werden, dass Nu Um das zu überprüfen, kann die folgende Option verwendet werden: *@4) Die aktuelle Konfiguration ansehen.@* -Der Nutzername sollte das Muster *@Vorname Nachname@* haben und die Email-Adresse sollte die Email-Adresse sein *@name@mailserver.de@*. +Der Nutzername sollte das Muster *@Vorname Nachname@* haben und die Email-Adresse sollte eine gültige Email-Adresse mit dem Muster *@name@mailserver.de@* sein. ## Die Konfiguration aendern (5) @@ -23,7 +23,7 @@ Bevor man anfängt, an den Dateien zu arbeiten, muss sichergestellt werden, dass Die Dateien können per Auswahl der folgenden Option aktualisiert werden: *@2) Lokales Repository auf den neuesten Stand bringen.@*. -Hierbei wird zunächst sichergestellt, dass sich keine im Änderungsmodus befindlichen Dateien im lokalen Repository befinden und dann werden die Dateien mit der letzten öffentlichen Version aktualisiert. +Hierbei wird zunächst sichergestellt, dass sich keine im Änderungsmodus befindlichen Dateien im lokalen Repository befinden, und dann werden die Dateien mit der letzten öffentlichen Version aktualisiert. Wenn es noch unveröffentlichte lokale Änderungen gibt, werden keine Dateien aktualisiert. Um zu sehen, welche Änderungen genau noch vorliegen, wählt man die Option *@1) Aktuellen Stand des lokalen Repository anschauen.@*. @@ -47,10 +47,10 @@ Um die Nachricht zu bestätigen und mit der Ausführung des Skripts fortzufahren Wenn die Eingabe von :wq nicht klappt, nachdem man ESC gedrückt hat, drückt man stattdessen auf die Taste i und gibt dann :wq ein und drückt ENTER. -Falls zwei Personen gleichezeitig an einem Teil der gleichen Datei gearbeitet haben, kann dieses zu einem Konflikt führen, den Git nicht automatisch auflösen kann. +Falls zwei Personen gleichzeitig an einem Teil der gleichen Datei gearbeitet haben, kann dieses zu einem Merge-Konflikt führen, den Git nicht automatisch auflösen kann. Wenn es hierzu kommt, wird in LAMA eine entsprechende Nachricht angezeigt und eine Datei names ZEITSTEMPEL-git-conflict.txt im bearbeiteten Ordner angelegt. Solche Arten von Konflikten müssen manuell gelöst werden, entweder von einem Verantwortlichen für das Korpus oder vom technischen Team. In jedem Fall sollte eine/r von beiden kontaktiert werden, um das weitere Vorgehen zu besprechen. -Die Daten sind währenddessen weiterhin gesichert und eine Lösung ist in dem meisten Fällen schnell gefunden.) +Die Daten sind währenddessen weiterhin gesichert und eine Lösung ist in den meisten Fällen schnell gefunden. ## Weiter arbeiten mit den Dateien und Änderungen speichern, Commit Message hinzufügen, Änderungen im Haupt-Repository veröffentlichen und lokales Git Repository aktualisieren diff --git a/README.md b/README.md index bb09e0a..469bbdc 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ for linguists/non-tech collaborators. LAMA (= Linguistic Automation Management Assistent) was created in the project [INEL](https://inel.corpora.uni-hamburg.de) to simplify and error-proof using [git](git-scm.com) for linguists/non-tech people. -While it is a very basic shell script, it was created after lots of experience of teaching non-tech people git with available GUIs as well as spending time fixing problems because of that. +While technically it is a quite basic shell script, it was cretaed with lots of experience of teaching non-tech people using git with available GUIs as well as spending time fixing problems because of that. Therefore, on the one hand it is restricted to the most basic functionality needed for the every-day work with git, on the other hand it goes beyond git in providing the possibility to integrate processing steps to enhance data quality and for instance reduce the risk and frequency of git merge issues. The script is intended for people that do not want to learn specific git commands while still being able to collaborate with other git users on projects, especially in a setup where there are technical git maintainers and other collaborators. -- GitLab