Diese Dokumentation ist noch im Aufbau. Wir freuen uns über Feedback und Anregungen!

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 PDFPortable Document Format/UAUniversal Accessibility-Datei sowie die Web-Ansicht Light (GitLabGitLab ist eine umfassende, webbasierte DevOps-Plattform (Entwicklungs- und Betriebplattform) für die Verwaltung von Git-Repositories, kontinuierliche Integration (CI) und kollaborative Softwareentwicklung. Page) erhalten haben.

Voraussetzungen

1️⃣ Projekt aus Template erstellen

  1. Melden Sie sich bei openCodeopenCode ist die Plattform für digitale Souveränität. Sie bringt Open Source in den öffentlichen Sektor Deutschlands. Gemeinsam entwickeln und teilen wir Software, die unsere digitale Zukunft selbstbestimmt gestaltet. an
  2. Klicken Sie auf New Project
  3. Wählen Sie die Kachel Import project aus
  4. Klicken Sie auf 🔗 RepositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert. by URLUniform Resource Locator – Die Adresse, die zur Angabe des Speicherorts einer Ressource im Internet verwendet wird.
  5. Fügen Sie unter Git repositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert. URLUniform Resource Locator – Die Adresse, die zur Angabe des Speicherorts einer Ressource im Internet verwendet wird. den Link zu dem Template-RepositoryEin zentraler, versionskontrollierter Speicherort für Quellcode und zugehörige Dateien, der die gemeinsame Entwicklung und Änderungsverfolgung erleichtert. 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 openCodeopenCode ist die Plattform für digitale Souveränität. Sie bringt Open Source in den öffentlichen Sektor Deutschlands. Gemeinsam entwickeln und teilen wir Software, die unsere digitale Zukunft selbstbestimmt gestaltet. 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 PDFPortable Document Format (template.tex) sowie einen Unterordner assets, welcher für das PDFPortable Document Format-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 PipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback. ausführen. Die PipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback. erzeugt die PDFPortable Document Format/UAUniversal Accessibility sowie die Web-Ansicht Light (GitLabGitLab ist eine umfassende, webbasierte DevOps-Plattform (Entwicklungs- und Betriebplattform) für die Verwaltung von Git-Repositories, kontinuierliche Integration (CI) und kollaborative Softwareentwicklung. Page) und stellt diese automatisiert bereit.

  1. Navigieren Sie in der linken Seitenleiste unter Build zu PipelinesEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback.
  2. Klicken Sie auf New pipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback.
  3. Lassen Sie den BranchEin Branch in der Softwareentwicklung ist ein unabhängiges Arbeitsgebiet, das aus der Hauptlinie der Entwicklung abgezweigt wird. Entwickler können an einem Branch unabhängig arbeiten, ohne die Hauptlinie zu beeinträchtigen. auf main eingestellt, fügen Sie keine Variablen hinzu
  4. Klicken Sie auf New pipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback., um die PipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback. zu starten
  5. Die PipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback. 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 PDFPortable Document Format/UAUniversal Accessibility 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 (GitLabGitLab ist eine umfassende, webbasierte DevOps-Plattform (Entwicklungs- und Betriebplattform) für die Verwaltung von Git-Repositories, kontinuierliche Integration (CI) und kollaborative Softwareentwicklung. Page) zur Verfügung
    1. Navigieren Sie zur Startseite Ihres Projekts
    2. Klicken Sie rechts in der Seitenleiste auf den Link GitLabGitLab ist eine umfassende, webbasierte DevOps-Plattform (Entwicklungs- und Betriebplattform) für die Verwaltung von Git-Repositories, kontinuierliche Integration (CI) und kollaborative Softwareentwicklung. Pages

3️⃣ Anpassungen vornehmen

Sie haben jetzt die erste PipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback. erfolgreich ausgeführt und die PDFPortable Document Format/UAUniversal Accessibility sowie die Web-Ansicht Light erhalten. Sie können nun die Inhalte anpassen. Jede Änderung (CommitEin Commit ist ein zentraler Vorgang in der Softwareentwicklung und Versionskontrolle. Er beschreibt das Bestätigen und Speichern einer oder mehrerer Änderungen und erstellt dabei eine Momentaufnahme aller Dateien im Projekt zu diesem Zeitpunkt.) löst automatisch eine neue PipelineEine Pipeline bezeichnet eine Reihe automatisierter Schritte zur Optimierung des Softwarebereitstellungsprozesses. Dazu gehören das Bauen, Testen und Bereitstellen von Code. Dies verbessert den Entwicklungsprozess durch Automatisierung, besonders während Integrations- und Testphasen, reduziert manuelle Fehler, beschleunigt Produktzyklen und liefert kontinuierliches Feedback. aus.

openCodeopenCode ist die Plattform für digitale Souveränität. Sie bringt Open Source in den öffentlichen Sektor Deutschlands. Gemeinsam entwickeln und teilen wir Software, die unsere digitale Zukunft selbstbestimmt gestaltet. bietet Ihnen zum Bearbeiten der Inhalte eine Web-IDE an. Diese können Sie über den Button Edit aufrufen.

4️⃣ Weitere Informationen