Erste Schritte

Diese Anleitung hilft Ihnen, wenn Sie Ihr erstes Projekt mit den Document Writing Tools starten möchten. Nach der Einrichtung mithilfe dieser Anleitung werden Sie die notwendigen Dateistrukturen aufgesetzt haben, die wichtigsten Konfigurationen vorgenommen haben und im Ergebnis eine PDF/UA-Datei sowie die Web-Ansicht Light (GitLab Page) erhalten haben.

Voraussetzungen

• Sie haben einen Account auf openCode
• Sie haben die notwendigen Berechtigungen, um ein neues Projekt zu erstellen

1️⃣ Projekt aus Template erstellen

1. Melden Sie sich bei openCode an
2. Klicken Sie auf New Project
3. Wählen Sie die Kachel Import project aus
4. Klicken Sie auf 🔗 Repository by URL
5. Fügen Sie unter Git repository URL den Link zu dem Template-Repository ein:
   • https://gitlab.opencode.de/open-code/document-writing-tools/muster-projekt.git
6. Benennen Sie optional das Projekt um oder passen Sie den Projekt-Pfad an
7. Passen Sie optional die Sichtbarkeit an (beachten Sie die openCode Richtlinien zu nicht öffentlichen Projekten)
8. Klicken Sie auf Create project

Sie haben nach diesem Schritt ein einsatzbereites Projekt mit den für Sie vorkondigurierten Document Writing Tools angelegt. In dem Projekt finden Sie verschiedene Beispieldateien die Ihnen zeigen, wie Sie die Tools nutzen können.

Die eigentlichen Inhalte finden Sie dabei in dem Ordner dokument. In dem Ordner template finden Sie die Styling-Vorlage für die PDF (template.tex) sowie einen Unterordner assets, welcher für das PDF-Template relevante Dateien (z.B. Hintergrund des Deckblatts), aber auch für die Web-Version relevante Dateien (z.B. Schriftarten) enthält.

2️⃣ Erste Pipeline ausführen

Nachdem Sie auf Basis des Muster-Projekts ein neues Projekt erstellt haben, können Sie die erste Pipeline ausführen. Die Pipeline erzeugt die PDF/UA sowie die Web-Ansicht Light (GitLab Page) und stellt diese automatisiert bereit.

1. Navigieren Sie in der linken Seitenleiste unter Build zu Pipelines
2. Klicken Sie auf New pipeline
3. Lassen Sie den Branch auf main eingestellt, fügen Sie keine Variablen hinzu
4. Klicken Sie auf New pipeline, um die Pipeline zu starten
5. Die Pipeline ist nun im Status pending oder running
6. Sobald bei der Stage artifact-generation der Job `document-writing-ci-component:full-pdf“ in den Status success (grüner Haken) wechselt, können Sie die PDF/UA herunterladen
   1. Klicken Sie dafür auf den Job document-writing-ci-component:full-pdf
   2. Klicken Sie rechts in der Seitenleiste unter Job artifacts auf Download oder Browse
7. Sobald die Stages build und deploy in den Status success (grüner Haken) wechseln, steht die Web-Ansicht Light (GitLab Page) zur Verfügung
   1. Navigieren Sie zur Startseite Ihres Projekts
   2. Klicken Sie rechts in der Seitenleiste auf den Link GitLab Pages

3️⃣ Anpassungen vornehmen

Sie haben jetzt die erste Pipeline erfolgreich ausgeführt und die PDF/UA sowie die Web-Ansicht Light erhalten. Sie können nun die Inhalte anpassen. Jede Änderung (Commit) löst automatisch eine neue Pipeline aus.

openCode bietet Ihnen zum Bearbeiten der Inhalte eine Web-IDE an. Diese können Sie über den Button Edit aufrufen.

4️⃣ Weitere Informationen

• Konfiguration der CI-Components
• Tipps zur Dateistruktur, Markdown-Syntax und vielem mehr