Seiten online bearbeiten¶
Kleinere Ergänzungen und Fehlerkorrekturen können Sie (fast) selbständig durchführen, anstatt uns nur auf diese hinzuweisen. Sie können einzelne Seiten direkt im Web-Interface des Git-Servers bearbeiten und uns die Änderung zur Übernahme vorschlagen. Hierfür gibt es am Ende jeder Seite nach der Auflistung der Autoren einen Link »[Ihr Name ...]«, der Sie direkt zu einem Formular führt, in dem Sie die gerade betrachtete Seite selbständig bearbeiten können.
Vorbedingungen¶
Leider ist es doch nicht ganz so einfach, denn zuerst müssen ein paar Voraussetzungen erfüllt werden.
Wie auf der vorigen Seite beschrieben, müssen Sie im Browser auf der Webseite des Git-Servers angemeldet sein, um überhaupt Zugriff auf die Seite zu bekommen.
Darüber hinaus benötigen Sie jedoch auch Schreibrechte im Repositorium selbst, ohne die Ihnen der Server die Seite nicht im Bearbeitungsmodus zeigt.1 Bevor Sie also zum ersten Mal eine Seite bearbeiten können, müssen wir Ihnen also den entsprechenden Zugang einrichten. Bitte schreiben Sie eine entsprechende Mail an e-learning@mh-freiburg.de und verraten uns den Benutzernamen Ihres Hochschulaccounts (natürlich nicht das Passwort!), damit wir das Nötige veranlassen können. Keine Angst, damit können Sie noch nichts falsch machen ...
Bearbeiten¶
Der Seiteneditor auf dem Webserver stellt ein einfaches Textverarbeitungsfenster zur Verfügung.
Die Texte sind in einfachem Markdown (siehe vorige Seite) als Textdateien geschrieben, und der Editor bietet lediglich einige Komfortfunktionen an. Beispielsweise stellt er Textformatierungen schematisch durch Schriftgröße, Fettdruck oder Einfärbung dar. Die Formatierungselemente in der Werkzeugleiste funktionieren nicht genauso, wie Sie es aus Textverarbeitungen gewohnt sind, sondern fügen letztlich nur Formatierungszeichen in die reine Textdatei ein.
Wenn Sie mit der Formatierung und Textanordnung unsicher sind, dann versuchen Sie einfach, sich an dem zu orientieren, was bereits vorhanden ist. Sie können beruhigt sein: Sie werden einen Änderungsvorschlag einreichen, und wir können alle möglichen Fehler in der Kodierung nachträglich korrigieren.
Überprüfen¶
Der Editor hat drei Registerblätter: »Datei bearbeiten«, »Vorschau« und »Vorschau der Änderungen«. Im Reiter »Vorschau« sehen Sie die Datei in einem formatierten Rendering, das in etwa dem auf der fertigen Webseite entspricht.
Wichtiger ist allerdings der Reiter »Vorschau der Änderungen«, in dem Sie vor Abschluss der Bearbeitung noch einmal überprüfen können, welche konkreten Änderungen Sie in der Datei vorgenommen haben:
Änderungen vorschlagen¶
Wenn Sie mit Ihren Änderungen zufrieden sind (und sie möglichst auf der Unterseite »Vorschau« überprüft haben), können Sie die Änderungen vorschlagen - im Fachjargon heißt das, die »Änderungen committen«. Hierzu gibt es am unteren Ende des Editors einige Eingabefelder.
Beschreibung der Änderung - »Commit Message«¶
Ähnlich wie schon beim Issue-Tracker gibt es ein Feld für einen Titel und eines für die Beschreibung der Änderung. Wenn Sie diese leer lassen, füllt der Server automatisch die hellgrau vorgegebenen Standardtexte ein. Was Sie an dieser Stelle angeben, liefert aber erstens die Grundlage für die Begutachtung Ihres Änderungsvorschlages und wird zweitens dauerhaft in der »Versionsgeschichte« der GLAREAN-Anleitungen gespeichert. Bitte füllen Sie die Felder also möglichst gewissenhaft aus.
Die Titelzeile soll 50 Zeichen möglichst nicht überschreiten - eine technische Sache, die für Sie keine inhaltliche Bedeutung zu haben scheint. Bitte versuchen Sie einfach, sich daran zu halten und in dem knappen Raum eine möglichst prägnante Charakterisierung Ihres Änderungsvorschlages unterzubringen.
Beispiel: 50 Zeichen
Wenn Sie mit Ihren Änderungen zufrieden sind (und
Die Zeilen der Beschreibung sollen 80 Zeichen nicht überschreiten. Anders als bei Änderungen an den Dateien selbst können wir das nicht nachträglich korrigieren, und daher bitten wir Sie, eigenständig »harte« Zeilenumbrüche zu verwenden, obwohl das Textfeld dies in keiner Weise nahelegt oder gar erfordert.
Beispiel: 80 Zeichen
Ähnlich wie schon beim Issue-Tracker gibt es ein Feld für einen Titel und eines
Vorschlag abschließen¶
Wenn Ihnen wie in dem Screenshot die Wahl gegeben wird, »direkt in den Branch master« einzuchecken oder einen »neuen Branch« zu erstellen und einen »Pull Request« zu starten, wählen Sie bitte die letztere Option. Die Möglichkeit, den neuen »Branch« umzubenennen, brauchen Sie nicht zu nutzen. Der Text auf dem grünen Button heißt (nun) »Dateiänderung vorschlagen«, und sie können ihn nun klicken.
Ähnlich wie bei der Bestellung in einem Online-Shop kommen sie aber noch einmal auf eine letzte Seite zur Überprüfung Ihres Vorschlags.
Fast alle Teile dieser Darstellung sind sehr technisch und eigentlich für Softwareentwickler gedacht. Sie brauchen - und sollen - sich davon nicht irritieren lassen auch auch nichts »einzustellen«. Wenn Sie mögen, können Sie im unteren Teil der Seite Ihre Änderungen noch einmal im Detail zeilenweise überprüfen.
Am Ende drücken Sie einfach noch den grünen Knopf »Neuer Pull Request«, und damit ist die Sache für Sie erst einmal erledigt.
Weiteres Vorgehen¶
Wir werden per Mail über Ihren Vorschlag informiert und überprüfen ihn inhaltlich und formal-technisch. Sollten wir Rückfragen oder Wünsche haben, werden wir diese im Web-Interface hinterlegen, und Sie erhalten eine Benachrichtigung per Mail.
Wenn alle Fragen ausgeräumt sind, werden wir die Änderungen integrieren (»mergen«) und die Webseite aktualisieren. Dies geschieht weitgehend automatisch, so dass Ihre Änderung zeitnah online gestellt wird, aber Sie können sie nicht in Eigenregie veröffentlichen.
-
Anders als z.B. bei GitHub ist es bei der Hochschulinstallation leider nicht möglich, automatisch eine persönliche Kopie des Repositoriums zu erzeugen und die Seite in diesem zu bearbeiten. ↩