Gitlab-pages

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/PROJEKTNAME/

Zugriff auf Gitlab

Gitlab-pages Projekte

Um ein eigenes Gitlab-pages Projekt zu erstellen und damit eine eigene Projektseite zu erstellen, führen Sie folgende Schritte aus:

  1. Legen Sie sich auf https://transfer.hft-stuttgart.de ein Benutzerkonto an bzw. loggen Sie sich mit Ihren HFT-Nutzerdaten in das Transferportal ein.
  2. Besuchen Sie die Website https://transfer.hft-stuttgart.de/gitlab/explore/projects
  3. Loggen Sie sich mit ihren Anmeldedaten ein
  4. Legen Sie ein neues Projekt an, indem Sie auf den Button New Project klicken
  5. Wählen Sie Create from template aus und nutzen Sie das Template aus dem Bereich Instance , Klicken Sie dort auf Use template
  6. Nun können Sie ihr Projekt befüllen. Tragen Sie mindestens die Grundinformationen wie Project name und Project description ein.
  7. Klicken Sie auf Create project
  8. Ihr Projekt wird nun erstellt und enthält automatisch die notwendigen Grundeinstellungen für das Publizieren einer Website über die Funktion Pages. Vor allem wird im Repositorium der Ordner Public angelegt.
    In diesem Ordner befinden sich die Dateien index.html, aktuelles.html , style.css und settings.js. Diese sorgen für Inhalt (aktuelles.html, index.html) und Aussehen (style.css) der statischen Webseite und enthalten allgemeine Projektinformationen (settings.js). Direkt nach Projekterstellung enthalten sie zunächst nur allgemeine, grundsätzliche Informationen aus dem Template.
  9. Um Ihre eigenen Projektinhalte zu veröffentlichen, können Sie entweder eine komplett eigene HTML-Seite erzeugen oder sich an unseren Vorgaben aus dem Template orientieren. Eine Anleitung zur Verwendung unserer Vorlage finden Sie im Bereich Gitlab-pages Template benutzen
  10. Sobald Sie mit dem Inhalt der Seite zufrieden sind, und diese veröffentlichen wollen, informieren Sie den Administrator unter support-transfer@hft-stuttgart.de. Dieser wird dann Ihr Projekt das erste Mal auf den Server hochladen, für weitere Schritte gehen Sie zum nächsten Abschnitt.
Administratorkontakt

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:

  1. Klicken Sie die Datei, die Sie ändern wollen, in der Projektübersicht an
  2. Klicken Sie in der sich nun öffnenden Dateiansicht auf Edit
  3. Bearbeiten Sie ihre Datei
  4. Um die Änderungen zu speichern und auf ihrer Seite sofort zu übernehmen, klicken Sie auf Commit changes
  5. In der Projektübersicht sehen Sie nun den Status der Deployment-Pipeline, die ihre Webseite auf unserem Server veröffentlicht. Durch Klick auf das Symbol gelangen Sie zu einer Übersicht aller für Ihr Projekt angelaufenen Pipelines.
    Durch Klick auf eine Pipeline wird Ihnen eine Erklärung zum aktuellen Status angezeigt, der Sie auch eventuelle Probleme entnehmen können.
    Eine fehlerfrei durchgelaufene Pipeline liefert etwa ein solches Ergebnis:
    Für eine Übersicht über häufig auftretende Fehler und was man dagegen tun kann, siehe hier .
  6. Wenn die Änderungen an Ihrer Homepage ohne Probleme übernommen wurden, sehen Sie dies an einem grünen Haken in der Projektübersicht

Häufige Fehlermeldungen und deren Korrektur

  • This job is stuck because you don't have any active runners online or available with any of these tags assigned to them: production

    In diesem Fall ist Ihr Projekt höchstwahrscheinlich noch nicht registriert oder es liegt ein anderes Problem vor. Kontaktieren Sie den Administrator

Administratorkontakt

Gitlab-pages Template benutzen

Wir stellen eine Vorlage für Projektwebseiten zur Verfügung.