Merge pull request 'kleine Änderungen' (#7) from dietrich-fixes into master

Reviewed-on: Film-AG/Equipment#7

src/Anleitung_aenderungen_akzeptieren.md

@@ -0,0 +1,28 @@
+# 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 dem Klick auf den Button kann man nochmals einen Kommentar dazu schreiben, was hier verändert wurde.
+
+![Screenshot](./img/anleitung_fuer_kapitel/pull-request-merge.png)
+
+Nach kurzer Zeit (weniger als 1 min.) sollte die Equipmentseite die neuen Änderungen enthalten und es bleibt nur noch das Aufräumen, was aber zum Glück durch einen Klick auf den großen roten Knopf `Branch "…" löschen` erledigt ist.
+
+![Screenshot](./img/anleitung_fuer_kapitel/branch-loeschen.png)
+

src/Anleitung_einleitung.md

@@ -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.

src/Anleitung_fuer_kapitel.md

@@ -1,28 +1,61 @@
-# 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
 
-Die Anleitung wird verwaltet über den Link: https://git.uhle.cloud/Film-AG/Equipment/
+Die Anleitung wird verwaltet über den Link: [https://git.uhle.cloud/Film-AG/Equipment/](https://git.uhle.cloud/Film-AG/Equipment/)
 
-In dem Ordner src sind die bereits existierenden Kapitel aufgelistet. Um diese zu bearbeiten, oder ein neues Kapitel zu erstellen benötigt man ein Konto auf https://git.uhle.cloud . Dieses Konto kann von Herrn Dietrich erstellt werden. Bitte einen Verantwortlichen der Film AG Herrn Dietrich eine entsprechende email zu schreiben.
+In dem Ordner src sind die bereits existierenden Kapitel aufgelistet. Um diese zu bearbeiten, oder ein neues Kapitel zu erstellen benötigt man ein Konto auf [https://git.uhle.cloud](https://git.uhle.cloud) . Dieses Konto kann von Herrn Dietrich erstellt werden. Bitte einen Verantwortlichen der Film AG Herrn Dietrich eine entsprechende email zu schreiben.
 
-Ist man eingeloggt und hat die nötigen Zugangsrechte, sollte oben rechts ein Knopf `Fork` sein. Dieser knopf ist dafür da, eine eigene Kopie des Equipmentbuches zu erstellen. Diese Kpoie kann man dann bearbeiten und am Ende alles, was man geändert hat wieder zur originalen Version dazu fügen.
+Ist ein Konto erstellt, erfolgreich eingeloggt und hat die nötigen Zugangsrechte, müsste es jetzt einen blauen Knopf `Neue Datei` und `Datei hochlagen` geben. Sollte das noch nicht der Fall sein, muss das Problem erst gefunden und gelöst werden.
 
-Ist das erfolgreich gewesen, müsste jetzt oben `Film-AG` durch den eigenen Benutzernamen ersetzt worden sein. Jetzt kann man in den `src` Ordner wechseln und das ganze sollte so aussehen (nur dass statt `Film-AG` oben der Benutzername steht):
+Jetzt kann man in den `src` Ordner wechseln, in dem die Kapitel sind, und das ganze sollte so aussehen:
 
 ![Screenshot](./img/anleitung_fuer_kapitel/Repository.png)
 
-Über der liste der vorhandenen Kapitel sind auf der rechten Seite die Knöpfe `Neue Datei`, `Datei hochladen` und `Verlauf `. Man erstellt jetzt eine neue Datei mit dem entsprechenden Knopf – Achtung die neue Datei muss in dem `src` Ordner erstellt werden. Im Folgenden Fenster muss man einen Dateinamen eingeben. Der Übersicht halber hier einen Namen wählen, der das Kapitel möglichst gut beschreibt. Bei der Namenwahl bitte darauf achten, dass nur Buchstaben und `_`, `-`, `.` im Dateinamen vorkommen und der Name mit `.md` endet. Zum Beispiel `Kapitel_Alpha7.md`.
+Über der liste der vorhandenen Kapitel sind auf der rechten Seite die Knöpfe `Neue Datei`, `Datei hochladen` und `Verlauf `. Man erstellt jetzt eine neue Datei mit dem entsprechenden Knopf – Achtung die neue Datei muss in dem `src` Ordner erstellt werden. Im Folgenden Fenster muss man einen Dateinamen eingeben. Der Übersicht halber hier einen Namen wählen, der das neu zu schreibende Kapitel möglichst gut beschreibt. Bei der Namenwahl bitte darauf achten, dass nur Buchstaben und `_`, `-`, `.` im Dateinamen vorkommen und der Name mit `.md` endet. Zum Beispiel `Alpha7_kamera.md`.
 
 ![Screenshot](./img/anleitung_fuer_kapitel/Neue_Datei.png)
 
-Sie können schon jetzt den Text eingeben, Sie können aber auch erstmal die Datei abspeichern. Zum Abspeichern klicken Sie ganz unten auf der Seite auf `Änderungen comitten`. 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. Diesen kann man direkt über dem Knopf `Änderungen comitten` eintragen.
+## Einen neuen Commit erstellen
 
-Nach dem Comitten müsste die neue Datei in der Liste mit auftauchen.
+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.
 
-Als nächstes muss die Datei `SUMMARY.md` geändert werden. Einfach nach einem Klick auf diese Datei oben rechts auf das kleine Bleistiftsymbol (direkt neben dem Mülltonnensymbol) klicken und die Datei anpassen.
+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.
+
+Zum Abspeichern klicken Sie ganz unten auf der Seite auf `Änderungen comitten`. 
+
+![Screenshot](./img/anleitung_fuer_kapitel/Committen.png)
+
+Nach dem Comitten wird man zu diesem neu erstellten Branch weitergeleitet. Die Änderungen sind bis jetzt noch in einem sepparaten Teil. Um diese Änderungen jetzt in die Hauptversion einzuspielen muss man einen Pullrequest erstellen. Dieser wird dann durch andere Mitglieder der Film-AG korrekturgelesen und wenn zwei ihr OK geben, kann die Veränderung in den Hauptzweig übergehen - also in die Internetseite übernommen werden.
+
+Es wird also nun durch klick auf `Neuer Pull-Request` eine solche Anfrage erstellt.
+
+![Screenshot](./img/anleitung_fuer_kapitel/Pull-Request.png)
+
+Jetzt kann man nochmal eine Zusammenfassung eingeben, wenn die vorher schon eingegebene gut ist kann man einfach auf `Pull-Request Erstellen` klicken.
+
+Jetzt ist die Anfrage raus und zwei andere Mitglieder müssen diesen Text Korrekturlesen und eventuell Kommentare einfügen.
+
+## Erweiterung der Pull-Request
+
+Oft ist es notwendig die Pull-Request nochmal zu ändern, weil entsprechende Anmerkungen gemacht wurden, oder weil man selbst bemerkt hat, dass noch etwas fehlt. In unserem Fall bemerken wir jetzt, dass wir das Kapitel zwar erstellt haben, aber dieses nicht zum Inhaltsverzeichnis hinzugefügt. Das heißt es wäre nicht möglich das Kapitel auf der Internetseite zu lesen.
+
+Man muss dazu zurück zur Übersicht, indem man oben auf Equipment klickt, dann wählt man den richtigen Branch, den man weiter oben angegeben hat.
+
+
+![Screenshot](./img/anleitung_fuer_kapitel/aenderungen.png)
+
+Jetzt müsste diese Übersicht sichtbar sein, in der man durch einen Klick auf `src` in das Verzeichnis `src` wechseln.
+
+![Screenshot](./img/anleitung_fuer_kapitel/eigener-branch.png)
+
+In diesem Verzeichnis müssten jetzt die Dateien sein, die in unserem Pull-Request erstellt wurden. Wir hatten ja die Datei `Alpha7_kamera.md` erstellt.
+
+![Screenshot](./img/anleitung_fuer_kapitel/eigener-branch-src.png)
+
+Nun müssen wir dieses Kapitel in das Inhaltsverzeichnis einfügen.
+
+Das Inhaltsverzeichnis ist in der Datei `SUMMARY.md`. Einfach nach einem Klick auf diese Datei oben rechts auf das kleine Bleistiftsymbol (direkt neben dem Mülltonnensymbol) klicken und die Datei anpassen.
 
 ![Screenshot](./img/anleitung_fuer_kapitel/Summary.png)
 
@@ -38,9 +71,11 @@ wird verändert zu:
 
 ```md
 - [Einleitung](./chapter_1.md)
-- [Die Kameragehäuse Sony Alpha 7](./Kapitel_Alpha7.md)
+- [Die Kameragehäuse Sony Alpha 7](./Alpha7_kamera.md)
 ```
 
 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`.
+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.

src/Anleitung_fuer_modifikation.md

@@ -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](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](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)

src/Anleitung_styling.md

@@ -0,0 +1,77 @@
+# Verschiedene Gestaltungsmöglichkeiten
+
+Hier in diesem Kapitel werden einige Beispiele gegeben, welcher Effekt wie erreicht werden kann. Eine weitaus vollständigere Liste gibt es hier: [https://guides.github.com/features/mastering-markdown/](https://guides.github.com/features/mastering-markdown/)
+
+## Überschriften
+
+```makrdown
+# Überschrift Groß
+## Überschrift kleiner
+### Überschrift noch kleiner
+```
+Ergibt:
+
+# Überschrift Groß
+## Überschrift kleiner
+### Überschrift noch kleiner
+
+## Hervorhebungen
+
+```makrdown 
+*kursiv* **fett** ***fettkursiv*** `als code`
+```
+
+Ergibt: 
+
+*kursiv* **fett** ***fettkursiv*** `als code`
+
+Und es ist auch möglich Code-Blocks zu erstellen (die Striche sind Accents also bei der Zeichenlöschentaste auf der Tastatur):
+
+    ```
+    code block mit Zeilen
+    zum Beispiel
+    ```
+
+Ergibt:
+
+```
+code block mit Zeilen
+zum Beispiel
+```
+
+## Bilder und Links
+
+Bitte die Bilddateien immer in den Unterordner `./src/img/` speichern. Die Bilder müsssen auch hochgeladen werden, sonst können sie nicht gefunden werden. Beim Hochladen der Bilder darauf achten, dass man sie im selben Branch wie die anderen Änderungen hochlädt.
+
+```markdown
+[link text](https://www.example.com/)
+
+![bild text](./img/example.jpg)
+```
+
+Ergebnis:
+
+[link text](https://www.example.com/)
+
+![bild text](./img/example.jpg)
+
+## Aufzählungslisten
+
+```markdown
+* Punkt 1
+* Punkt 2
+  * Punkt 2.1
+
+1. Erstens
+2. Zweitens
+  1. Zweipunkterstens
+```
+Ergebnis:
+
+* Punkt 1
+* Punkt 2
+  * Punkt 2.1
+
+1. Erstens
+2. Zweitens
+6. Drittens

src/SUMMARY.md

@@ -1,5 +1,9 @@
 # Summary
 
 - [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)
+    - [Styling und Styleguide](./Anleitung_styling.md)
+- [Die Kameragehäuse Sony Alpha 7](./Alpha7_kamera.md)