Mehr Kapitel für die Anleitung

This commit is contained in:
Dietrich 2020-11-28 19:05:53 +01:00
parent 19c4e79ce1
commit da52e9239f
6 changed files with 47 additions and 5 deletions

View File

@ -0,0 +1,21 @@
# Akzeptieren von vorgeschlagenen Änderungen
Wenn die Änderungen vorgeschlagen sind, müssen sie noch korrekturgelesen werden und können dann genehmigt werden.
Hierzu geht man oben auf den Reiter(Tab) `Pull-Requests`. Dort sind die Änderungsvorschläge aufgelistet.
Um einen Vorschlag zu akzeptieren klickt man auf diesen, danach auf `Geänderte Dateien`. In diesem Abschnitt kann man alles sehen, was durch diesen Vorschlag verändert wird was gelöscht wurde ist rot, was hinzu kommt ist grün.
Jetzt sollte man alles was hier steht korrekturlesen und dann auf den grünen `überprüfen` Knopf drücken und die Prüfung `Genehmigen`, oder mit einem Kommentar was verbessert werden muss `Änderungen anfragen`.
![Screenshot](./img/anleitung_fuer_kapitel/approve.png)
Wenn zwei Mitglieder der Film AG die Änderungen Genehmigen, dann kann die Änderung online gestellt werden.
# Änderungen Online stellen
Erst wenn zwei Genehmigungen für die Änderung vorliegen, taucht der große grüne Knopf `Pull-Request zusammenführen` auf. Diesen kann man jetzt drücken, um die Änderung online zu stellen.
![Screenshot](./img/anleitung_fuer_kapitel/online-stellen.png)
Nach kurzer Zeit (weniger als 1 min.) sollte die Equipmentseite die neuen Änderungen enthalten.

View File

@ -0,0 +1,5 @@
# Wie kann man diese Anleitung ergänzen
Da diese Anleitung immer auf dem neusten Stand gehalten werden soll ist es unerlässlich, dass alle mithelfen.
In den folgenden Kapiteln wird erklärt, wie man neue Artikel erstellt, bzw. die vorhandenen ergänzt.

View File

@ -1,6 +1,4 @@
# Wie kann man diese Anleitung ergänzen
Da diese Anleitung immer auf dem neusten Stand gehalten werden soll ist es unerlässlich, dass alle mithelfen.
## Ein neues Kapitel erstellen ## Ein neues Kapitel erstellen
@ -18,6 +16,8 @@ Jetzt kann man in den `src` Ordner wechseln, in dem die Kapitel sind, und das ga
![Screenshot](./img/anleitung_fuer_kapitel/Neue_Datei.png) ![Screenshot](./img/anleitung_fuer_kapitel/Neue_Datei.png)
## Einen neuen Commit erstellen
Sie können schon jetzt den Text eingeben, Sie können aber auch erstmal die Datei abspeichern. Das System speichert jede Version und man kann auch jede Version anzeigen. Es ist schön, wenn jeder `commit` einen (kurzen) Kommentar bekommt, was geändert wurde (direkt unterder Überschrift). Ist etwas mehr Beschreibung nötig oder nützlich, kann man diese in das große Feld schreiben. Sie können schon jetzt den Text eingeben, Sie können aber auch erstmal die Datei abspeichern. Das System speichert jede Version und man kann auch jede Version anzeigen. Es ist schön, wenn jeder `commit` einen (kurzen) Kommentar bekommt, was geändert wurde (direkt unterder Überschrift). Ist etwas mehr Beschreibung nötig oder nützlich, kann man diese in das große Feld schreiben.
Zuletzt ist es noch gut, wenn ein beschreibender Name für die Veränderungen (Branch) gewählt wird. Es ist hier gut wenn dieser mit dem eigenen Benutzernamen beginnt in diesem Fall: `dietrich-` und dann zum Beispiel der Name des Kapitels insgesamt also `dietrich-Kamera_Alpha7`. Auch hier dürfen keine Leerzeichen vorkommen. Zuletzt ist es noch gut, wenn ein beschreibender Name für die Veränderungen (Branch) gewählt wird. Es ist hier gut wenn dieser mit dem eigenen Benutzernamen beginnt in diesem Fall: `dietrich-` und dann zum Beispiel der Name des Kapitels insgesamt also `dietrich-Kamera_Alpha7`. Auch hier dürfen keine Leerzeichen vorkommen.
@ -76,4 +76,6 @@ wird verändert zu:
Die Reihenfolge ist dieselbe, wie nacher auch im Inhaltsverzeichnis man sollte also darauf achten die neue Zeile an der richtigen Stelle einzufügen. Die Reihenfolge ist dieselbe, wie nacher auch im Inhaltsverzeichnis man sollte also darauf achten die neue Zeile an der richtigen Stelle einzufügen.
Auch diesmal fügt man unten auf der Seite einen kleinen Kommentar zur Änderung hinzu und drückt auf `Änderungen comitten`. Jetzt kann man in der Pull-Request nachschauen und die neuen Veränderungen müssten auch in dieser Pullrequest sein. Auch diesmal fügt man unten auf der Seite einen kleinen Kommentar zur Änderung hinzu und drückt auf `Änderungen comitten`. Jetzt kann man in der Pull-Request nachschauen und die neuen Veränderungen müssten auch in dieser Pullrequest sein.
Jetzt müssen nur noch zwei Mitglieder der Film-AG zustimmen und diese Veränderung dann einfügen. Diese Maßnahme hilft, dass der Inhalt qualitativ hochwertig ist.

View File

@ -0,0 +1,11 @@
# Anleitung wie man einen vorhandenen Text aktualisiert
Das Aktualisieren und anpassen eines Textes ist relativ einfach. Auch hier benötigt man ein Konto für die Seite https://git.uhle.cloud. Ist man eingeloggt und hat die nötigen Berechtigungen, kann man auf die Seite https://git.uhle.cloud/Film-AG/Equipment gehen.
Im Verzeichnis `src` sind die existierenden Kapitel. Hier sucht man sich das aus, welches man gerne verändern möchte und öffnet es durch einen Klick.
In der geöffneten Datei gibt es oben rechts ein Bleistiftsymbol, welches den Editiervorgang startet.
![Screenshot](./img/anleitung_fuer_kapitel/Summary.png)
Der Text müsste jetzt angezeigt werden und sollte veränderbar sein. Jetzt kann man einfach die Stellen verändern die eine Anpassung nötig haben. Ist alles wie gewünscht kann man bei Vorschau überprüfen, ob es auch so aussieht wie man es gerne hätte. Dann kann man jetzt die Änderungen so vorschlagen, wie im [vorherigen Kapitel "einen neuen Commit erstellen"](./Anleitung_fuer_kapitel.md#einen-neuen-commit-erstellen)

View File

@ -1,5 +1,8 @@
# Summary # Summary
- [Einleitung](./chapter_1.md) - [Einleitung](./chapter_1.md)
- [Anleitung zur Ergänzung der Anleitung](./Anleitung_fuer_kapitel.md) - [Anleitung zur Ergänzung der Anleitung](./Anleitung_einleitung.md)
- [Die Kameragehäuse Sony Alpha 7](./Alpha7_kamera.md) - [Neues Kapitel erstellen](./Anleitung_fuer_kapitel.md)
- [Vorhandenes Kapitel ändern](./Anleitung_fuer_modifikation.md)
- [Änderungen akzeptieren](./Anleitung_aenderungen_akzeptieren.md)
- [Die Kameragehäuse Sony Alpha 7](./Alpha7_kamera.md)

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB