diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f0adc87f53a54f8f73d65dde0c4861d0fbc39f76..91b9c9096e9aee43f409fc755a3de2c7a3c170dc 100755 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -14,7 +14,8 @@ pages-master: - cp -r img .public - cp -r fonts .public - cp -r images .public - - cp -r downloads .public + - cp -r downloads .public + - cp -r help .public - cp -r js .public - cp *.html .public - mv .public public @@ -37,6 +38,7 @@ pages-devel: - cp -r js .public - cp -r img .public - cp -r downloads .public + - cp -r help .public - cp -r fonts .public - cp *.html .public - mv .public public diff --git a/css/help.css b/css/help.css new file mode 100644 index 0000000000000000000000000000000000000000..98736e2474383cc0149015b43c0fab764eb5e586 --- /dev/null +++ b/css/help.css @@ -0,0 +1,3 @@ +img{ + padding-bottom: 20px; +} diff --git a/css/m4lab.css b/css/m4lab.css index 5a005998b898c0441d85715dff42c5b0652776aa..f23f6a76c98439b37c04b84ebef2630a344c1587 100644 --- a/css/m4lab.css +++ b/css/m4lab.css @@ -255,4 +255,70 @@ justify-content:space-evenly;} background-color: #f1f1f1; padding: 20px; padding-right: 60px; -} \ No newline at end of file +} + +.card { + position: relative; + display: -ms-flexbox; + display: flex; + -ms-flex-direction: column; + flex-direction: column; + min-width: 0; + word-wrap: break-word; + background-color: #fff; + background-clip: border-box; + border: 1px solid rgba(0, 0, 0, 0.125); + border-radius: 0.25rem; +} + +.card-body { + -ms-flex: 1 1 auto; + flex: 1 1 auto; + padding: 1.25rem; +} + +.card-header { + padding: 0.75rem 1.25rem; + margin-bottom: 0; + background-color: rgba(0, 0, 0, 0.03); + border-bottom: 1px solid rgba(0, 0, 0, 0.125); +} + +.card-header:first-child { + border-radius: calc(0.25rem - 1px) calc(0.25rem - 1px) 0 0; +} + +.card-header + .list-group .list-group-item:first-child { + border-top: 0; +} + +.help .card-title > a:before { + float: right !important; + content: "-"; + padding-right: 5px; +} +.help .card-title > a.collapsed:before { + float: right !important; + content: "+"; +} +.help h3 > a { + color: #708090; + text-decoration: none; + display: block; +} +.help a { + display: inline; +} +.help .card > .card-header { + color: #fff; +} +.card-title { + margin-bottom: 0.5rem; + margin-top: 0.5rem; +} +#infoicon { + color: #708090; +} +.heading { + color: #708090; +} diff --git a/help/gitlab-pages.html b/help/gitlab-pages.html new file mode 100644 index 0000000000000000000000000000000000000000..e779bb5715688ee712928ac6f58a2576bcc115b6 --- /dev/null +++ b/help/gitlab-pages.html @@ -0,0 +1,380 @@ + + + +
+ + +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/
+ ++ Um ein eigenes Gitlab-pages Projekt zu erstellen und damit eine eigene Projektseite zu erstellen, führen Sie folgende Schritte aus: +
++ 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: +
+
In diesem Fall ist Ihr Projekt höchstwahrscheinlich noch nicht registriert oder es liegt ein anderes Problem vor. Kontaktieren Sie den Administrator
++ Wir stellen eine Vorlage für Projektwebseiten zur Verfügung. +
++ 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. +
+ ++ Passen Sie die Werte für projektname und projektseitenlink an, indem Sie die entsprechenden Werte in die Anführungszeichen schreiben. +
+ ++ Klicken Sie anschließend auf commit changes , um die Änderungen zu speichern. +
+Wichtig: Wird die Kontaktperson 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 kontakt.html und editieren Sie die Datei. +
+ ++ Passen Sie die Kontaktperson und die Mailadresse an, indem Sie alle Vorkommen von Max Mustermann und die Mailadresse durch Ihre Werte ersetzen. +
+ ++ Klicken Sie anschließend auf commit changes , um die Änderungen zu speichern. +
+Um ein eigenes Projektlogo zum Projekt hinzuzufügen, müssen Sie folgende Schritte ausführen: +
+ In der Zeile mit projektlogourl 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/PROJEKTNAME/DATEINAME
++ Wenn Sie das Menü am oberen Seitenrand bearbeiten wollen, führen Sie folgende Schritte durch: +
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. +
++ Dann klicken Sie auf diesen + Link zu den Gitlab-Projekten + um die Liste aller im Gitlab erfassten Projekte zu sehen. Vor dort können Sie dann auf die einzelnen + Projekte zugreifen. + Ein Anmelden am Portal ist dazu nicht nötig. +
++ Sie können mittels Issues dem Projekteigentümer eine Rückmeldung geben bzw. einen Fehler melden. + Darüberhinaus können Sie sich auch aktiv beteiligen. Dazu müssen Sie im Portal als Nutzer + registriert sein. +
++ Wenn Sie noch kein Benutzerkonto haben, klicken Sie bitte oben auf den Link Benutzerkonto und folgen + Sie dem System durch die Registrierungsprozedur. +
++ Haben Sie ein Benutzerkonto, befolgen Sie bitte folgende Schritte: +
++ Vorraussetzung dazu ist, dass Sie aktives oder ehemaliges Mitglied der Hochschule für Technik sind, + d.h. eine (noch) gültige HFT-Emailadresse haben, und zudem im Portal als Nutzer registriert sein. +
++ Wenn Sie noch kein Benutzerkonto haben, klicken Sie bitte oben auf den Link Benutzerkonto und folgen + Sie dem System durch die Registrierungsprozedur. +
++ Haben Sie ein Benutzerkonto, befolgen Sie bitte folgende Schritte: +
++ Weitere Hilfestellung zum Anlegen von Projekten in Gitlab finden Sie in der Gitlab-Dokumentation. +
++ Hinweis: Um Inhalte zum Gitlab "pushen" zu können, verwendet die Gitlab-Instanz unseres Portals die + s.g. "SSH Keys". + Weitere Informationen dazu finden Sie in der + Gitlab-Dokumentation zu SSH Keys. +
++ Jitsi ist ein Open-Source-Videokonferenz-System für HFT-interne und externe Nutzer. Es ermöglicht, Videokonferenzen direkt im Browser abzuhalten. Wir empfehlen hierbei die Nutzung von Chrome auf einem Desktopsystem oder Laptop. Die Verwendung des Internet Explorers hierfür ist leider nicht möglich, da Jitsi über diesen nicht aufgerufen werden kann. Da die Daten-Hauptlast bei diesem System clientseitig getragen wird, raten wir von einer Nutzung auf mobilen Endgeräten ab. +
++
NAME_DER_LISTE@listserv.dfn.de
. + Je nach Konfiguration durch den Listenbetreiber wird Ihre Email direkt verteilt oder muss zunächst durch die Moderation freigegeben werden.+ Voraussetzung: Sie haben eine gültige HfT-Emailadresse oder eine Emailadresse eienr anderen Institution, die ebenfalls die Dienste des DFN (Deutsches Forschungsnetzwerk) in Anspruch nehmen darf. +
+ Achtung: Eine automatische Weitergabe Ihrer Logindaten vom Transferportal an diesen Dienst ist leider nicht möglich. Das bedeutet, sie können hier leider nicht Ihre Logindaten des Transferportals benutzen. Stattdessen müssen Sie beim DFN-Dienst einen eigenen Account anlegen. Dazu klicken Sie auf Erste Anmeldung und folgen Sie der Registrierungsprozedur. +
+ Sind Sie einmal registriert, können Sie sich mit Ihrer Email und dem selbstgewählten Passwort dann direkt anmelden. +
+ ++ Hinweis: Steht Ihnen der Menüpunkt nach dem Anmelden nicht zur Verfügung, dann hat Ihre Institution, die über Ihre Emailadresse identifiziert wird, leider nicht die Berechtigung, über diesen Dienst eine Mailingliste zu betreiben. +
+ +
+ Technische Hinweise:
+ Ein Klick auf das Fragezeichen im Formular öffnet die Direkthilfe vom DFN-Dienst zu den einzelnen Einstellungen.
+
+ Weitere Dokumentation des DFN ist über das Menü Support oder direkt auf https://www.listserv.dfn.de/sympa/help zu finden. +
+
+ Inhaltliche Hinweise:
Als Nutzer des Transferportals kommen für Sie wahrscheinlich nur zwei der im Formular genannten Listentypen in Frage: >öffentliche Diskussionsliste und Newsletter.
+
Als Orientierungshilfe, was man in die Freifeldtexte eingeben kann, zeigt die Abbildung, welche Einstellungen und Angaben wir für unsere Mailingliste zum Transferportal selbst gemacht haben. +
Hinweis: Wie der Bestätigungstext sagt, können Sie direkt mit der weiteren Konfiguration der Liste fortfahren, siehe die folgenden + Schritte. Die Liste wird aber erst durch Freigabe eines Listmasters des DFN in Betrieb gehen. Das dauert nach unserer Erfahrung beim Anlegen anderer Listen beim DFN zwischen wenigen Minuten und ungefähr einem Tag. +
+ ++ Wir konzentrieren uns hier nur auf die aus unserer Sicht wesentlichen Einstellungen, denn in der Regel sind die Default- Einstellungen des Systems ausreichend. +
++ Dabei orientieren wir uns wieder am Beispiel unserer eigenen Mailingliste zum Transferportal selbst. +
+ ++ Dort können Sie nochmals die Sichtbarkeit der Liste ändern – aus Sicht unseres Transferportals empfehlen wir die Einstellung sichtbar + (nonconceal). +
++ Zudem können Sie dort noch weitere Personen als Listeneigentümer oder Moderatoren angeben, die Ihnen beim Betrieb der Liste helfen können. +
++ Näheres zu den möglichen Rollen privilegierter Eigentümer, Eigentümer und Moderator siehe: https://www.listserv.dfn.de/sympa/help/introduction +
++ Bei den weiteren Einstellungen belassen wir es bei den Default-Werten. +
+ + + ++ Aus unserer Erfahrung empfehlen wir, sich zwei der Möglichkeiten genauer anzuschauen. +
++ Bei den anderen Einstellungen haben wir es für unsere Liste bei den Defaultwerten belassen. +
++ Hier gibt es eine Vielzahl von Optionen und Sie als Listenbetreiber müssen hier entscheiden. +
++ Für unsere Mailingliste zum Transferportal haben wir z.B. Beschränkt auf Abonnementen, Emails von anderen leise + ablehnen gewählt. +
++ Anmerkung: Abonnementen können in Ihren eigenen Einstellungen auswählen, ob sie die Emails direkt und einzeln empfangen, oder ob Sie ein Nachrichtenkompilat, also eine einmalige Zusammenstellung aller Emails seit dem letzten Kompilat erhalten. +
++ Ein üblicher Anwendungsfall ist hier der Daily Digest: Einmal täglich erhält ein Abonnement, sofern er nicht direkten Empfang ausgewählt hat, das Kompilat des vergangenen Tages. Diesen Fall haben wir auch für unsere Liste eingestellt, in dem wir die Häufigkeit auf jeden Wochentag gesetzt haben. +
++ Hier gibt es eine Vielzahl von Optionen und Sie als Listenbetreiber müssen hier entscheiden. +
++ Um Ihnen eine Orientierung zu geben, zeigt die Abbildung, welche Einstellungen wir für unsere Mailingliste transferportalhft vorgenommen haben. +
+ Wichtig! +
++ Die Listenbeschreibung, die Sie beim Erstellen der Liste eingetippt haben, erscheint so noch nicht auf der Listen-Homepage (in unserem Beispiel wäre das https://www.listserv.dfn.de/sympa/info/transferportalhft ), sondern zunächst nur in Infoemails des Systems. +
++ Um diesen Text zu überarbeiten und auf der Homepage Ihrer Webseite sichtbar zu machen, gehen Sie wie im Folgenden beschrieben vor: +
+ Wenn Sie diesen nochmal überarbeiten wollen, können Sie das hier tun und anschließend auf Speichern drücken. Es wird dann eine Bestätigung eingeblendet, sie bleiben aber dann auf der selben Seite. +
++ Kopieren Sie nun den Text und klicken Sie im roten Menü wieder auf Listenkonfiguration bearbeiten – Listenbeschreibung +
+ ++ Dieses öffnet den Beschreibungstext für die Webseite entsprechend der Abbildung, der zunächst noch leer ist. +
++ Hier können Sie den nun kopierten Text einfügen und ggf. bearbeiten. Anschließend bitte auf Speichern klicken. Damit ist die Beschreibung dann auch auf der Listenhomepage zu sehen. +
+ ++
+ Hintergrund: In der automatisch generierten Willkommensemail, die neue Abonnementen erhalten, gibt es zwei Stellen, in denen englischer Text vorkommt. +
++ Dazu klicken Sie zunächst im roten Menü auf Listenkonfiguration bearbeiten – Nachrichtenvorlagen. Dort gelangen Sie zu der Übersicht der Vorlagen aller Emails, die vom System an die Nutzer versendet werden können, siehe Abbildung +
+ ++ Klicken Sie nun auf „Bearbeiten Willkommensnachricht“ um diese bearbeiten zu können, siehe Abbildung. Diese Vorlage ist im wesentlichen ein Skript, welches das System ausführt, und sollte daher nur von Programmiererfahrenen geändert werden. Insbesondere die Bereiche mit den eckigen Klammern und Prozentzeichen sollten Sie nicht ändern, da hier Funktionalitäten aufgerufen werden. +
++ Allerdings empfehlen wir, dass Sie dennoch folgende zwei Änderungen vornehmen, um die Email zu 100% deutschsprachig zu machen: +
+ Sie haben nun Ihre Mailingliste eingerichtet und optimiert! +
++ Wenn Sie nun noch möchten, dass Ihre Mailinglist auch auf unserem Transferportal gelistet wird, nehmen Sie bitte mit uns Kontakt auf: + support-transfer@hft-stuttgart.de +
++ Hintergrund: Eine technische Möglichkeit, dieses automatisch zu tun, steht uns leider (noch) nicht zu Verfügung. +
++ Nachdem Sie die Liste nun eingerichtet haben, empfehlen wir die Erläuterungen des DFN-Dienstes zu den Themen "Datenschutzkonforme Konfiguration" sowie "Verhaltensregeln für Administratoren" +
++ Und zu guter Letzt: +
++ Um die Abonnementen zu verwalten, finden Sie im roten Administrationsmenü die Seite Abonnementen verwalten mit selbsterklärenden Einstellungen. +
+ +Jitsi ist ein Open-Source-Videokonferenz-System für HFT-interne und externe Nutzer. Es ermöglicht, Videokonferenzen direkt im Browser abzuhalten. Wir empfehlen hierbei die Nutzung von Chrome auf einem Desktopsystem oder Laptop.
Die Verwendung des Internet Explorers hierfür ist leider nicht möglich, da Jitsi über diesen nicht aufgerufen werden kann. Da die Daten-Hauptlast bei diesem System clientseitig getragen wird, raten wir von einer Nutzung auf
- mobilen Endgeräten ab.
Aktuelle Informationen und Tutorials zu Jitsi finden Sie auf den Confluence-Seiten der HFT Stuttgart (Intranet).
Um Jitsi zu nutzen gehen Sie folgendermaßen vor:
-
+ Aktuelle Informationen und Tutorials zu Jitsi finden Sie auf den Confluence-Seiten der HFT Stuttgart (Intranet).
Eine Anleitung zur Nutzung von Jitsi finden Sie in unserem Hilfebereich
+