Das Equipment der Film AG
Diese Seite ist um eine Anleitung zur Nutzung, sowie eine Übersicht über das Film-AG Equipment zu bieten.
Jedes Teil bekommt sein eigenes Kapitel welches enthält:
- Beschreibung des Geräts
- Beschreibung der Funktion
- Stellen auf die Besonders geachtet werden muss
- Menschen, die dieses Equipment ausleihen dürfen (auch Lehrer)
Das Ziel ist, dass jeder der etwas ausleihen möchte entweder ausleihen darf und das entsprechende Kapitel erstellt, oder, wenn das Kapitel schon existiert, dieses liest, gegebenenfalls ergänzt und sich als berechtigte Person einträgt.
Das führt dazu, dass die Film-AG für die wichtigsten Funktionen eine Anleitung hat, sodass neue Mitglieder sich gut einarbeiten können und das Verpasste aufholen können.
Als erstes folgt eine Anleitung, wie man ein neues Kapitel erstellt und wie man ein existierendes bearbeitet.
Das Buch kann übrigens mit den Pfeiltasten der Tastatur gesteuert werden. Um zum nächsten Kapitel zu springen also einfach die "rechts"-Taste drücken.
Viel Spaß
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.
Ein neues Kapitel erstellen
Die Anleitung wird verwaltet über den Link: 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.
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.
Jetzt kann man in den src Ordner wechseln, in dem die Kapitel sind, und das ganze sollte so aussehen:
Ü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.
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.
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.
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.
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.
Jetzt müsste diese Übersicht sichtbar sein, in der man durch einen Klick auf src in das Verzeichnis src wechseln.
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.
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.
Hier muss das neue Kapitel eingefügt werden, indem eine neue Zeile hinzugefügt wird. Am einfachsten kopiert man eine Zeile und verändert den Titel des Kapitels zwischen den Eckigen Klammern und den Dateinamen zwischen den runden Klammern.
Eine Beispielzeile (alt):
- [Einleitung](./chapter_1.md)
wird verändert zu:
- [Einleitung](./chapter_1.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. 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.
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.
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"
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.
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.
Nach dem Klick auf den Button kann man nochmals einen Kommentar dazu schreiben, was hier verändert wurde.
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.
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/
Überschriften
# Überschrift Groß
## Überschrift kleiner
### Überschrift noch kleiner
Ergibt:
Überschrift Groß
Überschrift kleiner
Überschrift noch kleiner
Hervorhebungen
*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.
[link text](https://www.example.com/)
Ergebnis:
Aufzählungslisten
* Punkt 1
* Punkt 2
* Punkt 2.1
1. Erstens
2. Zweitens
1. Zweipunkterstens
Ergebnis:
- Punkt 1
- Punkt 2
- Punkt 2.1
- Erstens
- Zweitens
- Drittens