How to Create a Data Integration Doc Page

Currently, all the supported data integrations are listed here.

We plan to provide extensive instructions on how to connect and use each of the data integrations. Thus, each data integration requires its dedicated doc page.

Please follow the steps below to create a dedicated doc page for your chosen data integration.

​

Step 1. Create a File

Create a Markdown file under the mindsdb/docs/data-integrations directory and name it with the database name.

​

Step 2. Implement the Content

Please include the following at the beginning of the file:

---
title: <INPUT DATA INTEGRATION NAME HERE>
sidebarTitle: <INPUT DATA INTEGRATION NAME HERE>
---

<ADD YOUR CONTENT HERE FOLLOWING THE INSTRUCTIONS BELOW>

---
title: Oracle
sidebarTitle: Oracle
---

<ADD YOUR CONTENT HERE FOLLOWING THE INSTRUCTIONS BELOW>

Here are the resources you should use to implement the content of the doc page:

• Use the connection template and example from here.

  If you implement a doc page for the Google BigQuery database, use this chapter.

• Check out the dedicated handler folder here. Pay attention to the README.md file, as it contains valuable information that should be included in the doc page.

  If you implement a doc page for the Google BigQuery database, go to its handler folder here and see the README.md file here.

You are welcome to provide usage examples of the data integrations in MindsDB!

​

Step 3. Create a PR

Once you are done, create a PR. We’ll review it soon!

Thank you for contributing to MindsDB!