GitHub

Met de Document360 en GitHub kan je team naadloos Knowledge Base-artikelen koppelen aan GitHub , wat betere samenwerking tussen ontwikkelaars en technische schrijvers mogelijk maakt. Je kunt updates bijhouden, documentatietaken koppelen aan codewijzigingen en ervoor zorgen dat je kennisbank synchroon blijft met je ontwikkelproces, allemaal zonder tussen de platforms te wisselen.

GitHub configureren in Document360

Om GitHub te configureren in Document360,

1. Navigeer naar  Connections () > Extensions in de linker navigatiebalk in het kennisbasisportaal.

   Je kunt de GitHub vinden onder de sectie Code repositories .

2. Klik op Connect op de extensie-tegel.

   

   Een nieuw installatiepaneel zal opengaan.

3. Kies een van de twee opties op basis van uw behoeften:

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

   • Selecteer alleen repositories - kies ervoor om specifieke te synchroniseren op basis van je projectvereisten.

4. Klik Install.

Als je niet bent ingelogd op GitHub, word je doorgestuurd naar het inlogscherm.

6. Voer je GitHub in en log in. Je wordt doorgestuurd naar het Document360 Knowledge base portal. De module Create new category ' verschijnt.

7. Selecteer GitHub () als categorietype. Selecteer de repository uit je geconfigureerde GitHub.

Er verschijnt een bevestigingsdialoog met de tekst 'Je GitHub is succesvol gestart'.

8. De repository-categorie, samen met alle branches, wordt aangemaakt als artikelen in Document360. Elke keer dat een GitHub de repository bijwerkt, wordt de inhoud gesynchroniseerd met de toegewezen Document360 .

   Je kunt elke entiteit in Document360 identificeren in de GitHub aan de hand van een branch ()-icoon.

    

   ---

   Een Git-repository opzetten

   Om een Git-repository te configureren voor content-toegang in Document360,

   Zorg ervoor dat je Git-repository correct is ingesteld en geconfigureerd om de inhoud in het Document360-project op te halen. Volg de onderstaande structuur:

          Hoofdmap:

   • In GitHub moet de repository een hoofdmap bevatten met de naam docs waar je submappen en Markdown-artikelen kunt organiseren.

   • De naam van deze map moet ongewijzigd blijven.

     Mediabestandsopslag:

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

   • De naam van deze map moet ongewijzigd blijven.

     Als bijvoorbeeld een afbeelding wordt genoemd in een bestand genaamd 'Wat is Document360', moet deze naar die .document360/assets map worden verplaatst.
     Artikelopslag:

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

   • Artikelen moeten in Markdown (.md) formaat zijn.

     Mediabestanden invoegen in artikelen:

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

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

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

   • Als je mediabestand bijvoorbeeld een naam test.pngheeft, gebruik:

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