Many organizations around the world use Git for managing their code repository. One of those popular code repositories is GitHub, which makes it easy for developers to showcase their work and collaborate with other developers around the world.

Developers build new product features and fix bugs in existing product features by committing their source code to their project code repository via git commands. GitHub also provides an intuitive graphical interface to manage code repositories.

Use-Case

You have chosen Document360 as your Knowledge base platform. You have hosted your code repository in GitHub. There is a need that when a developer commits a code to GitHub, you want to create a corresponding knowledge base article in Document360.

Currently, there is no direct integration option available between GitHub and Document360 from either of the platforms.

Workaround

As a workaround, you can use Zapier integration to bridge this gap. By connecting GitHub and Document360 on Zapier, you can easily facilitate the content flow between these platforms.

Ensure that you have logged into your Zapier account.

  1. Click Create -> Zaps

  2. Zap was created with Trigger and Action flow in it

1_Screenvideo-Creating_a_workspace_in_zapier_dashboard1

Connecting GitHub and Document360 in Zapier

2_Screenshot-Create_articles_in_Document360_from_new_GitHub_commits

Step 1: Connect GitHub

In Trigger, fetch the GitHub information.

  1. In Trigger, choose GitHub

  2. In the App & Event section, select the required Event to trigger in the GitHub

Change

If you wish to configure a different app later, you can do that by clicking on Change

  1. Click Continue

  2. The Account section enables. Click Sign in and key in your credentials in the new access window. Click on the Authorize zapier button

3_%20Screenshot-GitHub_Sign_in_credentials

  1. Click Continue

  2. Click Test trigger and Zapier runs a test to make sure the trigger is correctly configured

Step 2: Connect Document360

  1. In Action, choose Document360, Document360 blade appears on the right

  2. Choose the desired Event

  3. In the Account section, you need to sign in with your Document360 credentials

  4. Click Sign in, and a new pop-up window would open with an API token field to connect with the knowledge base project

  5. You can obtain the API token from the Document360 portal

API Token generation
  • Go to Settings → Knowledge base portal → Extensions → Team collaboration
  • In Zapier assistance, click Connect
  • Click Copy

4_Screenvideo-Zapier_API_Generation_in_portal1

  1. Head back to the pop-up window, paste the API token in the field

  2. Click Yes, Continue to Document360

  1. You can find the connected Document360 project on the Connect Document360 account page
Change

If you wish to configure a different account later, you can do that by clicking on Change

  1. Click Continue

Step 3: Customize Zap

6_Screenvideo-Map_fields_from_GitHub_into_Document360

Map all the required fields:

Title: By default, New commit in GitHub is selected here. However, you have a plethora of other options to choose from (depending upon your business requirements)

Content: By default, Commit Message is selected here. However, you have a plethora of other options to choose from (depending upon your business requirements)

Version: Choose the desired workspace in the knowledge base project, you want the article to be created in

Language: Choose the desired language in the selected workspace, you want the article to be created in

Category: Choose the desired category in the selected language, you want the article to be created in

Publish Choose True for the article to be published. Choose False for the article to be in draft state.

After you map all the required fields, the continue button is enabled.

Step 4: Test Zap

  1. Once you have configured the actions in Document360, the Zap needs to be tested to make sure it’s configured correctly
    (Zapier would create an article on Document360 to make sure everything works)

  2. Click on the Send test button

  3. If successful, you would get the message “Test Article sent! Check your Document360 account to view it.’’

  4. Visit your Document360 knowledge base portal and you can find the article named “New commit in GitHub” under the desired location you have previously selected

  5. Head back to the Zapier setup window and click on Next

  6. Once done, click Publish

You would get a success message window stating Your Zap is on. You can click on the Manage your Zap button to go to your GitHub+Document360 Zap overview page.

7_Screnshot_Zap_connection_Successful

Created Zap overview

Create articles in Document360 from new GitHub commits

You can view and edit the information about your created Zap on the Zap overview page.

8_Screenshot_Zap_overview_page_view_edit

How will you delete Zap?

  1. Go to the Zapier dashboard. In the overview page, a list of all existing Zaps is displayed
  2. Click the right arrow (>) of the desired Zaps and click Turn off and delete Zap