Zum Hauptinhalt springen

Ein neues Repository erstellen

Wichtiger Hinweis

Zielgruppe
Diese Seite wendet sich ausschließlich an technisch verantwortliche Personen.

Voraussetzungen
Sie benötigen eine lokale Git-Installation auf Ihrem Computer und ein Terminal.

Der erste Schritt zur neuen Dokumentationswebsite ist die Anlage des Projekt-Repositories. Wir starten nicht mit einem leeren Projekt, sondern erstellen eine eigenständige Kopie des zentralen Templates.

1. Import durchführen​

Wir nutzen die Import-Funktion von GitLab, um den aktuellen Stand des Templates in ein neues Projekt zu kopieren. Dies stellt sicher, dass wir keine technische Abhängigkeit (Verknüpfung) zum Template-Repository behalten.

Die Quell-URL des Templates lautet: https://gitlab.opencode.de/fitko/docs/docusaurus-template.git

Führen Sie folgende Schritte durch:

  1. Neues Projekt anlegen: Klicken Sie in der Ziel-Gruppe in GitLab auf die Schaltfläche New project.

  2. Option "Import project" wählen: Wählen Sie die Kachel Import project aus.

  3. Quelle "Repository by URL" wählen: Klicken Sie auf die Schaltfläche Repository by URL.

  4. Daten eingeben:

    • Git repository URL: Fügen Sie die oben genannte URL des Templates ein.
    • Project name: Der Name Ihrer neuen Dokumentation (z. B. Handbuch OZG-Umsetzung).
    • Project slug: Der URL-Pfad (z. B. handbuch-ozg).
    • Visibility Level: Wählen Sie Public. Unsere Dokumentationsprojekte sind grundsätzlich öffentlich zugänglich.

  5. Erstellen: Klicken Sie auf Create project.

GitLab importiert nun das Projekt. Nach Abschluss haben Sie eine Kopie, die jedoch noch die gesamte Änderungshistorie des Templates enthält.

2. Historie bereinigen (Reset)​

Da es sich um ein neues, unabhängiges Projekt handelt, wird die Git-Historie des Templates bereinigt. Das Repository startet mit einem frischen Commit als neue Basisversion.

Wichtig: Branch-Protection aufheben

Der Hauptzweig (main) ist standardmäßig gegen das Überschreiben der Historie geschützt. Bevor Sie die folgenden Befehle ausführen können, müssen Sie diesen Schutz kurzzeitig entfernen:

  1. Navigieren Sie im Projekt zu Settings > Repository.
  2. Klappen Sie den Bereich Protected branches aus.
  3. Suchen Sie in der Liste den Eintrag main.
  4. Klicken Sie rechts auf die Schaltfläche Unprotect (oder das Mülleimer-Symbol / "Allow force push"), um den Schutz aufzuheben.

Befehle ausführen​

Voraussetzung: Sie benötigen eine lokale Git-Installation und ein Terminal. Führen Sie folgende Befehle aus, um alles auf einen einzigen "Initial Commit" zurückzusetzen:

# 1. Klonen Sie das soeben erstellte Repository auf Ihren Rechner
# (Ersetzen Sie die URL durch die Ihres neuen Projekts!)
git clone https://gitlab.opencode.de/IHRE-GRUPPE/IHR-PROJEKT.git
cd IHR-PROJEKT

# 2. Erstellen Sie einen verwaisten Branch (ohne Eltern-Historie)
git checkout --orphan temp-main

# 3. Fügen Sie alle aktuellen Dateien diesem neuen Branch hinzu
git add -A

# 4. Erstellen Sie den neuen Start-Commit
git commit -m "Initial commit: Projekt aufgesetzt"

# 5. Löschen Sie den alten main-Branch (der die alte Historie enthält)
git branch -D main

# 6. Benennen Sie den aktuellen Branch in main um
git branch -m main

# 7. Überschreiben Sie das Repository auf dem Server (Force Push)
git push -f origin main
Wichtig: Branch wieder schützen

Nachdem die Historie erfolgreich bereinigt wurde, sollten Sie den Branch sofort wieder schützen, um versehentliche Löschungen in Zukunft zu verhindern.

  • Gehen Sie zurück zu Settings > Repository > Protected branches.
  • Wählen Sie bei Branch den Eintrag main aus.
  • Stellen Sie Allowed to merge auf Maintainers.
  • Stellen Sie Allowed to push auf No one (oder Maintainers, je nach Arbeitsweise).
  • Klicken Sie auf Protect.

Nächster Schritt​

Das Repository ist bereitgestellt und „sauber“.
Um die Webseite online verfügbar zu machen, muss nun die Verbindung zur Deployment-Umgebung hergestellt werden.

Gehen Sie dazu weiter zur Seite Bereitstellung.