Skip to content

Review connector permissions documentation using connector-doc-review skill #122

@ulixius9

Description

@ulixius9

Overview

Systematically review all connector documentation for permission accuracy using the connector-doc-review Claude skill (.claude/skills/connector-doc-review/SKILL.md).

The skill validates documentation against the actual JSON schema and ingestion source code, checking:

  • Permission Documentation — Are all required permissions (SQL grants, IAM policies, API scopes) documented?
  • Available/Unavailable Features — Does the feature matrix match schema supports* flags?
  • YAML Configuration — Are all schema properties shown with correct defaults?
  • Authentication Types — Are supported auth methods highlighted?
  • Cross-Version Consistency — Are docs consistent across v1.11.x, v1.12.x, v1.13.x-SNAPSHOT?

How to Use

Run the skill for each connector:

/connector-doc-review <connector-name> --service-type=<type>

Connector Checklist

Database Connectors

  • ADLS Datalake (adls-datalake)
  • Athena (athena)
  • Azure SQL (azuresql)
  • BigQuery (bigquery)
  • BigTable (bigtable)
  • BurstIQ (burstiq)
  • Cassandra (cassandra)
  • ClickHouse (clickhouse)
  • Cockroach (cockroach)
  • Couchbase (couchbase)
  • Databricks (databricks)
  • DB2 (db2)
  • Delta Lake (deltalake)
  • DomoDB (domo-database)
  • Doris (doris)
  • Druid (druid)
  • DynamoDB (dynamodb)
  • Exasol (exasol)
  • GCS Datalake (gcs-datalake)
  • Glue (glue)
  • Greenplum (greenplum)
  • Hive (hive)
  • Impala (impala)
  • MariaDB (mariadb)
  • MongoDB (mongodb)
  • MySQL (mysql)
  • Oracle (oracle)
  • PinotDB (pinotdb)
  • PostgreSQL (postgres)
  • Presto (presto)
  • Redshift (redshift)
  • S3 Datalake (s3-datalake)
  • Salesforce (salesforce)
  • SAP ERP (sap-erp)
  • SAP HANA (sap-hana)
  • SAS (sas)
  • SingleStore (singlestore)
  • Snowflake (snowflake)
  • SQLite (sqlite)
  • StarRocks (starrocks)
  • Teradata (teradata)
  • Timescale (timescale)
  • Trino (trino)
  • Unity Catalog (unity-catalog)
  • Vertica (vertica)
  • dbt (dbt)

Dashboard Connectors

  • Domo Dashboard (domo-dashboard)
  • Grafana (grafana)
  • Hex (hex)
  • Lightdash (lightdash)
  • Looker (looker)
  • Metabase (metabase)
  • Microstrategy (microstrategy)
  • Mode (mode)
  • Power BI (powerbi)
  • QlikCloud (qlikcloud)
  • QlikSense (qliksense)
  • Quicksight (quicksight)
  • Redash (redash)
  • Sigma (sigma)
  • Superset (superset)
  • Tableau (tableau)

Pipeline Connectors

  • Airbyte (airbyte)
  • Airflow (airflow)
  • Dagster (dagster)
  • Databricks Pipeline (databricks-pipeline)
  • dbtCloud (dbtcloud)
  • Domo Pipeline (domo-pipeline)
  • Fivetran (fivetran)
  • Flink (flink)
  • Glue Pipeline (glue-pipeline)
  • KafkaConnect (kafkaconnect)
  • NiFi (nifi)
  • OpenLineage (openlineage)
  • Spline (spline)
  • Wherescape (wherescape)

Messaging Connectors

  • Kafka (kafka)
  • Kinesis (kinesis)
  • Redpanda (redpanda)

Storage Connectors

  • GCS (gcs)
  • S3 (s3)

Search Connectors

  • Elasticsearch (elasticsearch)
  • OpenSearch (opensearch)

ML Model Connectors

  • MLflow (mlflow)
  • SageMaker (sagemaker)

API / Metadata / Drive Connectors

  • REST (rest)
  • Alation Sink (alation-sink)
  • Amundsen (amundsen)
  • Atlas (atlas)
  • Custom Drive (custom-drive)
  • SFTP (sftp)

Already Reviewed

The following connectors have been reviewed in prior sessions (branch docs_permission_skill):

  • Redshift (redshift) — S316, S317, S319
  • BigQuery (bigquery) — S321
  • Databricks (databricks) — S324
  • Unity Catalog (unity-catalog) — S322
  • Power BI (powerbi) — S323
  • Snowflake (snowflake) — S326
  • Tableau (tableau) — S325

Note: Move reviewed connectors from the checklist above to the "Already Reviewed" section as they are completed.

Acceptance Criteria

  • All connectors reviewed with connector-doc-review skill
  • Permission documentation matches actual code requirements
  • Feature matrices match JSON schema supports* flags
  • Authentication type callouts added where missing
  • Consistent documentation across all three versions (v1.11.x, v1.12.x, v1.13.x-SNAPSHOT)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions