GitHub (Englisch)

Mit der Document360 GitHub und-Integration kann Ihr Team Wissensdatenbankartikel nahtlos mit GitHub Issues verknüpfen und so eine bessere Zusammenarbeit zwischen Entwicklern und technischen Redakteuren ermöglichen. Sie können Aktualisierungen nachverfolgen, Dokumentationsaufgaben mit Codeänderungen verknüpfen und sicherstellen, dass Ihre Wissensdatenbank mit Ihrem Entwicklungsprozess synchronisiert bleibt, ohne zwischen den Plattformen wechseln zu müssen.

Konfigurieren von GitHub in Document360

So konfigurieren Sie GitHub in Document360:

1. Navigieren Sie zu () in der linken Navigationsleiste des Wissensdatenbank-Portals.

2. Navigieren Sie im linken Navigationsbereich zu Knowledge base portal > Erweiterungen > Teamzusammenarbeit.

   Sie finden die GitHub Erweiterung unter der Code repositories Rubrik.

3. Klicken Sie Verbinden auf die Kachel der Erweiterung.

   

   Ein neues Installationsfenster wird geöffnet.

4. Wählen Sie je nach Ihren Anforderungen eine der beiden Optionen aus:

   • Alle Repositorys: Wählen Sie diese Option aus, um alle Repositorys zu synchronisieren.

   • Nur ausgewählte Repositorys – wählen Sie aus, ob bestimmte Repositorys basierend auf Ihren Projektanforderungen synchronisiert werden sollen.

5. Klicken Sie auf Install.

Wenn Sie nicht bei GitHubangemeldet sind, werden Sie zum Anmeldebildschirm weitergeleitet.

6. Geben Sie Ihre GitHub Zugangsdaten ein und melden Sie sich an. Sie werden zur Document360 Knowledge base portal. Das Create new category Modul wird angezeigt.

7. Wählen Sie () als Kategorietyp aus GitHub . Wählen Sie das Repository aus der konfigurierten GitHub.

Ein Bestätigungsdialogfeld mit der Meldung "Ihr GitHub wurde erfolgreich initiiert" wird angezeigt.

8. Die Repository-Kategorie wird zusammen mit allen Zweigen als Artikel in Document360angelegt. Jedes Mal, wenn ein GitHub Benutzer das Repository aktualisiert, wird der Inhalt mit den zugeordneten Document360 Artikeln synchronisiert.

   Sie können jede Entität in Document360 der GitHub Kategorie durch ein Zweigsymbol () identifizieren.

    

   ---

   Einrichten eines Git-Repositorys

   Um ein Git-Repository für den Inhaltszugriff in Document360zu konfigurieren,

   Stellen Sie sicher, dass Ihr Git-Repository ordnungsgemäß eingerichtet und konfiguriert ist, um das Abrufen des Inhalts in das Document360-Projekt zu ermöglichen. Befolgen Sie die folgende Struktur:

          Hauptordner:

   • In GitHubmuss das Repository einen Hauptordner mit dem Namen docs enthalten, in dem Sie Unterordner und Markdown-Artikel organisieren können.

   • Dieser Ordnername muss unverändert bleiben.

     Speicherung von Mediendateien:

   • Speichern Sie alle Mediendateien in dem .document360/assets Ordner innerhalb des Verzeichnisses docs .

   • Dieser Ordnername muss unverändert bleiben.

     Wenn beispielsweise in einer Datei mit dem Namen "Was ist Document360" auf ein Bild verwiesen wird, sollte es in den .document360/assets Ordner verschoben werden.
     Lagerung von Artikeln:

   • Legen Sie innerhalb des Ordners docs ein separates Verzeichnis an, in dem Sie z.B articles . Ihre Artikel ablegen können.

   • Die Artikel müssen im Markdown-Format (.md) vorliegen.

     Einfügen von Mediendateien in Artikel:

   • Laden Sie die Mediendatei in den .document360/assets Ordner hoch.

   • Verwenden Sie die folgende Syntax, um die Mediendatei in Ihren Artikel einzufügen:

     ![image description](/docs/.document360/assets/mediafilename.extension)

   • Wenn Ihre Mediendatei z. B. den Namen test.pnghat, verwenden Sie Folgendes:

     ![test image](/docs/.document360/assets/test.png)

Einrichtung der GitHub-Integration mit Document360

Im Folgenden finden Sie eine Schritt-für-Schritt-Videoanleitung zum nahtlosen Einrichten und Integrieren von GitHub in Document360.