Jamdesk Documentation logo

Ihr erster Build

Was nach der Verbindung eines Repositorys passiert – Build-Phasen, der Tab „Deployments“ und was bei Fehlern zu prüfen ist.

Ihr erster Build startet automatisch, sobald Sie ein Repository verbinden.

Automatische Builds

Wenn Sie ein Repository verbinden, startet Jamdesk sofort einen initialen Build. Jeder weitere Push in Ihren verbundenen Branch löst automatisch einen neuen Build aus.

Build-Fortschritt

Verfolgen Sie Ihren Build im Dashboard:

1
Warteschlange

Ihr Build wartet auf den Start. Zu Spitzenzeiten kann es eine kurze Warteschlange geben.

2
Klonen

Jamdesk ruft den Inhalt Ihres Repositorys von GitHub ab.

3
Validieren

Ihre docs.json- und MDX-Dateien werden auf Fehler geprüft.

4
Build wird erstellt

MDX wird mit Syntaxhervorhebung und Suchindexierung in optimiertes HTML kompiliert.

5
Wird bereitgestellt

Die erstellten Dateien werden in das globale CDN hochgeladen.

6
Live

Ihre Dokumentation ist unter der URL Ihres Projekts verfügbar.

Ihre Live-Dokumentation anzeigen

Sobald der Build abgeschlossen ist, klicken Sie im Dashboard auf View Site oder rufen Sie https://your-project.jamdesk.app auf.

Wenn Sie eine benutzerdefinierte Domain konfiguriert haben, ist Ihre Dokumentation auch dort verfügbar.

Manuellen Build starten

Müssen Sie einen Build starten, ohne Änderungen zu pushen?

  1. Öffnen Sie Ihr Projekt im Dashboard
  2. Öffnen Sie Settings
  3. Klicken Sie auf Rebuild

Verwenden Sie diese Funktion nach Änderungen an Umgebungsvariablen oder um einen neuen Build zu erzwingen.

Wenn Ihr Build fehlschlägt

Fehlgeschlagene Builds zeigen eine Fehlermeldung im Dashboard an. Häufige Ursachen:

  • Ungültige Syntax in docs.json
  • MDX-Syntaxfehler
  • Fehlende Seiten, auf die in der Navigation verwiesen wird
Referenz zu Build-Fehlern

Hier finden Sie häufige Fehlercodes und Informationen zu ihrer Behebung

Verwandte Artikel

Builds auslösen

Erfahren Sie mehr über automatische und manuelle Build-Auslöser

Builds überwachen

Verfolgen Sie den Build-Fortschritt und zeigen Sie Protokolle an