GitHub

Plans supporting integration of GitHub extensions with Document360

With the Document360 and GitHub integration, your team can seamlessly link Knowledge base articles to GitHub issues, enabling better collaboration between developers and technical writers. You can track updates, associate documentation tasks with code changes, and ensure your Knowledge base stays in sync with your development process, all without switching between the platforms.

Configuring GitHub in Document360

To configure GitHub in Document360,

1. Navigate to Settings () > Knowledge base portal > Extensions in the Knowledge base portal.

   You can find the GitHub extension under the Code repositories section.

2. Click Connect on the extension tile.

   

   A new Install panel will open.

3. Select any one from the two options based on your requirements:

   • All repositories - choose to sync all repositories.

   • Only select repositories - choose to sync specific ones based on your project requirement.

4. Click Install.

   

   If you are not logged into GitHub, you will be redirected to the login screen.

   5. Enter your GitHubcredentials and log in.

   You will be redirected to the Document360 Knowledge base portal. The Create new category module will appear.

   6. Select GitHub () as the category type.

   7. Select the repository from your configured GitHub.
   

   1. A confirmation popup saying ‘Your GitHub has been successfully initiated’ will appear.

      The repository category, along with all the branches, are created as articles in Document360. Each time a GitHub user updates the repository, the content is synced with the mapped Document360 articles.

   2. You can identify each entity in Document360 in the GitHub category by a branch () icon.

      

   ---

   Setting up Git repository

   To configure a Git repository for content access in Document360,

   1. Ensure that your Git repository is properly set up and configured to enable fetching the content into the Document360 project. Follow the below structure:

          Main folder:

   • In GitHub, the repository must include a main folder named docs where you can organize subfolders and Markdown articles.

   • This folder name must remain unchanged.

     
     Media files storage:

   • Store all media files inside the .document360/assets folder within the docs directory.

   • This folder name must remain unchanged.

     For example, if an image is referenced in a file named 'What is Document360', it should be moved to the .document360/assets folder.

     
     Article storage:

   • Within the docs folder, create a separate directory, for example, articles to store your articles.

   • Articles must be in Markdown (.md) format.

     Inserting media files in articles:

   • Upload the media file to the .document360/assets folder.

   • Use the following syntax to insert the media file into your article:

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

   • For example, if your media file is named test.png, use:

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

GitHub integration setup with Document360

Below is a step-by-step video guide on seamlessly setting up and integrating GitHub with Document360.