Projekteinstellungen
Konfigurieren Sie Projektname, Repository-Verbindung, eigene Domain, Build-Trigger und erweiterte Einstellungen auf der Projektseite im Jamdesk-Dashboard.
Konfigurieren Sie auf der Seite „Settings“ den Anzeigenamen Ihres Projekts, das verbundene Repository, den Branch, Umgebungsvariablen, die eigene Domain und die Optionen der Gefahrenzone.
Zugriff auf die Einstellungen
- Wählen Sie Ihr Projekt im Dashboard aus
- Klicken Sie in der Seitenleiste auf Settings
Die Seite „Settings“ ist in Abschnitte für Anzeige, Repository, Team, Konfiguration und Benachrichtigungen unterteilt.
Die Screenshots zeigen die Benutzeroberfläche auf Englisch.
Allgemeine Einstellungen
Projektname
Der Anzeigename in Ihrem Dashboard. Er wirkt sich nicht auf Ihre live veröffentlichte Dokumentation aus.
Subdomain
Ihre Standard-URL unter *.jamdesk.app. So ändern Sie sie:
- Geben Sie eine neue Subdomain ein
- Klicken Sie auf Save
- Warten Sie auf die DNS-Propagierung (meist sofort)
Änderungen an der Subdomain unterbrechen bestehende Links nicht. Die alte URL leitet auf die neue weiter.
Repository-Einstellungen
Verbundenes Repository
Ihr verknüpftes GitHub-Repository. Um das Repository zu wechseln, müssen Sie das Projekt löschen und ein neues anlegen.
Branch
Der Git-Branch, der Builds auslöst. Typischerweise main oder master.
Dokumentationspfad
Pfad zu Ihrer docs.json in einem Monorepo (z. B. packages/docs).
Lassen Sie das Feld leer, wenn sich docs.json im Stammverzeichnis des Repositories befindet.
Build-Einstellungen
Umgebungsvariablen
Legen Sie Variablen fest, die während des Builds für Ihre Dokumentation verfügbar sind:
- Klicken Sie auf Add Variable
- Geben Sie den Schlüssel und den Wert ein
- Klicken Sie auf Save
Die Variablen stehen während des Builds zur Verfügung. Sie können in Ihrer Dokumentation darauf verweisen.
Neu erstellen
Klicken Sie auf Rebuild, um einen neuen Build zu starten, ohne an GitHub zu pushen. Verwenden Sie dies nach Änderungen an den Einstellungen.
Benutzerdefinierte Domain
Fügen Sie Ihre eigene Domain im Abschnitt Domains hinzu. Anleitung zur Einrichtung finden Sie unter Eigene Domains.
Gefahrenbereich
Projekt löschen
Löscht das Projekt und alle zugehörigen Daten dauerhaft:
- Build-Verlauf
- Analysedaten
- Konfiguration der eigenen Domain
Diese Aktion kann nicht rückgängig gemacht werden. Erwägen Sie eine Übertragung des Eigentums, wenn Teammitglieder weiterhin Zugriff benötigen.