gitlab-pages.html 51 KB
Newer Older
1
2
3
4
5
6
<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
7
    <title>Hilfe: Gitlab-Pages</title>
8
9
10
11
12
13
14
15
16
17
18
    <link rel="stylesheet" href="/css/bootstrap.min.css">
    <link rel="stylesheet" href="/css/m4lab.css">
    <link rel="stylesheet" href="/fonts/font-awesome.min.css">
    <link rel="stylesheet" href="/fonts/ionicons.min.css">
    <link rel="stylesheet" href="/css/Testimonials.css">
    <link rel="stylesheet" href="/css/help.css">
    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.8.2/css/all.css" integrity="sha384-oS3vJWv+0UjzBfQzYUhtDYW+Pj2yciDJxpsK1OYPAYjqT085Qq/1cq5FLXAZQ7Ay" crossorigin="anonymous">
</head>

<body>

19
    <div class="background_dadada">
20
    
Wolfgang Knopki's avatar
Wolfgang Knopki committed
21
        <div class="container background_ffffff margin_bottom_30">
22
23
            <div class="row">
            </div>
24
       </div> 
Wolfgang Knopki's avatar
Wolfgang Knopki committed
25
26
27
        <div id="Gitlab_Text" class="margin_top_bottom">
            <div class="container background_ffffff">
                <div class="padding_top_bottom">
28
                    <div class="col-lg-12">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
29
                        <h2 class="d-flex flex-column flex-shrink-1 justify-content-lg-start text-center mailinglist_heading"><strong>Gitlab-pages</strong></h2>
30
                    </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
31
                    <div class="col-auto flex-row flex-grow-1 flex-fill background_ffffff">
32
33
34
                        <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>
                        Die URL, unter der die Seite dann zu finden ist, lautet: <br/> <br/>  
Wolfgang Knopki's avatar
Wolfgang Knopki committed
35
                        <p class="justify-content-lg-start text-center">https://transfer.hft-stuttgart.de/pages/EIGENTUEMER/PROJEKTNAME/</p>
36
37
                        </p>
                    </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
38
39
                    <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 background_e0001b"
                            role="button" href="https://transfer.hft-stuttgart.de/gitlab/explore/projects"><strong>Zugriff auf Gitlab</strong></a>
40
41
42
                </div>
            </div>
        </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
43
44
        <div id="create_Text" class="margin_middle">
            <div class="container background_ffffff">
45
                <div class="padding_top_bottom">
46
                    <div class="col-lg-12">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
47
                        <h2 class="d-flex flex-column order-1 justify-content-lg-start text-center mailinglist_heading"><strong>Gitlab-pages Projekte</strong></h2> 
48
                    </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
49
                    <div class="col-auto background_ffffff">
50
51
52
53
54
55
56
57
                        <div class="help">
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
                                        <a class="collapsed" data-toggle="collapse" href="#collapse1" aria-expanded="false" aria-controls="collapse1">
                                        <small>Gitlab-pages Projekt erstellen</small></a>
                                    </h3>
                                </div>
Athanasios's avatar
Athanasios committed
58
                                <div id="collapse1" class="card-body collapse">
59
60
61
62
                                    <p>
                                        Um ein eigenes Gitlab-pages Projekt zu erstellen und damit eine eigene Projektseite zu erstellen, führen Sie folgende Schritte aus:
                                    </p>
                                    <ol>
63
                                        <li> Wenn Sie noch keinen HfT- oder Transferportal-Account haben, legen Sie sich auf <a href="https://transfer.hft-stuttgart.de/account/registration"> https://transfer.hft-stuttgart.de/account/registration</a> ein Benutzerkonto an.</li>
64
                                        <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>
65
                                        <li> Loggen Sie sich in gitlab mit Ihren Anmeldedaten ein (Klick auf <em>sign in</em>)</li>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
66
67
68
					<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>
69
70
71
                                        <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%"/>
                                        </li>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
72
                                        <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>
73
74
75
                                        <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> 
Athanasios's avatar
Athanasios committed
76
77
                                            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 <em> Public </em> angelegt. 
                                            <img src="/img/help/folderpublic.png" width="95%"/> <br/>
78
79
                                        </li>
                                        <li> 
80
                                            Um die Inhalte Ihres Projektes zu veründern und zu erweitern, 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> 
81
                                        </li>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
82
83
84
85
86
87
88
                                        <li id="li_url"> 
                                            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.
89
90
91
92
93
94
95
96
97
98
99
100
                                        </li>
                                    </ol>
                                </div>
                            </div>
                            <br/>
                            <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 Projekt ändern</small></a>
                                    </h3>
                                </div>
Athanasios's avatar
Athanasios committed
101
                                <div id="collapse2" class="card-body collapse">
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
                                    <p>
                                        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:
                                        <ol>
                                            <li> 
                                                Klicken Sie die Datei, die Sie ändern wollen, in der Projektübersicht an <img src="/img/help/content_index_marked.png" width="95%"/>
                                            </li>
                                            <li> 
                                                Klicken Sie in der sich nun öffnenden Dateiansicht auf <em> Edit </em> <img src="/img/help/file_view.png" width="95%"/>
                                            </li>
                                            <li> 
                                                Bearbeiten Sie ihre Datei 
                                            </li>
                                            <li> 
                                                Um die Änderungen zu speichern und auf ihrer Seite sofort zu übernehmen, klicken Sie auf <em> Commit changes </em> 
                                                <img src="/img/help/save_file.png" width="95%"/>
                                            </li>
                                            <li> 
                                                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.
                                                <img src="/img/help/pipeline_pending.png" width="95%"/><br/>
                                                Durch Klick auf eine Pipeline wird Ihnen eine Erklärung zum aktuellen Status angezeigt, der Sie auch eventuelle Probleme entnehmen können.
                                                <img src="/img/help/overview_pipelines.png" width="95%"/><br/>
                                                Eine fehlerfrei durchgelaufene Pipeline liefert etwa ein solches Ergebnis:
                                                <img src="/img/help/output.png" width="95%"/><br/>
                                                Für eine Übersicht über häufig auftretende Fehler und was man dagegen tun kann, siehe <a href="#error_Text"> hier </a>.
                                            </li>
                                            <li> Wenn die Änderungen an Ihrer Homepage ohne Probleme übernommen wurden, sehen Sie dies an einem grünen Haken in der Projektübersicht
                                                <img src="/img/help/pipeline_good.png" width="95%"/>
                                            </li>
                                        </ol>
                                    </p>
                                </div>
                            </div>
134
			    <br/>	
Wolfgang Knopki's avatar
Wolfgang Knopki committed
135
136
137
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
138
                                        <a class="collapsed" data-toggle="collapse" href="#collapsedel" aria-expanded="false" aria-controls="collapsedel">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
139
140
141
                                        <small>Gitlab-pages Seite entfernen</small></a>
                                    </h3>
                                </div>
Athanasios's avatar
Athanasios committed
142
                                <div id="collapsedel" class="card-body collapse">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
143
144
145
146
147
148
149
150
151
152
153
154
155
156
                                    <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>
					
157
                        </div>
158
159
160
161
                    </div>
                </div>
            </div>
        </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
162
        
163
        <div id="template_Text" class="margin_middle">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
164
165
            <div class="container background_ffffff">
                <div class="padding_top_bottom">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
166
                    <div class="col-lg-12">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
167
                        <h2 class="d-flex flex-column order-1 justify-content-lg-start text-center mailinglist_heading"><strong>Gitlab-pages Template <em>pages-basic</em>  benutzen</strong></h2>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
168
                    </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
169
                    <div class="col-auto background_ffffff">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
170
171
                        <p>
                            Wir stellen eine Vorlage für Projektwebseiten zur Verfügung.
172
                        </p>
173
174
175
176
                        <div class="help">
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
177
                                        <a class="collapsed" data-toggle="collapse" href="#collapse7" aria-expanded="false" aria-controls="collapse7">
178
179
180
                                        <small>Erste Schritte</small></a>
                                    </h3>
                                </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
                                <div id="collapse7" class="card-body collapse">
                                    <p>
                                        Um unsere Vorlage zu benutzen, müssen Sie folgende Schritte ausführen:
                                    </p>
                                    <ol>
                                        <li> Anpassen der Standardwerte in settings.js 
                                            <p><b> Wichtig: </b> Werden diese Werte nicht angepasst, wird das Projekt nicht auf unseren Servern ausgerollt und die deployment-Pipeline wirft einen Fehler 
                                            </p>
                                            <p> 
                                                Klicken Sie dazu im Ordner <em> public </em> auf die Datei <em> settings.js </em> und editieren Sie die Datei. 
                                            </p>
                                            <img src="/img/help/select_settings.png" width="95%"/>
                                            <p>
                                                Passen Sie die Werte für projektname und projektseitenlink an, indem Sie die entsprechenden Werte in die Anführungszeichen schreiben.
                                            </p>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
196
                                            <img src="/img/help/edit_settings_generic.png" width="95%"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
                                            <p>
                                                Klicken Sie anschließend auf <em> commit changes </em>, um die Änderungen zu speichern.
                                            </p>
                                        </li>
                                        <li> Anpassen der Kontaktperson in <em> kontakt.html </em>
                                            <p><b> Wichtig: </b> Wird die Kontaktperson nicht angepasst, wird das Projekt nicht auf unseren Servern ausgerollt und die deployment-Pipeline wirft einen Fehler 
                                            </p>
                                            <p> 
                                                Klicken Sie dazu im Ordner <em> public </em> auf die Datei <em> kontakt.html </em> und editieren Sie die Datei. 
                                            </p>
                                            <img src="/img/help/select_contact.png" width="95%"/>
                                            <p>
                                                Passen Sie die Kontaktperson und die Mailadresse an, indem Sie alle Vorkommen von Max Mustermann und die Mailadresse durch Ihre Werte ersetzen.
                                            </p>
                                            <img src="/img/help/edit_contact.png" width="95%"/>
                                            <p>
                                                Klicken Sie anschließend auf <em> commit changes </em>, um die Änderungen zu speichern.
                                            </p>
                                        </li>
                                    </ol>
                                </div>
                            </div>
                            <br/>
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
223
                                        <a class="collapsed" data-toggle="collapse" href="#collapse8" aria-expanded="false" aria-controls="collapse8">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
224
225
226
                                        <small>Logo hinzufügen</small></a>
                                    </h3>
                                </div>
227
                                <div id="collapse8" class="card-body collapse">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
228
229
230
231
232
233
234
                                    <p> Um ein eigenes Projektlogo zum Projekt hinzuzufügen, müssen Sie folgende Schritte ausführen: 
                                        <ol>
                                            <li>
                                                Öffnen Sie den Ordner <em> public </em> 
                                            </li>
                                            <li>
                                                Klicken Sie auf das + im Oberen Bereich, und anschließend auf <em> Upload File </em>
235
                                                <img src="/img/help/publicplus_generic.png" width="95%"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
                                            </li>
                                            <li>
                                                Fügen Sie die gewünschte Datei hinzu und klicken Sie auf <em> Upload File </em>
                                                <img src="/img/help/upload_logo.png" width="95%"/>
                                            </li>
                                            <li> 
                                                Öffnen Sie nun im Ordner <em> public </em> die Datei <em> settings.js </em> und editieren diese.
                                                <p>
                                                    In der Zeile mit <em>projektlogourl</em> schreiben Sie nun ./DATEINAME in die Anführungszeichen, um den Pfad zum Logo anzugeben. Ein Klick auf <em> Commit changes </em> speichert die Datei.
                                                </p>
                                                <img src="/img/help/settings_logo.png" width="95%"/>
                                            </li>
                                            <li>
                                                Nun erscheint auf all Ihren Seiten das Projektlogo neben dem Logo der Hochschule. 
                                            </li>
                                        </ol>
                                    </p>
                                </div>
                            </div>
                            <br/>
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
259
                                        <a class="collapsed" data-toggle="collapse" href="#collapse9" aria-expanded="false" aria-controls="collapse9">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
260
261
262
                                        <small>Neue Seite hinzufügen</small></a>
                                    </h3>
                                </div>
263
                                <div id="collapse9" class="card-body collapse">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
264
265
266
267
268
                                    <p>
                                        Um Ihrem Projekt neue Seiten hinzuzufügen, führen Sie folgende Schritte aus:
                                        <ol>
                                            <li>
                                                Klicken Sie im Ordner <em> public </em> auf das +, das sich oben neben dem Pfad befindet
269
                                                <img src="/img/help/publicplus_generic.png" width="95%"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
                                            </li>
                                            <li>
                                                Klicken Sie dort auf <em> New File </em>
                                            </li>
                                            <li>
                                                Geben Sie einen Dateinamen (<b> wichtig: </b> Endung .html) an und fügen Sie folgenden Standardtext ein:
                                                <textarea rows="28" cols="64" disabled="true">
                                                    <!DOCTYPE html>
                                                    <html>
                                                        <head>
                                                            <meta charset="utf-8">
                                                            <meta name="generator" content="GitLab Pages">
                                                            <title>Neue Seite</title>
                                                            <link rel="stylesheet" href="style.css">
                                                        </head>
                                                        <body>
                                                            <div id="topbar">
                                                                <div id="menu" class="navbar"></div>
                                                            </div>
                                                            <div class="content">
                                                                <h1 id='projectname'></h1> <!--Projektname kommt aus settings.js, hier nichts einfügen-->
                                                                
                                                                <!-- ÄNDERUNGEN NUR NACH DIESER ZEILE --> 
                                                                <h2> Seitentitel: </h2>
                                                                <p>
                                                                    Content
                                                                </p>
            
                                                                <!-- KEINE ÄNDERUNGEN NACH DIESER ZEILE -->  
                                                            </div>
                                                            <script src="settings.js"> </script>
                                                        </body>
                                                    </html>
                                                </textarea>
                                                <img src="/img/help/editnewpage.png" width="95%"/>
                                            </li>
                                            <li>
                                                Nun können Sie noch den Inhalt der Seite anpassen. Wenn Sie mit dem Inhalt der Seite zufrieden sind, speichern Sie sie durch Klick auf <em> Commit changes </em>
                                            </li>
                                            <li>
                                                Ihre Seite wird nun automatisch auf den Server übertragen und ist unter folgender Adresse erreichbar:
                                                <p>https://transfer.hft-stuttgart.de/pages/EIGENTUEMER/PROJEKTNAME/DATEINAME</p>
                                            </li> 
                                        </ol>
                                    </p>
                                </div>
                            </div>
                            <br/>
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
321
                                        <a class="collapsed" data-toggle="collapse" href="#collapse10" aria-expanded="false" aria-controls="collapse10">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
322
323
324
                                        <small>Menü bearbeiten</small></a>
                                    </h3>
                                </div>
325
                                <div id="collapse10" class="card-body collapse">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
                                    <p>
                                        Wenn Sie das Menü am oberen Seitenrand bearbeiten wollen, führen Sie folgende Schritte durch:
                                        <ol>
                                            <li>
                                                Öffnen Sie im Ordner <em> public </em> die Datei <em>settings.js</em> und editieren Sie diese.
                                            </li>
                                            <li>
                                                Im Menüblock kopieren Sie einen bereits bestehenden Teil und fügen diesen im Anschluss ein. Ein solcher Block besteht dabei aus folgenden Anweisungen:
                                                <img src="/img/help/settingmenublock.png" width="95%"/>
                                                <ul>
                                                    <li>
                                                        <em>//Link 4: Kontakt </em> Dies ist ein Kommentar, der der Ordnung und Verständlichkeit des Codes dient
                                                    </li>
                                                    <li>
                                                        <em>let NAME = document.createElement("a") </em> Dies legt einen neuen Eintrag fest 
                                                    </li>
                                                    <li>
                                                        <em>NAME.href = "addresse" </em> Dies legt die Adresse fest, auf die der neue Menüeintrag verweist. Dies kann zum Beispiel eine neu angelegte Seite sein.
                                                    </li>
                                                    <li>
                                                        <em>NAME.innerHTML="" </em> Dies legt den Text des Eintrags fest, also was später im Menü angezeigt wird
                                                    </li>
                                                    <li>
                                                        <em> menu.appendChild(NAME); </em> Dies fügt letztlich den Eintrag dem Menü hinzu.
                                                    </li>
                                                </ul>
                                            </li>
                                            <li>
                                                Nachdem Sie den Block entsprechend Ihrer Wünsche bearbeitet haben, klicken Sie auf <em> Commit changes </em>, um Ihre Änderungen zu speichern.
                                                <img src="/img/help/settingsnewmenublock.png" width="95%"/>
                                            </li>
                                        </ol>
                                    </p>
                                </div>
                            </div>
                        </div>
                </div>
            </div>
        </div>
        <div id="template_Text" class="margin_middle">
            <div class="container background_ffffff">
                <div class="margin_top_bottom">
                    <div class="col-lg-12">
                        <h2 class="d-flex flex-column order-1 justify-content-lg-start text-center mailinglist_heading"><strong>Gitlab-pages Templates <em>generic/ simple_raw / simple_thesis</em>  benutzen</strong></h2>
                    </div>
                    <div class="col-auto background_ffffff">
                        <p>
                            Wir stellen mehrere Vorlagen für Projektwebseiten zur Verfügung.
                        </p>
                        <div class="help">
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
                                        <a class="collapsed" data-toggle="collapse" href="#collapse3t" aria-expanded="false" aria-controls="collapse3t">
                                        <small>Erste Schritte</small></a>
                                    </h3>
                                </div>
                                <div id="collapse3t" class="card-body collapse">
Athanasios's avatar
Athanasios committed
384
                                    <p>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
385
386
387
                                        Eine Projektwebseite kann entweder aus einer einzelnen Seite oder aber aus mehreren Seiten mit einem Auswahlmenü bestehen.
                                        Falls der Name eines Templates mit "simple" beginnt, handelt es sich um ein Template mit einer einzigen Seite. Die allgemeine Struktur eines Templates sieht wie folgt aus:
                                        
Athanasios's avatar
Athanasios committed
388
389
                                    </p>
                                    <img src="/img/help/content_public.jpg"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
390
391
392
393
                                    <p><em>assets</em> Ordner: In diesem Ordner platzieren Sie alle Dateien, die alle Ihre Seiten des gitlab templates gemeinsm haben. Hier kommen zum Beispiel persönliche Avatare oder Partnerlogos in die entsprechenden Unterordner (images, logos).</p>
                                    <p><em>home</em> Ordner: Dies ist der Standardordner für Ihre Hauptseite.</p>
                                    <p><em>settings.js</em>: In dieser Datei wählen Sie die Einstellungen für Ihre gitlab-Seite.</p>
                                    <p>Sie sollten einige dieser Dateien anpassen.</p>
Athanasios's avatar
Athanasios committed
394
                                    <img src="/img/help/content_public_colors.jpg"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
395
396
397
398
                                    <p>Rot: Diese Dateien sollten nicht geändert werden.</p>
                                    <p>Orange: Diese Dateien sollten durch eigene Datein mit dem selben Dateinamen ersetzt werden. Ob Dateien ersetzt werden müssen, hängt vom Template ab.</p>
                                    <p>Grün: Diese Dateien können Sie ändern</p>
                                    <p>Blau: In diese Ordner können Sie zusätzliche Dateien platzieren. In den assets-Ordner zum Beispiel Bilder, Logos etc.; in den template-Ordner Ihr eigenes css, javascript oder weitere Dateien.</p>
399
400
401
402
                                    <p>
                                        Um unsere Vorlage zu benutzen, müssen Sie folgende Schritte ausführen:
                                    </p>
                                    <ol>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
403
                                        <li> Anpassen der Einstellungen in settings.js 
404
405
406
                                            <p> 
                                                Klicken Sie dazu im Ordner <em> public </em> auf die Datei <em> settings.js </em> und editieren Sie die Datei. 
                                            </p>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
407
                                            <img src="/img/help/select_settings_generic.png" width="95%"/>
408
                                            <p>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
409
                                                Hier sehen Sie die Standardwerde für Soziale Netzwerke und persönliche Webseiten eines Teilnehmers sowie den Standardavatar. Es wird empfohlen, diese Werte nicht zu ändern, aber Sie können weitere Soziale Netzwerke hinzufügen.
410
                                            </p>
Athanasios's avatar
Athanasios committed
411
                                            <img src="/img/help/default_settings.png"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
412
                                            <p>Diese Schalter kontrollieren, welche Teile der gitlab-Seite angezeigt werden sollen. Wenn Sie also beispielsweise nur eine einzige Seite haben, benötigen Sie kein Menü und können den Wert für 'menu' auf OFF stellen.</p>
Athanasios's avatar
Athanasios committed
413
                                            <img src="/img/help/switches.png"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
414
                                            <p>Hier ändern Sie das Projektlogo. Das Logo wird am oberen Rand der Seite mittig angezeigt. Wenn der Schalter für 'project logo' auf OFF steht, wird es nicht angezeigt.</p>
Athanasios's avatar
Athanasios committed
415
                                            <img src="/img/help/pr_logo.png"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
416
                                            <p>Hier ändern Sie den Projektnamen. Wenn der Schalter auf 'OFF' steht, wird kein Projektname angezeigt.</p>
Athanasios's avatar
Athanasios committed
417
                                            <img src="/img/help/pr_name.png"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
418
419
                                            <p>Hier ändern Sie das Menü Ihrer gitlab-Seite. Ein Menü kann entweder auf einen Unterordner/ template verweisen oder aber auf einen externen Link, z.B. eine Demo. Sie können Menüeinträge hinzufügen oder entfernen. Das Menü wird mit dem Schalter 'OFF' verborgen.
                                            Vergessen Sie nicht den Schrägstrich am Ende eines Menülinks, wenn dieser auf einen Ordner zeigt.
420
                                            </p>
Athanasios's avatar
Athanasios committed
421
                                            <img src="/img/help/menu.png"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
422
                                            <p>Hier ändern Sie die Teilnehmenden. Sie können die Standardwerte für Soziale Netzwerke (diese beinhalten die HFT-Kanäle) oder Ihr eigenen Profile verwenden. Sie können auf Ihre persönliche Webseite verlinken. Sie können soziale Netzwerke hinzufügen oder entfernen. Sie können auch einen persönlichen Avatar oder den Standard-Avatar (DEFAULT.avatar) verwenden.
423
                                            </p>
Athanasios's avatar
Athanasios committed
424
                                            <img src="/img/help/partic.png"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
425
                                            <p>Hier ist ein Beispiel mit zwei Teilnehmenden:
Athanasios's avatar
Athanasios committed
426
427
428
                                            </p>
                                            <img src="/img/help/partic2.png"/>
                                            <p>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
429
                                                Hier ändern Sie die Fußzeilenlogos z.B. zu denen von Projektpartnern. Wenn Sie das Logo nicht mit einer externen Webseite verlinken wollen, verwenden Sie EMPTY_LINK als Wert für href. Der Titel title wird bei Mouse-Hover über dem Logo erscheinen.
430
                                            </p>
Athanasios's avatar
Athanasios committed
431
                                            <img src="/img/help/f_logos.png"/>
432
433
434
                                            <p>
                                                Klicken Sie anschließend auf <em> commit changes </em>, um die Änderungen zu speichern.
                                            </p>
Athanasios's avatar
Athanasios committed
435

Wolfgang Knopki's avatar
Wolfgang Knopki committed
436
                                            <img src="/img/help/edit_settings_generic.png" width="95%"/>
Athanasios's avatar
Athanasios committed
437

438
439
440
441
442
443
444
445
                                        </li>
                                    </ol>
                                </div>
                            </div>
                            <br/>
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
446
                                        <a class="collapsed" data-toggle="collapse" href="#collapse4t" aria-expanded="false" aria-controls="collapse4t">
Athanasios's avatar
Athanasios committed
447
448
449
                                        <small>Avatar hinzufügen</small></a>
                                    </h3>
                                </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
450
451
                                <div id="collapse4t" class="card-body collapse">
                                    <p> Um einen persönlichen Avatar hinzuzufügen: 
Athanasios's avatar
Athanasios committed
452
453
454
455
456
457
458
459
                                        <ol>
                                            <li>
                                                Öffnen Sie den Ordner <em> public/assets/images </em> 
                                            </li>
                                            <li>
                                                Klicken Sie auf das + im Oberen Bereich, und anschließend auf <em> Upload File </em>
                                            </li>
                                            <li>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
460
                                                Wir empfehlen, dass das Bild quadratisch oder im Porträtformat ist. Zudem empfehlen wir keine allzu großen Bilder (>500px) hochzuladen.
Athanasios's avatar
Athanasios committed
461
462
463
464
465
466
467
468
469
                                            </li>
                                        </ol>
                                    </p>
                                </div>
                            </div>
                            <br/>
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
470
                                        <a class="collapsed" data-toggle="collapse" href="#collapse5t" aria-expanded="false" aria-controls="collapse5t">
471
472
473
                                        <small>Logo hinzufügen</small></a>
                                    </h3>
                                </div>
474
                                <div id="collapse5t" class="card-body collapse">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
475
                                    <p> Um ein eigenes Projektlogo zum Projekt hinzuzufügen, müssen Sie folgende Schritte ausführen: 
476
477
                                        <ol>
                                            <li>
Athanasios's avatar
Athanasios committed
478
                                                Öffnen Sie den Ordner <em> public/assets/logos </em> 
479
480
481
                                            </li>
                                            <li>
                                                Klicken Sie auf das + im Oberen Bereich, und anschließend auf <em> Upload File </em>
482
                                                <img src="/img/help/publicplus_generic.png" width="95%"/>
483
                                            </li>
Athanasios's avatar
Athanasios committed
484
485
                                            <li>
                                                <p>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
486
                                                    Das Logo sollte quadratisch mit einer Auflösung von 300x300 pixel sein.
Athanasios's avatar
Athanasios committed
487
488
                                                </p>
                                            </li>
489
490
491
492
493
494
495
                                            <li>
                                                Fügen Sie die gewünschte Datei hinzu und klicken Sie auf <em> Upload File </em>
                                                <img src="/img/help/upload_logo.png" width="95%"/>
                                            </li>
                                            <li> 
                                                Öffnen Sie nun im Ordner <em> public </em> die Datei <em> settings.js </em> und editieren diese.
                                                <p>
Athanasios's avatar
Athanasios committed
496
                                                    In der Zeile mit <em>projectLogo</em> schreiben Sie nun DATEINAME in die Anführungszeichen, um den Pfad zum Logo anzugeben. Ein Klick auf <em> Commit changes </em> speichert die Datei.
497
                                                </p>
Athanasios's avatar
Athanasios committed
498
                                                <img src="/img/help/pr_logo.png"/>
499
500
501
502
503
504
505
506
507
508
509
510
                                            </li>
                                            <li>
                                                Nun erscheint auf all Ihren Seiten das Projektlogo neben dem Logo der Hochschule. 
                                            </li>
                                        </ol>
                                    </p>
                                </div>
                            </div>
                            <br/>
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
511
                                        <a class="collapsed" data-toggle="collapse" href="#collapse6t" aria-expanded="false" aria-controls="collapse6t">
512
513
514
                                        <small>Neue Seite hinzufügen</small></a>
                                    </h3>
                                </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
515
                                <div id="collapse6t" class="card-body collapse">
516
517
518
                                    <p>
                                        Um Ihrem Projekt neue Seiten hinzuzufügen, führen Sie folgende Schritte aus:
                                        <ol>
Athanasios's avatar
Athanasios committed
519
                                            <li>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
520
                                                Gehen Sie in den templates-Ordner und editieren Sie die Datei index.html. Wählen Sie den gesamten Text in dieser Datei aus und kopieren ihn. Dann Klicken Sie auf <em>cancel</em>.
Athanasios's avatar
Athanasios committed
521
                                            </li>
522
523
                                            <li>
                                                Klicken Sie im Ordner <em> public </em> auf das +, das sich oben neben dem Pfad befindet
524
                                                <img src="/img/help/publicplus_generic.png" width="95%"/>
525
526
527
528
                                            </li>
                                            <li>
                                                Klicken Sie dort auf <em> New File </em>
                                            </li>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
529
                                            <li>Fügen Sie den Text, den Sie kopiert haben, ein</li>
530
                                            <li>
Athanasios's avatar
Athanasios committed
531
                                                Geben Sie die Dateinamen index.html (<b> wichtig: </b> Endung .html)
532
533
534
535
536
537
538
539

                                                <img src="/img/help/editnewpage.png" width="95%"/>
                                            </li>
                                            <li>
                                                Nun können Sie noch den Inhalt der Seite anpassen. Wenn Sie mit dem Inhalt der Seite zufrieden sind, speichern Sie sie durch Klick auf <em> Commit changes </em>
                                            </li>
                                            <li>
                                                Ihre Seite wird nun automatisch auf den Server übertragen und ist unter folgender Adresse erreichbar:
Wolfgang Knopki's avatar
Wolfgang Knopki committed
540
                                                <p>https://transfer.hft-stuttgart.de/pages/EIGENTUEMER/PROJEKTNAME/DATEINAME</p>
541
542
543
544
545
                                            </li> 
                                        </ol>
                                    </p>
                                </div>
                            </div>
Athanasios's avatar
Athanasios committed
546
547
548
549
550
                            <br/>
                            
                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
551
552
                                        <a class="collapsed" data-toggle="collapse" href="#collapse7t" aria-expanded="false" aria-controls="collapse7t">
                                        <small>simple_raw Vorlage</small></a>
Athanasios's avatar
Athanasios committed
553
554
                                    </h3>
                                </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
555
556
                                <div id="collapse7t" class="card-body collapse">
                                    <p>Dies is eine Vorlage mit einer einzigen Seite. Um den Inhalt anzupassen, ändern Sie die Datei index.html.</p>
Athanasios's avatar
Athanasios committed
557
558
559
560
561
562
563
564
                                </div>
                            </div>

                            <br/>

                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
565
566
                                        <a class="collapsed" data-toggle="collapse" href="#collapse8t" aria-expanded="false" aria-controls="collapse8t">
                                        <small>simple_thesis Vorlage</small></a>
Athanasios's avatar
Athanasios committed
567
568
                                    </h3>
                                </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
569
                                <div id="collapse8t" class="card-body collapse">
Athanasios's avatar
Athanasios committed
570
                                    <p>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
571
572
573
                                        Diese Vorlage hat eine einzelne Seite und ist für die Präsentation einer Studienarbeit (Bachelor- / Masterarbeit) gedacht. Im Home-Ordner müssen Sie die Dateien für Ihre Titelseite und die pdf Ihrer Arbeit austauschen. Klicken Sie dazu auf den 'Replace'-Knopf 
                                        <img src="/img/help/cover_thesis.png" width="95%"/>
                                        Anschließend müssen in der Datei index.html Ihr Name, das Jahr etc. angepasst werden.
Athanasios's avatar
Athanasios committed
574
575
576
577
578
579
580
581
582
                                    </p>
                                </div>
                            </div>

                            <br/>

                            <div class="card">
                                <div class="card-header">
                                    <h3 class="card-title">
Wolfgang Knopki's avatar
Wolfgang Knopki committed
583
584
                                        <a class="collapsed" data-toggle="collapse" href="#collapse9t" aria-expanded="false" aria-controls="collapse9t">
                                        <small>generic Vorlage</small></a>
Athanasios's avatar
Athanasios committed
585
586
                                    </h3>
                                </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
587
                                <div id="collapse9t" class="card-body collapse">
Athanasios's avatar
Athanasios committed
588
                                    <p>
589
                                        Wenn Sie die generic Vorlage wählen, finden Sie den zusätzlichen Ordner templates. In diesem Ordner finden Sie die für Unterseiten verfügbaren Vorlagen.
Wolfgang Knopki's avatar
Wolfgang Knopki committed
590
                                        Um eine solche Vorlage für eine Unterseite zu nutzen, kopieren Sie den Ordner aus templates/&lttemplate name&gt und kopieren Ihn unter neuem Namen in Ihrem root-Ordner. Bitte beachten Sie, dass dies nicht in Gitlabs Webclient geschehen kann, sondern Sie dazu lokal auf Ihren Rechner arbeiten müssen.
Wolfgang Knopki's avatar
Wolfgang Knopki committed
591
592
                                        Wenn Sie nur den Inhalt der Datei index.html im Ordner templates/&lttemplate name &gt kopieren wollen, klicken Sie auf den 'Datei kopieren' Button:
                                        <img src="/img/help/copy_content.png" width="95%"/>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
593
                                        Die Startseite deutet dabei immer auf den Ordner home, wenn Sie also die Startseite ändern wollen, müssen Sie den Ordner in 'home' umbenennen.
Athanasios's avatar
Athanasios committed
594
595
596
597
598
                                    </p>
                                    <img src="/img/help/generic.png"/>
                                </div>
                            </div>                            

599
                        </div>
600
601
602
                </div>
            </div>
        </div>
Wolfgang Knopki's avatar
Wolfgang Knopki committed
603
        
604
605
606
607
608
609
610
611
612
613
614
615
616
         <div id="error_Text" class="margin_middle">
            <div class="container background_ffffff">
                <div class="padding_top_bottom">
                    <div class="col-lg-12">
                        <h2 class="d-flex flex-column order-1 justify-content-lg-start text-center mailinglist_heading"><strong>Häufige Fragen und Probleme</strong></h2> 
                    </div>
                    <div class="col-auto background_ffffff">
                        <p>
                            <ul>
                                <li>
                                    <h6> Pipeline schlägt beim Schritt <em> pages-test </em> fehl </h6>
                                    <p> In diesem Fall ist Ihr Projekt noch nicht vollständig konfiguriert. Bitte konfigurieren Sie ihr Projekt entsprechend der Vorlage im vorherigen Abschnitt.</p>
                                </li>
617
618
619
620
                                <li>
                                    <h6> Die Pipeline bleibt beim Schritt <em>pages</em> stecken </h6>
                                    <p> In diesem Fall hat Ihr Projekt noch keinen runner zugewiesen. Bitte stellen Sie in den Projekteinstellungen sicher, dass unter <em>CI/CD</em> in der Sektion <em>Runners</em> die shared runners aktiviert sind.</p>
                                </li>
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
                                <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, 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.</p>
                                </li>
				<li>
                                    <h6> Ich möchte größere Projektdaten hochladen, wie groß darf mein Projekt maximal sein? </h6>
                                    <p> Gegenwärtig ist die Gesamtgröße der ausgerollten Seite (Ordner <em> public </em>) auf 2 GB beschränkt.</p>
                                </li>
                            </ul>
                        </p>
                    </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 background_e0001b"
                            role="button" href="mailto:support-transfer@hft-stuttgart.de"><strong>Administratorkontakt</strong></a>
                </div>
            </div>
        </div>
        
        
639
640
641
642
643
644
645
646
647
648
    </div>
</div>

<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
<!--<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>-->
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<script src="/js/headfoot.js"></script>
</body>

</html>