Skip to content

Connector Documentation

Introduction

Built a connector? Great job.

Next step: document it for your users.

See the Google Sheets Data Connector for inspiration. It explains:

  • How to deploy from Connector Hub
  • How to set up (auth, credentials, etc.)
  • How to use in a Smart Template

How to Start

  1. Read the README and Contributing Guide
  2. Download this template zip (it contains a basic structure)
    screenshot
  3. Fork this repository
  4. Add your folder and assets
  5. Update mkdocs.yml navigation
  6. Commit and submit a Pull Request

Your docs will go live after review.

Naming Convention

Use folder name connector-yourname.
E.g. connector-infinity for "Infinity".

screenshot-full

Your folder should go in the structure:

docs > GraFx-Studio > connectors > connector-infinity

screenshot-full

Folder Contents

  • index.md: your main doc (use Material for MkDocs)
  • infinity01.png: add visuals to the same folder

screenshot-full

Subfolders

Use subfolders if your documentation needs more than one page. Follow our contribution structure.

Add your connector to the mkdocs.yml

Under Media for media connectors, Data for data connectors.

screenshot-full

What to Document?

The sections below are also present in the index.md in the zip file.

Connector Type

Document as a Third Party connector. Add a link to your company.

Installation

Explain how to install via Connector Hub

Supported files

Specifically for media connectors, list what kind of files are supporten, and specify ins- and outs.

Configuration

Add screenshots and explain each configuration field.

External Setup

Explain what users need to configure on your side (auth setup, API keys, etc.).

Usage in Templates

Describe how to use your connector in a Smart Template. Include examples for common use cases.