GitHub

Plannen ter ondersteuning van de integratie van GitHub extensies met Document360

Met de Document360 en GitHub integratie kan uw team Knowledge Base-artikelen naadloos koppelen aan GitHub problemen, waardoor een betere samenwerking tussen ontwikkelaars en technische schrijvers mogelijk wordt. U kunt updates bijhouden, documentatietaken koppelen aan codewijzigingen en ervoor zorgen dat uw kennisbank gesynchroniseerd blijft met uw ontwikkelingsproces, allemaal zonder tussen de platforms te hoeven schakelen.

GitHub configureren in Document360

GitHub configureren in Document360,

1. Navigeer naar () > Knowledge base portal> Extensions in de Knowledge Base-portal.

   De GitHub extensie vindt u onder het kopje Code repositories .

2. Klik op Connect op de extensietegel.

   

   Er wordt een nieuw installatievenster geopend.

3. Selecteer een van de twee opties op basis van uw vereisten:

   • Alle opslagplaatsen - kies ervoor om alle opslagplaatsen te synchroniseren.

   • Selecteer alleen repository's - kies ervoor om specifieke repositories te synchroniseren op basis van uw projectvereisten.

4. Klik op Install.

   

   Als u niet bent ingelogd op GitHub, wordt u doorgestuurd naar het inlogscherm.

   5. Voer uw GitHubgegevens in en log in.

   U wordt doorgestuurd naar de Document360 Knowledge base portal. De module Create new category verschijnt.

   6. Selecteer GitHub () als categorietype.

   7. Selecteer het archief in uw geconfigureerde GitHub.
   

   1. Er verschijnt een bevestigingspop-up met de tekst 'Uw GitHub is succesvol gestart'.

      De repository-categorie, samen met alle vertakkingen, worden gemaakt als artikelen in Document360. Telkens wanneer een GitHub gebruiker de repository bijwerkt, wordt de inhoud gesynchroniseerd met de toegewezen Document360 artikelen.

   2. U kunt elke entiteit in Document360 in de categorie GitHub herkennen aan een vertakkingspictogram ().

      

   ---

   Git-repository instellen

   Als u een Git-opslagplaats wilt configureren voor toegang tot inhoud in Document360,

   1. Zorg ervoor dat uw Git-opslagplaats correct is ingesteld en geconfigureerd om het ophalen van de inhoud in het Document360-project mogelijk te maken. Volg de onderstaande structuur:

          Hoofdmap:

   • In GitHubmoet de opslagplaats een hoofdmap bevatten met de naam docs waarin u submappen en Markdown-artikelen kunt ordenen.

   • Deze mapnaam moet ongewijzigd blijven.

     
     Opslag van mediabestanden:

   • Sla alle mediabestanden op in de .document360/assets map in de docs map.

   • Deze mapnaam moet ongewijzigd blijven.

     Als er bijvoorbeeld naar een afbeelding wordt verwezen in een bestand met de naam 'Wat is Document360', moet deze naar de .document360/assets map worden verplaatst.

     
     Artikel opslag:

   • Maak binnen de docs map een aparte directory aan, bijvoorbeeld articles om je artikelen op te slaan.

   • Artikelen moeten de indeling Markdown (.md) hebben.

     Mediabestanden invoegen in artikelen:

   • Upload het mediabestand naar de .document360/assets map.

   • Gebruik de volgende syntaxis om het mediabestand in uw artikel in te voegen:

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

   • Als uw mediabestand bijvoorbeeld de naam test.pngheeft, gebruikt u:

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

GitHub-integratie instellen met Document360

Hieronder vindt u een stapsgewijze videohandleiding voor het naadloos instellen en integreren van GitHub met Document360.