GitLab ist eine umfangreiche Webanwendung zur Versionsverwaltung für Softwareprojekte auf Basis von Git die auch Wiki-Funktionen und Issue Tracking bietet. Das Transferportal der HFT-Stuttgart betreibt eine eigene GitLab-Instanz für die Hochschule für Technik Stuttgart und ihre Kooperationspartner unter einer Open-Access-Lizenz. Mit GitLab Pages besteht für Angehörige der HFT die Möglichkeit, eine öffentliche statische Projektwebsite aus einem GitLab-Projekt heraus zu erzeugen.
Die URL, unter der die Seite dann zu finden ist, lautet:
https://transfer.hft-stuttgart.de/pages/EIGENTUEMER/PROJEKTNAME/
Um ein eigenes Gitlab-pages Projekt zu erstellen und damit eine eigene Projektseite zu erstellen, führen Sie folgende Schritte aus:
Wichtig: Dieser Name wird später auch in der URL auftauchen, unter der Ihre Seite aufrufbar ist.
Nach Klick auf create group wird Ihre Gruppe angelegt, und Sie werden automatisch zur Gruppenseite weitergeleitet.Nachdem Ihr Projekt das erste Mal veröffentlicht wurde, möchten Sie sicherlich Änderungen an der Seite vornehmen. Dafür gehen Sie wie folgt vor:
Um Ihre gitlab-pages Seite zu entfernen, gibt es zwei Möglichkeiten. Sie können entweder das gesamte Projekt löschen, oder aber nur die öffentliche Seite, das Projekt aber behalten, um daran Änderungen vorzunehmen. Um nur die Seite, nicht aber das Projekt an sich zu löschen, gehen Sie wie folgt vor:
In diesem Fall ist Ihr Projekt noch nicht vollständig konfiguriert. Bitte konfigurieren Sie ihr Projekt entsprechend der Vorlage im nächsten Abschnitt
Dies ist die interne Repräsentation des Projektes auf unserem Server und ist somit nicht von außerhalb ereichbar. Um die tatsächliche, von außen erreichbare URL Ihrer Seite zu finden, gehen Sie in der Sitebar auf der linken Seite unter CI / CD auf Jobs und wählen den obersten Job mit den Namen pages aus. Im nun angezeigten Log finden Sie die Adresse, unter der Ihr Projekt ausgerollt wurde.
Gegenwärtig ist die Gesamtgröße der ausgerollten Seite (Ordner public ) auf 2 GB beschränkt.
Wir stellen eine Vorlage für Projektwebseiten zur Verfügung.
A template can be a single page or it can be multiple pages with a menu to select them. If the name of a template begins with the word "simple" then it is a single page template. This is the general structure of a template:
assets folder: You place in this folder files that should be common for the single page or all the pages of your gitlab template. E.g. you should place any personal avatars or partner logos in the corresponding folders (images, logos).
home folder: This is the default folder where you place your main page (think of it as the landing page).
settings.js: This is the file where you select the settings for your gitlab page.
You should not make changes to some of the files.
Red: Those files should not be changed.
Orange: Those files should be replaced by your own files. The filename should remain the same. If there are files that should be replaced depends on the template you choose.
Green: Those files you can edit.
Blue: In those folders you can add your additional files. In case of assets, images, logos etc. In case of a template folder, your custom css, javascript or any other files.
Um unsere Vorlage zu benutzen, müssen Sie folgende Schritte ausführen:
Wichtig: Werden diese Werte nicht angepasst, wird das Projekt nicht auf unseren Servern ausgerollt und die deployment-Pipeline wirft einen Fehler
Klicken Sie dazu im Ordner public auf die Datei settings.js und editieren Sie die Datei.
Those are the default values for the social networks/personal website of a participant and the default avatar. It is recommended not to change them, but you can add another social network if you want.
The switches control which parts of you gitlab page should turn on or off. E.g. if you want a single page and not a menu then you change the menu value to OFF.
Here you change the project logo. The logo will appear centered at the top of the page. If the switch for the project logo is OFF then it will not be visible.
Here you change the project name. If the switch for the project name is OFF then it will not be visible.
Here you change the menu of your gitlab page. A menu can be linked with a folder/template or with an external link, e.g. a demo. You can add or remove menu entries. You hide the menu when the switch is OFF. Don't forget to add the forward slash at the end of a menu link if it is pointing to a folder.
Here you change the participants. You can use default values for a social network (They point to HFT's social networks) or you can use your own profiles. You can also add your personal webpage. You can add or remove a social network. You can also use a personal avatar or the default one (DEFAULT.avatar).
Here is an example of two participants.
Here you change the footer logos of a project's partners. If you don't want a logo to link to an external website then use the href value EMPTY_LINK. The title will appear when you hover the mouse over a logo.
Klicken Sie anschließend auf commit changes , um die Änderungen zu speichern.
To add a personal avatar:
Um ein eigenes Projektlogo zum Projekt hinzuzufügen, müssen Sie folgende Schritte ausführen:
The logo should be square with dimentions 300x300 pixels
In der Zeile mit projectLogo schreiben Sie nun DATEINAME in die Anführungszeichen, um den Pfad zum Logo anzugeben. Ein Klick auf Commit changes speichert die Datei.
Um Ihrem Projekt neue Seiten hinzuzufügen, führen Sie folgende Schritte aus:
https://transfer.hft-stuttgart.de/pages/EIGENTUEMER/PROJEKTNAME/DATEINAME
This is a single page template with arbitrary content. In order to change the contents you have to edit the index.html file.
This is a single page template for a thesis. Inside the home folder you have to replace the files with the cover of your thesis and the actual thesis file. Then you have to edit the index.html file and replace your name, year, etc.
When you use the generic template there is an additional folder called templates. Inside this folder you will find all the available templates. In order to use a template, you have to copy the folder from templates/<template name> and paste it (when you edit your pages locally) in the root folder. Then it’s a good practice to rename this folder with the menu text you want to link it. Notice that the home page always points to the home folder. That means if you want to use a template as home page then you have to rename the folder to home.