Automatische PR-Entwürfe
Aktiviere Automatische PR-Entwürfe unter Einstellungen > Automatisierungen, damit Fern einen Docs-Update-Entwurf erstellt, wenn eine zusammengeführte Pull Request das kundenrelevante Verhalten ändert. Du prüfst und veröffentlichst weiterhin jeden Entwurf; Fern veröffentlicht niemals automatisch.
Vorbereitung
Verbinde die GitHub-Integration, damit Fern Pull Requests in deinen Repositories überwachen kann.
Automatische PR-Entwürfe aktivieren
Öffne Einstellungen in der Seitenleiste des Dashboards.
Wähle Automatisierungen. Die Seite enthält Automatische PR-Entwürfe und Geplante Prüfungen.
Aktiviere Automatische PR-Entwürfe. Die Einstellung wird sofort gespeichert.
Wenn der Schalter aktiviert ist, erscheinen darunter Sensitivität und Anleitung für PR-Entwürfe.
Sensitivität wählen
Verwende Sensitivität, um zu steuern, wie schnell Fern aus einer zusammengeführten Pull Request einen Entwurf erstellt. Wähle eine Option:
Streng: nur eindeutige Änderungen: Fern erstellt Entwürfe nur, wenn die Argumente für ein Docs-Update am stärksten sind.
Ausgewogen: die Standardeinstellung. Fern erstellt Entwürfe für klare kundenrelevante Änderungen und überspringt schwächere.
Eifrig: mehr Entwürfe: Fern erstellt Entwürfe für eine größere Bandbreite kundenrelevanter Änderungen.
Wenn du die Auswahl änderst, wird sie sofort gespeichert.
Sensitivität garantiert nicht für jede sichtbare Produktänderung einen Entwurf. Fern entscheidet weiterhin, ob die Zusammenführung eine Dokumentation erfordert, und wendet dann deine Sensitivitätseinstellung an, bevor es eine Entwurfsaufgabe erstellt.
Anleitung für PR-Entwürfe hinzufügen
Verwende Anleitung für PR-Entwürfe für dauerhafte, organisationsweite Anweisungen, die Fern anwendet, wenn es zusammengeführte Pull Requests prüft und daraus Entwürfe erstellt.
Das Feld akzeptiert bis zu 4.000 Zeichen. Verlasse das Feld, um zu speichern. Leere Hinweise setzen die Einstellung zurück.
Dieses Feld ist getrennt von den organisationsweiten Anweisungen für Entwürfe und den Rechercheanweisungen unter Einstellungen > Fern. Diese steuern Ferns allgemeine Texterstellung und Recherche. Anleitung für PR-Entwürfe gilt nur für die PR-Prüfung und PR-basierte Entwürfe.
Was einen Entwurf auslöst
Fern prüft eine Pull Request, nachdem sie in den Standardzweig eines verbundenen GitHub-Repositories zusammengeführt wurde. Pull Requests zum Rückgängigmachen werden vor der Prüfung übersprungen.
Fern erstellt einen Entwurf, wenn die Zusammenführung das kundenrelevante Verhalten ändert, über das Kunden informiert werden müssen, etwa UI-Abläufe, API-Endpunkte, Funktionsverhalten, Fehlermeldungen oder Konfigurationsoptionen, und die Änderung deine Sensitivitätseinstellung erfüllt.
Fern erstellt keinen Entwurf, wenn:
Die Änderung intern ist oder Endnutzer nicht betrifft
Die relevante Dokumentation bereits auf dem neuesten Stand ist
Die Änderung kundenrelevant ist, aber deine aktuelle Sensitivitätseinstellung nicht erfüllt
In diesen Fällen erfasst Fern dennoch eine Codeänderung mit der Kennzeichnung Keine Dokumentationsänderungen erforderlich. Diese Threads bleiben aus der Standardliste Alle heraus. Filtere die Fern-Seite nach Automatisierungen, um sie zu überprüfen. Öffne einen Thread, um die Überschrift und jede von Fern gespeicherte Erklärung zu sehen.
Wenn du mehrere Repositories verbunden hast, kann Fern die Analyse auf das Repository beschränken, in dem die Zusammenführung stattgefunden hat. Bei Zweig-spezifischen Änderungen kann Fern diesen Zweig vor dem Erstellen des Entwurfs durchsuchen.
Entwürfe prüfen
Wenn Fern einen Entwurf erstellt, erscheint er auf deiner Fern-Seite als Thread mit einem Pull-Request-Symbol. Der Thread zeigt den PR-Titel und die Metadaten, eine Zusammenfassung der Änderungen und den Entwurfsstatus.
Öffne den Thread. Wenn der Entwurf fertig ist, wähle Änderungen überprüfen und bearbeiten. Bearbeite den Entwurf, bitte im Thread um Überarbeitungen oder veröffentliche ihn, wenn du zufrieden bist.
Filtere die Thread-Liste in Fern mit Hat Entwürfe, um nur Threads anzuzeigen, für die Entwurfsaktualisierungen zur Überprüfung bereitstehen.
Du kontrollierst die Veröffentlichung
Fern erstellt Entwürfe, veröffentlicht sie aber niemals automatisch. Jeder Entwurf muss von dir geprüft werden, bevor er in deinem Hilfecenter erscheint.