Docs ohne GitHub

Du brauchst kein GitHub-Konto, um Dokumentation mit Jamdesk zu veröffentlichen. Wähle diese Option, wenn du sofort mit dem Schreiben beginnen und dich später für Git entscheiden möchtest. Du bearbeitest deine Inhalte im Editor des Dashboards oder auf deinem Computer mit der Jamdesk CLI, und jede veröffentlichte Änderung baut deine Website neu.

Projekt ohne GitHub einrichten

Deine Website ist unter your-project.jamdesk.app erreichbar, genau wie bei einem GitHub-Projekt.

Was anders funktioniert

Jamdesk besitzt das Repository, daher benötigt eine Funktion zuerst dein eigenes GitHub:

Um die KI-Übersetzung zu nutzen, verschiebe deine Dokumentation zu GitHub.

Auf deinem Computer bearbeiten

jamdesk pull lädt deine Dokumentation in einen Ordner herunter, der ein Git-Repository mit dem vollständigen Bearbeitungsverlauf ist. Du bearbeitest die Dateien dort, manuell oder mit einem KI-Coding-Agenten, und jamdesk deploy veröffentlicht sie.

Du benötigst CLI 1.1.227 oder neuer sowie git. Melde dich zuerst mit jamdesk login an.

jamdesk pull
cd your-project
jamdesk dev

Der Ordner trägt den Namen deines Projekt-Slugs. Wenn du mehrere Projekte ohne GitHub hast, fragt die CLI, welches heruntergeladen werden soll. Füge --project your-project hinzu, um die Frage zu überspringen, oder --dir, um den Ordner zu wählen.

Änderungen veröffentlichen

Führe jamdesk deploy von irgendeinem Ort innerhalb des Ordners aus:

jamdesk deploy -m "Fix install steps"

Deploy committet deine nicht gespeicherten Änderungen, veröffentlicht jeden neuen Commit und startet einen Build. Ohne -m lautet die Commit-Nachricht „Update docs“. Commits, die du selbst mit git erstellt hast, werden ebenfalls veröffentlicht. Wenn sich nichts geändert hat, gibt deploy Nothing new to publish. aus und stoppt.

Änderungen aus Jamdesk übernehmen

Änderungen aus dem Editor des Dashboards, aus Fix with AI oder aus einem Deploy eines Teammitglieds gelangen nicht von allein in deinen Ordner. Wenn Jamdesk Änderungen hat, die dir fehlen, bricht deploy ab, bevor etwas veröffentlicht wird. Dein Commit bleibt im Ordner erhalten. Führe die Jamdesk-Änderungen zusammen und deploye danach erneut:

jamdesk pull
jamdesk deploy

Innerhalb des Ordners führt jamdesk pull die Jamdesk-Änderungen in deine Kopie ein. Der Befehl läuft nicht, solange du nicht gespeicherte Änderungen hast. Committe sie zuerst oder führe jamdesk deploy aus.

Konflikte beheben

Ein Konflikt entsteht, wenn dieselben Zeilen sowohl in deinem Ordner als auch in Jamdesk geändert wurden. Pull stoppt dann mit Some files changed both here and in Jamdesk.

1. Führe git status aus, um die Dateien mit Konflikten anzuzeigen.
2. Öffne jede Datei, behalte den gewünschten Text und lösche die Zeilen <<<<<<<, ======= und >>>>>>>.
3. Committe die Zusammenführung mit git add -A und git commit --no-edit.
4. Führe jamdesk deploy aus.

Deploy verweigert Dateien, die noch Konfliktmarkierungen enthalten.

Dateien, die deploy nicht veröffentlicht

Deploy prüft deine Änderungen, bevor etwas committet wird. Findet es eine dieser Dateien, listet es sie auf und veröffentlicht nichts:

• Dateien, die nach Geheimnissen aussehen, etwa service_account.json oder Namen, die mit secret beginnen. Seiten (.md- und .mdx-Dateien) werden nie als Geheimnisdateien behandelt. Wenn die Dateien unbedenklich sind, führe jamdesk deploy --allow-secret-files aus.
• Alles im Ordner .github.
• Symbolische Links sowie Ordner, die ihr eigenes Git-Repository sind.
• Dateien über 25 MB.
• Textdateien mit übrig gebliebenen Konfliktmarkierungen.

Deploy committet niemals Dateien wie .env, .env.*, private Schlüssel (*.pem, *.key) und Credential-Dateien, auch nicht mit --allow-secret-files. Git ignoriert sie in diesem Ordner.

Deploy prüft auch Commits, die du selbst mit git erstellt hast. Eine abgelehnte Datei in einem früheren Commit blockiert das Deploy, selbst wenn ein späterer Commit sie löscht. Die Fehlermeldung zeigt den Befehl git reset --soft, mit dem du diese Commits auflöst, damit du die Dateien korrigieren kannst.

Ein Deploy kann bis zu 100 MB an Änderungen veröffentlichen.

Sicherung in dein eigenes Repository

Du kannst einen eigenen git-Remote hinzufügen, zum Beispiel ein privates Repository für Backups, und wie gewohnt dorthin pushen. Jamdesk veröffentlicht nur, was du mit jamdesk deploy sendest. Ein Push zu deinem Remote ändert deine Website also nicht. Benenne deinen eigenen git-Remote nicht jamdesk. Die CLI verwendet diesen Namen für ihren Eintrag, welchen Stand Jamdesk hat, und ein Remote mit demselben Namen bricht dein nächstes Deploy, bis du jamdesk pull ausführst.

Eine alte Kopie in ein git-Repository umwandeln

Kopien, die mit CLI 1.1.226 erstellt wurden, sind keine git-Repositories, und jamdesk deploy kann sie nicht veröffentlichen. Um Bearbeitungen zu behalten, die du darin vorgenommen hast, wechsle in den Ordner der Kopie (den mit docs.json) und führe aus:

jamdesk pull --force

Deine Dateien bleiben unverändert und erscheinen als nicht gespeicherte Änderungen. Seiten, die du nach dem Herunterladen der Kopie in Jamdesk hinzugefügt hast, werden dem Ordner hinzugefügt. Seiten, die du in der alten Kopie gelöscht hast, kehren ebenfalls zurück. Lösche sie daher erneut, bevor du committest, falls du sie nicht behalten willst.

Wenn sich Dateien von Jamdesk unterscheiden, meldet die CLI die Anzahl. Einige dieser Unterschiede können Änderungen sein, die du in Jamdesk nach dem Herunterladen der Kopie vorgenommen hast. Würdest du sie unverändert veröffentlichen, gingen diese Änderungen verloren. Deshalb braucht dieser Ordner vor dem ersten Deploy eine Überprüfung:

1. Führe git status und git diff aus, um jeden Unterschied zu sehen.
2. Bei einer Datei, deren Jamdesk-Version du willst, führe git restore <file> aus.
3. Committe die Änderungen, die du behalten willst, mit git add und git commit.
4. Führe jamdesk deploy aus.

Bis du committest, stoppt jamdesk deploy mit einer Meldung, dass du deine Änderungen prüfen sollst, und veröffentlicht nichts.

Stattdessen eine ZIP-Datei herunterladen

Um eine Kopie ohne die CLI zu erhalten, öffne Settings, finde die Karte Git Repository und klicke auf Download source (.zip). Jedes Projektmitglied kann dies herunterladen.

Dokumentation zu GitHub verschieben

Der Umzug zu GitHub kopiert deine Dokumentation und ihren vollständigen Bearbeitungsverlauf in ein Repository, das dir gehört. Deine Website bleibt während des Umzugs online. Er funktioniert in jedem Tarif. Nur der Projektinhaber kann die Dokumentation verschieben.

Bearbeite nicht im Editor und führe kein jamdesk deploy aus, während der Umzug läuft. Jamdesk behält die alte Kopie 30 Tage und löscht sie danach.

Nach dem Umzug

Pushes in das Repository veröffentlichen deine Website, wie unter GitHub verbinden beschrieben. Jamdesk baut nur Pushes von Projektmitgliedern mit verknüpftem GitHub-Konto:

1. Verknüpfe dein GitHub-Konto unter User Settings.
2. Lade Teammitglieder ein, die in das Repository pushen, und bitte sie, ihre Konten ebenfalls zu verknüpfen.

Ein Ordner, der mit jamdesk pull erstellt wurde, kann nach dem Umzug nicht mehr veröffentlichen. Führe darin jamdesk deploy aus, um die git-Befehle zu sehen, die ihn mit deinem neuen Repository verbinden.

Wenn der Umzug nicht abgeschlossen wird

Der Dialog zeigt, was schiefgelaufen ist. Wenn er meldet, dass das Repository nicht leer ist oder dass Jamdesk die Kopie nicht bestätigen konnte, lösche das Repository auf GitHub, erstelle ein neues leeres und versuche es erneut. Deine Website und deine Dokumentation in Jamdesk bleiben unverändert.

Wenn dein Abonnement endet

Wie geht es weiter?