Kollaborativ Lehrunterlagen mitentiwckeln

In dieser Schritt-für-Schritt Anleitung möchten wir euch zeigen, wie ihr an den Statistik Lehrunterlagen mitarbeiten könnt.

Navigieren mittels der Pfeiltasten

  ←  
  →  
Zurück
Vorwärts

Diese Anleitung ist folgendermassen Lizensiert: CC BY 4.0

Vorbereitung: GitHub Account

  • Um an den Unterlagen mitzuarbeiten, braucht ihr einen kostenlosen GitHub Account
  • GitHub ist ein Ort, wo der Quellcode von Software geteilt wird
  • Ein Account lohnt sich: > 90 % der R-Packages sind auf GitHub gehostet
  • Hier kann man sich einen neuen Account erstellen: github.com/login
  • Nachdem ihr euch auf GitHub eingelogged habt, könnt ihr das Statistik Skript in einem neuen Tab öffnen.

Die Ausgangslage

Angenommen ihr liest Kapitel 4 der Statistik Unterlagen...

...und wollt folgende Änderung umsetzen:

  • "den bekannten Methoden"" zu "den uns bereits bekannten Methoden"
  • "lm" soll als Code dargestellt werden ("lm")

Dafür ihr auf den Link "Seite editieren" Klicken, der sich immer rechts unter dem Inhaltsverzeichnis befindet.

GitHub Account

Falls ihr noch keinen GitHub Account habt, müsst ihr zuerst noch einen erstellen. Da ein Grossteil aller R-Packages auf GitHub gehostet sind, lohnt sich dieser Schritt.

Nach der GitHub Registration und Anmeldung müsst ihr den Link "Seite editieren" nochmals klicken.

Unterlage Kopieren

Eure Änderungen macht ihr auf einer vollständigen Kopie unserer Unterlagen. Auf GitHub wird Kopieren als "Forking" bezeichnet.

Um eine eigene Kopie der Unterlagen zu erstellen, müsst ihr auf den Button Fork this repository klicken.

(Dieser Schritt entfällt bei allfälligen weiteren Änderungen, die ihr vornehmen werdet.)

Quarto File bearbeiten

Nach dem Forken könnt ihr das entsprechende Quarto-File bearbeiten.

Quarto Dokumente (welche ihr bereits aus den Übungen kennt) werden in einer sogennanten Markup Sprache geschrieben, die sich Markdown nennt.

(Hier hat sich jemand ein etwas verwirrendes Wortspiel erlaubt)

Lasst uns an dieser Stelle etwas über Markdown sprechen.

Markdown

  • Eine Markup-Sprache ist eine maschinenlesbare Sprache für die Gliederung und Formatierung von Texten.
  • HTML ist die bekannteste und verbreiteste Markup Sprache.
  • Markdown (auch eine Markup sprache) ist viel simpler in der Schreibweise. Ein Beispiel:
					
							
							# Markdown, eine Markup Sprache

							Dieser Satz ist *wirklich* in **Markdown** geschrieben.
  • Dieser Quellcode ist für ein Programm gut prozessierbar.
  • Auch ohne Prozessierung ist erkennbar, dass "wirklich" und "Markdown" betont sind.
  • (Ein Sternchen gilt als kusive Hervorhebung, zwei Sternchen als Fettdruck)
  • Weitere Infos zum Markdown-Syntax findet ihr auf der Quarto Website
  • Apropos: Lasst uns kurz über Quarto reden

Quarto (quarto.org)

  • Quarto kann Markdown in PDF, HTML, DOCX uvm. konvertiert
  • Quarto ist besonders, weil es auch R oder Python Code in Markdown konvertieren kann.
  • Zudem ist Quarto in RStudio integriert.
  • Quarto ist für jeglicher Text nutzbar und kann als kostenloser Ersatz für herkömmliche Text-Layout-Systeme wie Microsoft Word genutzt werden.
  • Zum Beispiel kann man seine Projekt- / Masterarbeit in Quarto schreiben.
    Hier ein Beispiel (Webseite), und hier ein weiteres (pdf)
  • Aus Quarto können auch Slides oder Ebooks generiert werden

Quarto File bearbeiten

Zurück zu unseren Unterlagen. Wir wollten ja zwei Änderungen an den Unterlagen vornehmen:

"den bekannten Methoden"" zu "den uns bereits bekannten Methoden"

"lm" soll als Code dargestellt werden ("lm")

Um die entsprechende Stelle im Quarto Dokument zu finden, nutzen wir die Suchfunktion mit Ctrl+F

Absatz im File finden

Ctrl+F öffnet die Suchleiste...

... wo wir einen sinvollen Begriff eingeben können und auf Next klicken...

... und springen im Quartodokument zur entsprechenden Stelle

Änderungen vornehmen

An dieser Stelle können wir nun die Änderungen vornehmen.

"den bekannten Methoden"" zu "den uns bereits bekannten Methoden"

"lm" soll als Code dargestellt werden ("lm").
Hierfür müssen wir den Text mit ` Umgeben (siehe quarto.org ).

Änderung betrachten

Im Preview Modus sehen wir die (ungespeicherten) Änderungen.

(das fertige Dokument können wir leider nicht sehen. Hierfür sind ein paar Zusätliche Schritte nötig, die wir an dieser Stelle weglassen wollen)

Mit Klick auf Commit changes... werden die Änderungen gespeichert.

Kommentar hinzufügen

Wir haben die Möglichkeit, einen Kommentar ("Commit message") über unsere Änderung zu platzieren (z.B. Satz ausformulieren und Code hervorheben) und können den Speichervorgang mit Propose changes abschliessen.

Änderungsvorschlag erstellen

Um uns eure Änderung uns als Änderungsvorschlag zu schicken, müsst ihr daraus einen "Pull Request" machen (Klick auf den Button Create pull request)

Änderungsvorschlag abschicken

Wir haben nochmals die Möglichkeit, einen Kommentar zu unserer Änderung zu platzieren. Diese müssen wir aber nicht nutzen und können den Vorgang mit Create pull request abschliessen.

Abgeschickt!

Der Änderungsvorschlag ("Pull Reqest") ist jetzt bei uns angekommen und wir werden in Prüfen.

Wenn ihr unserem Repo noch ein ⭐ Sternchen geben wollt, würden wir uns sehr freuen!

Dafür auf < > Code klicken...

Sternchen ⭐

... und danach auf den Button ☆ Star 

Und nun seit ihr fertig, Vielen Dank! Eine Sache noch:

Wenn wir euren Änderungsvorschlag akzeptieren, werdet ihr automatisch in die Liste der Contributors aufgenommen!