Skip to content
GitLab
Commit 30cd8243 authored by Wolfgang Knopki's avatar Wolfgang Knopki
Browse files

adapted help to new workflow

parent f8a45f95
Hide whitespace changes
Inline Side-by-side
help/gitlab-pages.html
View file @ 30cd8243
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
<p><a href="https://de.wikipedia.org/wiki/GitLab">GitLab</a> ist eine umfangreiche Webanwendung zur Versionsverwaltung für Softwareprojekte auf Basis von <a href="https://de.wikipedia.org/wiki/Git">Git</a> 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 <a href="https://docs.gitlab.com/ee/user/project/pages/">GitLab Pages </a> besteht für Angehörige der HFT die Möglichkeit, eine öffentliche statische Projektwebsite aus einem GitLab-Projekt heraus zu erzeugen. <p><a href="https://de.wikipedia.org/wiki/GitLab">GitLab</a> ist eine umfangreiche Webanwendung zur Versionsverwaltung für Softwareprojekte auf Basis von <a href="https://de.wikipedia.org/wiki/Git">Git</a> 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 <a href="https://docs.gitlab.com/ee/user/project/pages/">GitLab Pages </a> besteht für Angehörige der HFT die Möglichkeit, eine öffentliche statische Projektwebsite aus einem GitLab-Projekt heraus zu erzeugen.
</p><p> </p><p>
Die URL, unter der die Seite dann zu finden ist, lautet: <br/> <br/> Die URL, unter der die Seite dann zu finden ist, lautet: <br/> <br/>
<p class="justify-content-lg-start text-center">https://transfer.hft-stuttgart.de/pages/PROJEKTNAME/</p> <p class="justify-content-lg-start text-center">https://transfer.hft-stuttgart.de/pages/EIGENTUEMER/PROJEKTNAME/</p>
</p> </p>
</div> </div>
<a class="btn btn-primary text-center d-inline-flex d-lg-flex flex-column flex-grow-1 flex-shrink-1 flex-fill justify-content-between align-items-baseline align-content-center align-self-baseline flex-wrap order-3 mb-auto justify-content-md-center align-items-md-end align-items-lg-center justify-content-xl-center mx-auto" <a class="btn btn-primary text-center d-inline-flex d-lg-flex flex-column flex-grow-1 flex-shrink-1 flex-fill justify-content-between align-items-baseline align-content-center align-self-baseline flex-wrap order-3 mb-auto justify-content-md-center align-items-md-end align-items-lg-center justify-content-xl-center mx-auto"
...@@ -63,10 +63,13 @@ ...@@ -63,10 +63,13 @@
<li> Legen Sie sich auf <a href="https://transfer.hft-stuttgart.de"> https://transfer.hft-stuttgart.de</a> ein Benutzerkonto an bzw. loggen Sie sich mit Ihren HFT-Nutzerdaten in das Transferportal ein.</li> <li> Legen Sie sich auf <a href="https://transfer.hft-stuttgart.de"> https://transfer.hft-stuttgart.de</a> ein Benutzerkonto an bzw. loggen Sie sich mit Ihren HFT-Nutzerdaten in das Transferportal ein.</li>
<li> Besuchen Sie die Website <a href="https://transfer.hft-stuttgart.de/gitlab/explore/projects">https://transfer.hft-stuttgart.de/gitlab/explore/projects</a></li> <li> Besuchen Sie die Website <a href="https://transfer.hft-stuttgart.de/gitlab/explore/projects">https://transfer.hft-stuttgart.de/gitlab/explore/projects</a></li>
<li> Loggen Sie sich mit ihren Anmeldedaten ein </li> <li> Loggen Sie sich mit ihren Anmeldedaten ein </li>
<li> Standardmäßig wird Ihr Projekt als persönliches Projekt veröffentlicht, es wird also an Ihren persönlichen Benutzernamen gekoppelt, der dann auch in der URL auftaucht. Wenn Sie dies nicht wünschen, erstellen Sie eine neue Gruppe, unter der Sie das Projekt erstellen. Klicken Sie dazu auf <em>Groups</em>, <em> Your Groups </em> und wählen <em> New group </em> aus. Hier können Sie nun der Gruppe einen entsprechenden Namen geben. <p> <strong> Wichtig: </strong> Dieser Name wird später auch in der URL auftauchen, unter der Ihre Seite aufrufbar ist.</p> Nach Klick auf <em>create group</em> wird Ihre Gruppe angelegt, und Sie werden automatisch zur Gruppenseite weitergeleitet.
<img src="/img/help/newgroup.png" width="95%"/>
</li>
<li> Legen Sie ein neues Projekt an, indem Sie auf den Button <em> New Project </em> klicken <li> Legen Sie ein neues Projekt an, indem Sie auf den Button <em> New Project </em> klicken
<img src="/img/help/newproject.png" width="95%"/> <img src="/img/help/newproject.png" width="95%"/>
</li> </li>
<li> Wählen Sie <em> Create from template </em> aus und nutzen Sie das Template <em> </em> aus dem Bereich <em> Instance </em>, Klicken Sie dort auf <em> Use template</em> <img src="/img/help/fromtemplate.png" width="95%"/> <img src="/img/help/choosetemplate.png" width="95%"/> </li> <li> Wählen Sie <em> Create from template </em> aus und nutzen Sie ein Template aus dem Bereich <em> Instance </em>, Klicken Sie dort auf <em> Use template</em> <img src="/img/help/fromtemplate.png" width="95%"/> <img src="/img/help/choosetemplate.png" width="95%"/> </li>
<li> Nun können Sie ihr Projekt befüllen. Tragen Sie mindestens die Grundinformationen wie <em> Project name </em> und <em> Project description </em> ein.<img src="/img/help/createproject.png" width="95%"/> </li> <li> Nun können Sie ihr Projekt befüllen. Tragen Sie mindestens die Grundinformationen wie <em> Project name </em> und <em> Project description </em> ein.<img src="/img/help/createproject.png" width="95%"/> </li>
<li> Klicken Sie auf <em> Create project</em></li> <li> Klicken Sie auf <em> Create project</em></li>
<li> <li>
...@@ -76,12 +79,15 @@ ...@@ -76,12 +79,15 @@
<li> <li>
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 <a href="#template_Text">Gitlab-pages Template benutzen</a> 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 <a href="#template_Text">Gitlab-pages Template benutzen</a>
</li> </li>
<li> <li id="li_url">
Sobald Sie mit dem Inhalt der Seite zufrieden sind, und diese veröffentlichen wollen, informieren Sie den Administrator unter <a href="mailto:support-transfer@hft-stuttgart.de">support-transfer@hft-stuttgart.de</a>. Dieser wird dann Ihr Projekt das erste Mal auf den Server hochladen, für weitere Schritte gehen Sie zum nächsten Abschnitt. Sobald Sie Änderungen an Ihrer Seite vornehmen und diese in den Master-Branch eintragen (der Standard-Branch ihres Projektes), wird das Projekt veröffentlicht. Um den Link zu sehen, unter dem Sie Ihre Seite finden, gehen Sie in der Sitebar auf der linken Seite unter <em>CI / CD </em> auf <em>Jobs</em> und wählen den obersten Job mit den Namen <em> pages </em> aus. Im nun angezeigten Log finden Sie die Adresse, unter der Ihr Projekt ausgerollt wurde.
<img src="/img/help/show_jobs.png" width="95%">
<img src="/img/help/log_link.png" width="95%">
</li>
<li>
Für weitere Schritte gehen Sie zum nächsten Abschnitt.
</li> </li>
</ol> </ol>
<a class="btn btn-primary text-center d-inline-flex d-lg-flex flex-column flex-grow-1 flex-shrink-1 flex-fill justify-content-between align-items-baseline align-content-center align-self-baseline flex-wrap order-3 mb-auto justify-content-md-center align-items-md-end align-items-lg-center justify-content-xl-center mx-auto"
role="button" style="background-color: #E0001B;" href="mailto:support-transfer@hft-stuttgart.de"><strong>Administratorkontakt</strong></a>
</div> </div>
</div> </div>
<br/> <br/>
...@@ -125,6 +131,28 @@ ...@@ -125,6 +131,28 @@
</p> </p>
</div> </div>
</div> </div>
<div class="card">
<div class="card-header">
<h3 class="card-title">
<a class="collapsed" data-toggle="collapse" href="#collapse2" aria-expanded="false" aria-controls="collapse2">
<small>Gitlab-pages Seite entfernen</small></a>
</h3>
</div>
<div id="collapse2" class="card-body collapse" style="">
<p>
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:
<ol>
<li>
Klicken Sie in der linken Sitebar auf <em> Settings </em> und <em>pages </em>.
</li>
<li>
Klicken Sie in der sich nun öffnenden Konfigurationsansicht auf <em> Remove pages </em>. Dies entfernt die Seite von unserem Server, das Projekt an sich bleibt aber erhalten.
</li>
</ol>
</p>
</div>
</div>
</div> </div>
</div> </div>
</div> </div>
...@@ -135,14 +163,19 @@ ...@@ -135,14 +163,19 @@
<div class="container" style="background-color: #ffffff;"> <div class="container" style="background-color: #ffffff;">
<div style="margin-bottom: 0;padding-top: 20px;padding-bottom: 20px;"> <div style="margin-bottom: 0;padding-top: 20px;padding-bottom: 20px;">
<div class="col-lg-12"> <div class="col-lg-12">
<h2 class="d-flex flex-column order-1 justify-content-lg-start text-center" style="padding-top: 15px;color: #708090;"><strong>Häufige Fehlermeldungen und deren Korrektur</strong></h2> <h2 class="d-flex flex-column order-1 justify-content-lg-start text-center" style="padding-top: 15px;color: #708090;"><strong>Häufige Fragen und Probleme</strong></h2>
</div> </div>
<div class="col-auto" style="background-color: #ffffff;"> <div class="col-auto" style="background-color: #ffffff;">
<p> <p>
<ul> <ul>
<li> <li>
<h6> This job is stuck because you don't have any active runners online or available with any of these tags assigned to them: production </h6> <h6> Pipeline schlägt beim Schritt <em> pages-test </em> fehl </h6>
<p> In diesem Fall ist Ihr Projekt höchstwahrscheinlich noch nicht registriert oder es liegt ein anderes Problem vor. Kontaktieren Sie den Administrator </p> <p> In diesem Fall ist Ihr Projekt noch nicht vollständig konfiguriert. Bitte konfigurieren Sie ihr Projekt entsprechend der Vorlage im nächsten Abschnitt </p>
</li>
<li>
<h6> Ich habe ein Gitlab-pages-Projekt erstellt, unter <em>Settings/ pages</em> steht aber eine kryptische URL der Form *.thishost.local:8090/*, die nicht funktioniert. </h6>
<p> 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, folgen Sie den Schritten <a href="#li_url"> hier </a>. </p>
</li> </li>
</ul> </ul>
</p> </p>
...@@ -158,7 +191,7 @@ ...@@ -158,7 +191,7 @@
<div class="container" style="background-color: #ffffff;"> <div class="container" style="background-color: #ffffff;">
<div style="margin-bottom: 0;padding-top: 20px;padding-bottom: 20px;"> <div style="margin-bottom: 0;padding-top: 20px;padding-bottom: 20px;">
<div class="col-lg-12"> <div class="col-lg-12">
<h2 class="d-flex flex-column order-1 justify-content-lg-start text-center" style="padding-top: 15px;color: #708090;"><strong>Gitlab-pages Template benutzen</strong></h2> <h2 class="d-flex flex-column order-1 justify-content-lg-start text-center" style="padding-top: 15px;color: #708090;"><strong>Gitlab-pages Template <em>pages-basic</em> benutzen</strong></h2>
</div> </div>
<div class="col-auto" style="background-color: #ffffff;"> <div class="col-auto" style="background-color: #ffffff;">
<p> <p>
...@@ -207,12 +240,7 @@ ...@@ -207,12 +240,7 @@
Klicken Sie anschließend auf <em> commit changes </em>, um die Änderungen zu speichern. Klicken Sie anschließend auf <em> commit changes </em>, um die Änderungen zu speichern.
</p> </p>
</li> </li>
<li>
Nun können Sie den Administrator kontaktieren, der Ihr Projekt am Runner registriert, um das Projekt auf unserem Server auszurollen.
</li>
</ol> </ol>
<a class="btn btn-primary text-center d-inline-flex d-lg-flex flex-column flex-grow-1 flex-shrink-1 flex-fill justify-content-between align-items-baseline align-content-center align-self-baseline flex-wrap order-3 mb-auto justify-content-md-center align-items-md-end align-items-lg-center justify-content-xl-center mx-auto"
role="button" style="background-color: #E0001B;" href="mailto:support-transfer@hft-stuttgart.de"><strong>Administratorkontakt</strong></a>
</div> </div>
</div> </div>
<br/> <br/>
...@@ -309,7 +337,7 @@ ...@@ -309,7 +337,7 @@
</li> </li>
<li> <li>
Ihre Seite wird nun automatisch auf den Server übertragen und ist unter folgender Adresse erreichbar: Ihre Seite wird nun automatisch auf den Server übertragen und ist unter folgender Adresse erreichbar:
<p>https://transfer.hft-stuttgart.de/pages/PROJEKTNAME/DATEINAME</p> <p>https://transfer.hft-stuttgart.de/pages/EIGENTUEMER/PROJEKTNAME/DATEINAME</p>
</li> </li>
</ol> </ol>
</p> </p>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Dies ist die Gitlab-Instanz des Transferportals der Hochschule für Technik Stuttgart. Hier geht es zurück zum Portal