1
README
Timba edited this page 2026-09-03 08:51:07 +02:00

Das Wiki

Diese Seiten gehören nicht in dieses Repository, sondern in das Wiki der Auslieferung. Sie liegen hier, weil sie mit dem Programm zusammen gepflegt werden sollen: Wer eine Funktion ändert, sieht die Seite daneben.

Hinaufladen

Ein Gitea-Wiki ist ein eigenes Git-Repository neben dem eigentlichen. Beim ersten Mal muss es über die Weboberfläche angelegt werden — einmal auf „Wiki" klicken und eine erste Seite speichern —, danach geht es über Git:

git clone https://gitea.itm-technologies.de/ITM-GmbH/shuftn-releases.wiki.git

Dann den Inhalt dieses Ordners hineinkopieren, ohne diese Datei:

copy wiki\*.md <wiki-ordner>\
del <wiki-ordner>\README.md

Und im Wiki-Ordner committen und hochladen.

Wie die Seiten heißen

Gitea macht aus dem Dateinamen den Seitennamen: Optik-anpassen.md wird zu Optik anpassen, und Verweise der Form [Optik anpassen](Optik-anpassen) finden sie. Home.md ist die Startseite.

Wer eine Seite umbenennt, muss die Verweise darauf mitnehmen — Gitea legt keine Weiterleitung an.

Was hineingehört

Nur, was es wirklich gibt. Eine Anleitung, die eine Funktion erfindet oder eine Einstellung beschreibt, die anders heißt, ist schlimmer als keine: Wer sie einmal beim Falschliegen erwischt, glaubt ihr nie wieder.

Beim Ändern einer Funktion gehört die Seite in denselben Commit. Dann steht in der Versionsgeschichte, warum sich der Text geändert hat.