forked from Hg/htlle-da-vorlage
Added Information about images, and removed section about the build-service
Solves #31
This commit is contained in:
parent
7a369c4d2d
commit
1ee2fb447e
34
README.md
34
README.md
@ -27,7 +27,7 @@ Wenn der HTL eigene GIT-Server verwendet wird, brauchen Sie die Tools nicht unbe
|
||||
|
||||
## Windows
|
||||
|
||||
Wenn man Windows 10 als primäres Betriebssystem verwendet hat man zwei Möglichkeiten um zu einer Linux Umgebung zu kommen:
|
||||
Wenn man Windows 10 oder Windows 11 als primäres Betriebssystem verwendet hat man zwei Möglichkeiten um zu einer Linux Umgebung zu kommen:
|
||||
|
||||
### VM installieren
|
||||
Installation einer virtuellen Maschine auf der ein Linux läuft (z.B: mit [HyperV](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v), [VmWare](https://www.vmware.com/at/products/workstation-player.html), [VirtualBox](https://www.virtualbox.org/) oder einem anderen Virtualisierer) -> Dann erhält man eine VM welche man zum bearbeiten der VM extra starten muss
|
||||
@ -59,34 +59,6 @@ Bei einer englischen Diplomarbeit muss außerdem entweder das Paket `hunspell-en
|
||||
|
||||
# Grundlegende Schritte
|
||||
|
||||
## Automatisches erstellen einer Diplomarbeit
|
||||
|
||||
Um ein privates GIT-Repository mit der HTLLE-DA-Vorlage anzulegen oder diese zu einem bereits bestehenden GIT-Repository in einem Unterverzeichnis hinzuzufügen, können Sie folgenden [Link](https://itsp.htl-leoben.at/ci/job/HTLLE-Diplomarbeit%20Erstelle%20Repository%20mit%20Template/build?delay=0sec) verwenden (ggf. mit LDAP Benutzername und Passwort z.B.: "1911wit00" anmelden).
|
||||
|
||||
Das Repository muss dem eingeloggten Benutzer gehören bzw. wird es für diesen erstellt.
|
||||
|
||||
- `REPOSITORY_NAME` setzen Sie bitte den Namen Ihres bereits bestehenden oder neuen Repositories (z.B.: "Diplomarbeit")
|
||||
- `GIT_PATH` hier können Sie ein Unterverzeichnis in GIT für Ihre Arbeit angeben
|
||||
|
||||
Sie bekommen anschließend eine E-Mail an Ihre Office365 Adresse mit weiteren Informationen und Links zu Ihrem Repository.
|
||||
|
||||
Fahren Sie bitte mit dem [Befüllen der speziellen Dateien](#befüllen-der-speziellen-dateien) fort.
|
||||
|
||||
### Build on Commit
|
||||
|
||||
Möchten Sie Ihre Diplomarbeit bei jedem GIT-Commit erstellen und an die - in der `metadata.yaml` genannten - E-Mail-Adressen zuschicken lassen, dann befolgen Sie diese Schritte:
|
||||
- E-Mail an <hg@htl-leoben.at> oder <lcle@htl-leoben.at>
|
||||
- Betreff: [Jenkins] Add Build-Job DA
|
||||
- Body:
|
||||
- Name: [Kürzel von Besitzer]-DA-remote-trigger (z.B.: *199wit99-DA-remote-trigger*)
|
||||
- Repository: z.B.: *https://itsp.htl-leoben.at/git/199wit99/test_da.git*
|
||||
- GIT Path: z.B.: *./text*
|
||||
- GIT Branch: z.B.: *\*/master*
|
||||
- Webhook in Gitea
|
||||
- Einen **Gogs**-Webhook zum Repository hinzufügen (*Repository -> Settings -> Webhooks -> Add Webhook*)
|
||||
- Target URL: https://itsp.htl-leoben.at/ci/gogs-webhook/?job=\[job-name\] (z.B.: *https://itsp.htl-leoben.at/ci/gogs-webhook/?job=199wit99-DA-remote-trigger*)
|
||||
- Secret: **secureStudent**
|
||||
|
||||
## Manuelles erstellen einer Diplomarbeit
|
||||
|
||||
Wenn Sie mit einer neuen Diplomarbeit beginnen, dann gehen Sie am besten wie folgt vor:
|
||||
@ -468,6 +440,10 @@ Bei speziellen Fragen zu diesem Vorgehen wenden Sie sich bitte an den Programmie
|
||||
* Machen Sie Grafiken in guter Auflösung (> 72 dpi) und Achten Sie darauf dass diese nicht zu viel oder zu wenig Inhalt zeigen weil die Grafiken auf max. Seitenbreite skaliert werden können und dann entweder zu klein oder zu pixelig erscheinen.
|
||||
* Orientieren sie die Grafiken so wie sie selbige in der Arbeit haben wollen. Wenn sie Grafiken um 90 Grad drehen, dann drehen Sie alle Grafiken in die selbe Richtung !
|
||||
* Quellenangaben nicht vergessen (bei selbst erstellen Bildern: 'Eigene Darstellung')
|
||||
* Manchmal treten bei der Verwendung von Bildern Probleme auf. Hier ein best-of:
|
||||
* Die extension von Bildern ist wichtig! `MeinBild.drawio.png` kann verhindern das eine DA korrekt baut, während `MeinBild-drawio.png` zu passenden Ergebnissen führt.
|
||||
* Umlaute in Dateinamen verhinden auf manchen Maschinen das die Bilder eingefügt werden -> Also keine verwenden.
|
||||
* Groß und Kleinschreibung der Dateinamen ist wichtig. Am besten verwenden Sie nur kleinschreibung mit Bindestrichen.
|
||||
|
||||
### Quellenangaben
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user