Skip to content

Commit

Permalink
Fix Sprache vereinheitlichen und fehlende Lehrzeichen beheben
Browse files Browse the repository at this point in the history
  • Loading branch information
schnaitter committed Jun 12, 2024
1 parent 05d1589 commit e5c58b0
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 34 deletions.
14 changes: 7 additions & 7 deletions develop/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ git clone https://github.com/quadriga-dk/Book_Template
Das Ergebnis dieses Befehls ist, dass ein Ordner `Book_Template` am aktuellen Ort im Dateisystem angelegt wird und in diesem eine vollständige Kopie des Repositoriums von Github abgelegt wird. Navigiere ggf. vor ausführen des Befehls an eine andere Stelle im Dateisystem. Im Repositorium enthalten ist die gesamte Versionsgeschichte – d.h. alle Commits – sowie alle nötigen Informationen, um das lokale Repositorium nutzen zu können.

### Fetch
Regelmäßig – insbesondere wenn Du weißt, dass jemand anderes eine neue Version nach Github hochgeladen hat – solltest Du `git fetch` nutzen um eine Kopie der Commits auf dem Server herunterzuladen. Ein `git fetch` ändert nichts an dem Commit in dem Du gerade arbeitest und auch nichts an den Änderungen, die du lokal gerade machst.
Regelmäßig – insbesondere wenn Du weißt, dass jemand anderes eine neue Version nach Github hochgeladen hat – solltest Du `git fetch` nutzen um eine Kopie der Commits auf dem Server herunterzuladen. Ein `git fetch` ändert nichts an dem Commit in dem Du gerade arbeitest und auch nichts an den Änderungen, die Du lokal gerade machst.

Wenn Du einen anderen Commit auswählen willst geht das mit `git checkout`. Das überschreibt ggf. aktive Änderungen, die du noch nicht gespeichert hast (s.u.).
Wenn Du einen anderen Commit auswählen willst geht das mit `git checkout`. Das überschreibt ggf. aktive Änderungen, die Du noch nicht gespeichert hast (s.u.).

### Pull
Wenn Du auf den gleichen Stand wechseln willst wie der Server, dann kannst Du `git pull` nutzen. Dies geht nur reibungslos, wenn Du lokal keine Änderungen gemacht hast, die in Konflikt stehen mit Änderungen, die auf dem Server abgelegt waren. Um mit Konflikten umzugehen gibt es den sogenannten Stash, auf welchen hier vorerst nicht eingegangen wird. Du kannst Konflikte zwischen Commits mit Merge beheben (s.u.).

### Add
Während Du lokal arbeitest ändert sich nicht automatisch der aktuelle Snapshot. Stattdessen merkt sich Git diese Änderungen separat – man sagt, die Änderungen sind *unstaged*. Du kannst Dir über `git status` anzeigen lassen, welche Dateien Du lokal geändert hast. Mit `git diff` kannst du dir inhaltliche Änderungen anzeigen lassen. Wenn Du eine der Änderungen für einen Commit vormerken willst, dann geht das mit `git add` – die Änderungen sind dann *staged*.
Während Du lokal arbeitest ändert sich nicht automatisch der aktuelle Snapshot. Stattdessen merkt sich Git diese Änderungen separat – man sagt, die Änderungen sind *unstaged*. Du kannst Dir über `git status` anzeigen lassen, welche Dateien Du lokal geändert hast. Mit `git diff` kannst Du Dir inhaltliche Änderungen anzeigen lassen. Wenn Du eine der Änderungen für einen Commit vormerken willst, dann geht das mit `git add` – die Änderungen sind dann *staged*.

Um bspw. eine Änderung in dieser Datei für einen Commit vorzumerken nutze diesen Befehl:
```bash
Expand Down Expand Up @@ -63,23 +63,23 @@ Ein anderer Weg ist es, Commits in einem Branch zu pushen und dann bspw. über d
`git merge` pflegt Änderungen eines Commits bzw. eines Branches in einen anderen Commit/Branch ein und erzeugt dazu einen sogenannten Merge Commit. Funktioniert das nicht automatisch, so musst Du alle Konflikte von Hand beheben. (Eine andere Option des Zusammenführens nennt sich `git rebase`.)

## Branch und switch
Mit einem Branch kannst Du einen Commit (bzw. eine Reihe von Commits) benennen, sodass Du ihn wieder leicht finden kannst. Mit `git branch -c tutorial` erzeugst Du einen Branch. Mit `git switch tutorial` wechselst Du zu dem Branch. Commits, die du erstellts während du im Branch bist, werden automatisch zum Branch hinzugefügt. Dies ermöglicht es, getrennt von Änderungen anderer zu arbeiten. Wenn Du mit dem Zustand des Branches zufrieden bist, kannst Du ihn dann wieder mit dem normalen Entwicklungsbranch (meistens entweder *main* oder *master* genannt) zusammenführen. Ein Branch kann lokal bleiben oder auf den Server synchronisiert werden, sodass andere auch an dem Feature arbeiten können.
Mit einem Branch kannst Du einen Commit (bzw. eine Reihe von Commits) benennen, sodass Du ihn wieder leicht finden kannst. Mit `git branch -c tutorial` erzeugst Du einen Branch. Mit `git switch tutorial` wechselst Du zu dem Branch. Commits, die Du erstellts während Du im Branch bist, werden automatisch zum Branch hinzugefügt. Dies ermöglicht es, getrennt von Änderungen anderer zu arbeiten. Wenn Du mit dem Zustand des Branches zufrieden bist, kannst Du ihn dann wieder mit dem normalen Entwicklungsbranch (meistens entweder *main* oder *master* genannt) zusammenführen. Ein Branch kann lokal bleiben oder auf den Server synchronisiert werden, sodass andere auch an dem Feature arbeiten können.

```{admonition} Übung
:class: tip
1. Gehe auf die [Github-Seite des OER-Templates](https://github.com/quadriga-dk/Book_Template).
2. Stelle sicher, dass du eingeloggt bist und wähle dann *Fork > Create a new Fork*.
2. Stelle sicher, dass Du eingeloggt bist und wähle dann *Fork > Create a new Fork*.
3. Folge den Anweisungen um eine Kopie spezielle des Templates in Deinem Github-Account zu erstellen, die Fork genannt wird. Ein Fork ist verbunden zum sogenannten *Upstream* Repositorium und kann Änderungen aus diesem bei sich wieder Einpflegen und Vorschläge für Änderungen (sog. Pull Requests) anbieten.
4. Nutze nun `git clone` um eine Kopie deines Forks auf deiner lokalen Festplatte zu erstellen.
5. Erzeuge einen Branch mit dem Namen `tutorial` und wechsle in diesen.
6. Erstelle eine Markdown-Datei schreibe etwas Text in diese.
7. Füge die Markdown-Datei dem Inhaltsverzeichnis `_toc.yml` hinzu.
8. Merke die Änderungen für einen Commit vor und erstelle dann den Commit.
9. Was passiert, wenn du `git push` ausführst?
9. Was passiert, wenn Du `git push` ausführst?
10. Wechsle in den Branch `main`.
11. Merge die Änderungen aus dem Branch `tutorial` nach `main`.
12. Führe noch einmal `git push` durch. Was passiert dieses mal?
13. Sie dir die 5 neuesten Commits in der Geschichte an mit `git log -5`.
13. Sie Dir die 5 neuesten Commits in der Geschichte an mit `git log -5`.
### Bonus
14. Aktiviere Github Pages und Github Actions in deinem Fork um automatisch das Jupyter Book bauen zu lassen.
Expand Down
8 changes: 4 additions & 4 deletions develop/jupyter_book.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Wenn Du Anaconda installierst, wird automatisch ein sogenanntes *virtual environ

Wir nutzen das Programm `conda` um Environments anzulegen, wobei es sich empfielt ein Environment nur für genau ein Projekt – in diesem Fall eine OER – zu nutzen.

Bist du in einem Environment kannst du dieses mit `conda deactivate` deaktivieren.
Bist Du in einem Environment kannst Du dieses mit `conda deactivate` deaktivieren.

Du kannst "globale" Environments anlegen, jedoch empfehlen wir hier projekt-spezifische Environments, die im Ordner der OER abgelegt werden. Git ist im Template so konfiguriert, dass der Ordner `conda` ignoriert wird.

Expand All @@ -22,14 +22,14 @@ conda create -p .\conda
```
Dies erzeugt einen Ordner `conda` im aktuellen Verzeichnis, in dem alle nötigen Programme wie Python installiert werden.

Mit `conda activate ./conda` kannst Du das Environment aktivieren. Dadurch werden die im Environment installierten Programme und Programmbibliotheken innerhalb des Terminals korrekt zur Verfügung gestellt. Wenn du jetzt bspw. `python3` ausführst, dann wird das Python aus dem Environment genutzt.
Mit `conda activate ./conda` kannst Du das Environment aktivieren. Dadurch werden die im Environment installierten Programme und Programmbibliotheken innerhalb des Terminals korrekt zur Verfügung gestellt. Wenn Du jetzt bspw. `python3` ausführst, dann wird das Python aus dem Environment genutzt.

Installiere nun alle für das Projekt/die OER benötigten Programme und Programmbibliotheken mit `pip install -r requirements.txt`. Damit sollte der Befehl `jb` für Jupyter Book zur Verfügung stehen. Klappt das nicht, dann deaktiviere das Environment einmal und aktiviere es dann wieder.

## Lokale Entwicklung
Wenn Du im lokalen Ordner deines Git Repositoriums bist kannst du die OER mit `jb build .` neu bauen lassen. Am Ende des Befehls findest du einen `file://`-Link zur Startseite, den du in einem Browser öffnen kannst. Wenn das nicht klappt, dann nutze einen lokalen HTTP-Server um die Dateien zu hosten (bspw. `python3 -m http.server -d _build/html`) und gehe im Browser zur angezeigten URL.
Wenn Du im lokalen Ordner deines Git Repositoriums bist kannst Du die OER mit `jb build .` neu bauen lassen. Am Ende des Befehls findest Du einen `file://`-Link zur Startseite, den Du in einem Browser öffnen kannst. Wenn das nicht klappt, dann nutze einen lokalen HTTP-Server um die Dateien zu hosten (bspw. `python3 -m http.server -d _build/html`) und gehe im Browser zur angezeigten URL.

Wenn du lokale Dateien anpasst musst du immer zuerst `jb build .` ausführen, bevor die Änderungen im Browser sichtbar werden. Gibt es hierbei einmal Probleme kann es helfen zuerst "aufzuräumen" mit `jb clean .`. Wenn du danach wieder `jb build .` ausführst, so werden alle Seiten, auch die, die du nicht geändert hattest, neu gebaut.
Wenn Du lokale Dateien anpasst musst Du immer zuerst `jb build .` ausführen, bevor die Änderungen im Browser sichtbar werden. Gibt es hierbei einmal Probleme kann es helfen zuerst "aufzuräumen" mit `jb clean .`. Wenn Du danach wieder `jb build .` ausführst, so werden alle Seiten, auch die, die Du nicht geändert hattest, neu gebaut.

## Änderung der OER auf Github
Kleine Änderungen können auch direkt auf Github durchgeführt werden. Jede Datei hat rechts oben ein Stift-Symbol, wodurch Du in einen Bearbeitungsmodus gelangst. Ein speichern ist hier automatisch ein Commit – denke an eine gute Commit Message.
Expand Down
4 changes: 2 additions & 2 deletions develop/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
## Installation
Gehe auf die [Downloadseite von Anaconda](https://www.anaconda.com/download) um Dir die passende Version für Dein Betriebssystem herunterzuladen. Es ist nicht nötig, eine E-Mail anzugeben! Nutze "Skip registration" um gleich zu den Download-Links zu kommen.

Fall Du einen Paketmanager wie homebrew oder Chocolatey nutzt kannst du ggf. auch diesen für die Installation nutzen.
Fall Du einen Paketmanager wie homebrew oder Chocolatey nutzt kannst Du ggf. auch diesen für die Installation nutzen.

Folge den Anweisungen und wähle die Standardoptionen bzw. die empfohlenen Optionen aus.

Du solltest die Anwendung *Anaconda Navigator* installiert haben, über die du auf alle anderen Funktionalitäten der Anaconda Distribution kommen kannst.
Du solltest die Anwendung *Anaconda Navigator* installiert haben, über die Du auf alle anderen Funktionalitäten der Anaconda Distribution kommen kannst.

## Jupyter Notebooks und Jupyter Lab
Jupyter Notebooks sind einerseits ein Dateiformat mit der Namenserweiterung `.iypnb` und andererseits eine Software um (unter anderen) Jupyter Notebook Dateien zu bearbeiten. Jupyter Lab ist ebenfalls eine Software, um diese Dateien zu bearbeiten. Probiere gerne beide aus, wenn Du Jupyter Notebooks bspw. mit Python oder R für deine OER nutzt. Jupyter Notebook Dateien können auch in einigen Texteditoren und IDEs geöffnet werden (siehe dazu den Abschnitt zu Editoren).
Expand Down
Loading

0 comments on commit e5c58b0

Please sign in to comment.