GitHub

Mit der Integration von Document360 und GitHub kann Ihr Team nahtlos Knowledge Base-Artikel mit GitHub verknüpfen und so eine bessere Zusammenarbeit zwischen Entwicklern und technischen Autoren ermöglichen. Du kannst Updates verfolgen, Dokumentationsaufgaben mit Codeänderungen verknüpfen und sicherstellen, dass deine Wissensdatenbank mit deinem Entwicklungsprozess synchron bleibt – und das alles, ohne zwischen den Plattformen zu wechseln.

Konfiguration von GitHub in Document360

Um GitHub in Document360 zu konfigurieren,

1. Navigiere in der linken Navigationsleiste im Knowledge Base-Portal zu Connections () > Erweiterungen.

   Die GitHub findest du unter dem Bereich Code repositories .

2. Klicken Sie auf Verbinden auf der Erweiterungskachel.

   

   Ein neues Installationspanel wird geöffnet.

3. Wählen Sie basierend auf Ihren Anforderungen eine der beiden Optionen:

   • Alle Repositories – wähle, alle Repositories zu synchronisieren.

   • Wählen Sie nur Repositories aus – entscheiden Sie sich, bestimmte basierend auf Ihren Projektanforderungen zu synchronisieren.

4. Klicken Install.

Wenn Sie nicht bei GitHub angemeldet sind, werden Sie zum Anmeldebildschirm weitergeleitet.

6. Gib deine GitHub ein und melde dich an. Sie werden zum Knowledge base portal Document360 weitergeleitet. Das Create new category" erscheint.

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

Ein Bestätigungsdialog mit der Aufschrift "Ihr GitHub wurde erfolgreich initiiert" erscheint.

8. Die Repository-Kategorie sowie alle Zweige werden als Document360 erstellt. Jedes Mal, wenn ein GitHub aktualisiert, wird der Inhalt mit den zugeordneten Document360 synchronisiert.

   Sie können jede Document360 in der GitHub anhand eines Branch-()-Symbols identifizieren.

    

   ---

   Einrichtung eines Git-Repositoriums

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

   Stellen Sie sicher, dass Ihr Git-Repository entsprechend eingerichtet und konfiguriert ist, um das Abrufen von Inhalten in das Document360-Projekt zu ermöglichen. Folgen Sie der untenstehenden Struktur:

          Hauptordner:

   • In GitHub muss das Repository einen Hauptordner docs enthalten, in dem man Unterordner und Markdown-Artikel organisieren kann.

   • Dieser Ordnername muss unverändert bleiben.

     Speicherung von Mediendateien:

   • Speichere alle Mediendateien im .document360/assets Ordner im docs Verzeichnis.

   • Dieser Ordnername muss unverändert bleiben.

     Wenn zum Beispiel ein Bild in einer Datei namens 'What is Document360' referenziert wird, sollte es in den Ordner .document360/assets verschoben werden.
     Artikellagerung:

   • Innerhalb des docs Ordners erstellen Sie zum Beispiel articles ein separates Verzeichnis, um Ihre Artikel zu speichern.

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

     Einfügen von Mediendateien in Artikel:

   • Lade die Mediendatei in den .document360/assets Ordner hoch.

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

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

   • Zum Beispiel, wenn Ihre Mediendatei benannt test.pngist, verwenden Sie:

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