Skip to content

docs: improve README files for batch 02 (google_trends → prometheus)#7

Merged
fivetran-JenasVimal merged 15 commits into
mainfrom
readme-batch-02
Apr 14, 2026
Merged

docs: improve README files for batch 02 (google_trends → prometheus)#7
fivetran-JenasVimal merged 15 commits into
mainfrom
readme-batch-02

Conversation

@fivetran-JenasVimal

@fivetran-JenasVimal fivetran-JenasVimal commented Apr 7, 2026

Copy link
Copy Markdown
Contributor

Closes RD-1190038

Description of Change

Standardizes README files for connectors #34–66 (google_trends → prometheus) against the README template.

Covers 33 files + creates 1 new README (odata_api had no existing documentation).

⚠️ Note: odata_api/README.md was created from scratch. The connector uses public demo endpoints (TripPin, Northwind) with no credentials required, so no ## Configuration file section was added. Please confirm this is correct or request the section be added.

Testing

README-only changes — no connector code modified.

Checklist

  • Tested the connector with fivetran debug command.
  • Added/Updated example-specific README.md file, see the README template for the required structure and guidelines.
  • Followed Python Coding Standards, refer here

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates a batch of Connector SDK example README.md files (google_trends → prometheus) to better match the repository’s README template and formatting conventions, plus adds a new top-level README for the odata_api example.

Changes:

  • Adds the fivetran init --template <connector-name> snippet to the Getting started section across the batch.
  • Standardizes note formatting (> Note:), heading casing, bullet styles, and code block language hints (notably json).
  • Adds/normalizes boilerplate sections like “Additional considerations” and updates “Requirements file” notes about pre-installed packages.

Reviewed changes

Copilot reviewed 33 out of 33 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
google_trends/README.md Adds init snippet + standardizes notes/formatting in config section.
goshippo/README.md Adds init snippet + standardizes configuration note formatting.
greenplum_db/README.md Adds init snippet + standardizes config/requirements formatting.
grey_hr/README.md Adds init snippet + normalizes headings/notes/bullets.
gumroad/README.md Adds init snippet + standardizes config/requirements notes.
harness_io/README.md Adds init snippet + normalizes config/requirements and section spacing.
healthchecks/README.md Adds init snippet + converts emphasis into > Note: blocks and normalizes notes.
hubspot/README.md Adds init snippet + standardizes headings/notes and requirements note block.
ibm_db2/README.md Adds init snippet + standardizes config/requirements notes and spacing.
ibm_informix_using_ibm_db/README.md Adds init snippet + refactors headings and standardizes notes/code blocks.
influx_db/README.md Adds init snippet + normalizes headings/notes and requirements note block.
iterate/README.md Adds init snippet + standardizes config JSON fence + section spacing.
keycloak/README.md Adds init snippet + standardizes config/requirements notes; removes “Additional files” stub.
leavedates/README.md Adds init snippet + standardizes config JSON fence + headings/notes.
mailerlite/README.md Adds init snippet + standardizes config/requirements notes + section spacing.
mastertax/README.md Refactors from bold pseudo-headers to template sections + adds init snippet.
meilisearch/README.md Adds init snippet + standardizes config/requirements notes.
microsoft_excel/README.md Adds init snippet + standardizes config JSON fence + headings/notes.
microsoft_intune/README.md Fixes H1 (“Connector SDK Example” → “Connector Example”) + adds init snippet + formatting updates.
n8n/README.md Adds init snippet + standardizes > Note: usage and table header casing.
neo4j/README.md Adds init snippet + standardizes config JSON fence, headings, and section spacing.
netlify/README.md Adds init snippet + standardizes config/requirements notes.
newsapi/README.md Adds init snippet + standardizes config JSON fence, headings/notes, and requirements note block.
noaa/README.md Adds init snippet + standardizes config/requirements notes.
npi_registry/README.md Adds init snippet + standardizes config/requirements notes and pagination note formatting.
oauth2_and_accelo_api_connector_multithreading_enabled/README.md Adds init snippet + normalizes headings/notes and section spacing.
odata_api/README.md New top-level README describing the three OData sub-implementations and their tables/files.
oktopost/README.md Adds init snippet + removes stray bold + standardizes notes/spacing.
owasp_api_vulns/README.md Moves contributor info into ## Accreditation + adds init snippet + normalizes headings/notes.
partech/README.md Adds init snippet + standardizes configuration note and table note formatting.
pindrop/README.md Adds init snippet + removes non-UI bold and normalizes bulleted lists/notes.
prefect/README.md Adds init snippet + standardizes config/requirements notes.
prometheus/README.md Adds init snippet + standardizes notes/requirements boilerplate formatting.
Comments suppressed due to low confidence (1)

microsoft_intune/README.md:54

  • In the Authentication section, the README references get_access_token in test.py, but there is no test.py in this connector folder and get_access_token is defined in connector.py. Update the reference to point to the correct file/function location to avoid broken guidance.
## Authentication

The connector uses a OAuth2 client credentials flow to authenticate with Microsoft Graph API. You will need to provide your Azure tenant ID, client ID, and client secret in the `configuration.json` file. The connector retrieves an access token using these credentials (see `get_access_token` function in `test.py`).

Comment thread odata_api/README.md
Comment thread hubspot/README.md Outdated
Comment thread newsapi/README.md Outdated
Comment thread oktopost/README.md Outdated

The connector relies on:
- Built-in Python modules: `csv`, `zipfile`, `json`, `datetime`, `urllib.parse`
- Pre-installed packages: `fivetran_connector_sdk:latest` and `requests:latest`

Copilot AI Apr 7, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Requirements file section, the README states the pre-installed package as requests:latest, but the immediately following note pins it to requests:2.33.0. Please make these consistent (for example, remove the :latest suffix or align with the version shown in the note) to avoid confusion about the runtime environment.

Suggested change
- Pre-installed packages: `fivetran_connector_sdk:latest` and `requests:latest`
- Pre-installed packages: `fivetran_connector_sdk:latest` and `requests:2.33.0`

Copilot uses AI. Check for mistakes.
Comment thread ibm_informix_using_ibm_db/README.md Outdated
@@ -1,35 +1,44 @@
# IBM Informix Connector using ibm_db
# IBM Informix Connector using ibm_db Connector Example

Copilot AI Apr 7, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The H1 title is redundant (it includes "Connector" twice) and doesn’t match the repository template format # <source-name> Connector Example. Consider renaming it to something like # IBM Informix using ibm_db Connector Example (or similar) to follow the template and avoid repetition.

Suggested change
# IBM Informix Connector using ibm_db Connector Example
# IBM Informix using ibm_db Connector Example

Copilot uses AI. Check for mistakes.
Comment thread oauth2_and_accelo_api_connector_multithreading_enabled/README.md Outdated
Comment thread google_trends/README.md Outdated
Comment thread mastertax/README.md
Comment thread microsoft_intune/README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 33 out of 33 changed files in this pull request and generated 5 comments.

Comments suppressed due to low confidence (2)

microsoft_intune/README.md:45

  • The configuration.json example uses literal values like "YOUR_TENANT_ID" instead of placeholder-style values (for example <YOUR_TENANT_ID>). Please update these to placeholders so the example can't be mistaken for real credentials and stays consistent with other connector READMEs.
```json
{
  "tenant_id": "YOUR_TENANT_ID",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET"

mastertax/README.md:45

  • The configuration.json example uses literal values like "YOUR_CLIENT_ID"/"YOUR_CLIENT_SECRET" and generic strings like <certificate string>. Please switch these to the repo’s placeholder style (for example <YOUR_CLIENT_ID>, <YOUR_CLIENT_SECRET>, <YOUR_CERTIFICATE_PEM>, <YOUR_PRIVATE_KEY_PEM>) so the example is unambiguous and consistent.
{
  "clientId": "YOUR_CLIENT_ID",
  "clientSecret": "YOUR_CLIENT_SECRET",
  "crtFile": "<certificate string>",
  "keyFile": "<key string>"

Comment thread microsoft_excel/README.md
Comment thread microsoft_excel/README.md Outdated
Comment thread microsoft_excel/README.md Outdated
Comment thread mastertax/README.md
Comment thread neo4j/README.md
Comment thread mastertax/README.md Outdated
Comment thread microsoft_intune/README.md
Comment thread neo4j/README.md Outdated
Comment thread hubspot/README.md Outdated
Comment thread oktopost/README.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread oktopost/README.md Outdated
@fivetran-JenasVimal

Copy link
Copy Markdown
Contributor Author

@fivetran-rishabhghosh @fivetran-sahilkhirwal

  • Improved README files for 33 connectors (google_trends → prometheus) following the standard template structure
  • Fixed broken fivetran init doc links across all batch 02 connectors
  • Added requirements.txt for hubspot and newsapi
  • Fixed README title for IBM Informix using ibm_db
  • Fixed accreditation section for the Accelo (OAuth2 multithreading) connector
  • Applied code review suggestions from Copilot
  • odata_api — README needs further work; will create and review a separate PR for it

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated 7 comments.

Comment thread newsapi/requirements.txt Outdated
Comment thread hubspot/requirements.txt Outdated
Comment thread hubspot/README.md Outdated
Comment thread newsapi/README.md Outdated
Comment thread n8n/README.md Outdated
Comment on lines +58 to +62
## Requirements file

The connector uses only the SDK-provided packages (`fivetran_connector_sdk` and `requests`). No additional dependencies are required, so the `requirements.txt` file is empty.

Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`.
> Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`.

Copilot AI Apr 9, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README says the requirements.txt file is empty, but there is no requirements.txt in the n8n/ directory. Please update the wording to state that no requirements.txt is needed (or add an explicit empty requirements.txt if that’s the intended convention).

Copilot uses AI. Check for mistakes.
Comment thread odata_api/README.md
Comment on lines +94 to +101
## Tables created

### odata_version_4

| Table | Primary key | Description |
|-------|-------------|-------------|
| `People` | `UserName` | People data from the TripPin OData demo service |
| `Orders` | `OrderID` | Order data with expanded order details from Northwind |

Copilot AI Apr 9, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ## Tables created section lists table names and primary keys, but it doesn’t include column lists/schemas for the created tables (which makes it hard for users to understand what will land in the destination). Please add per-table schema details (columns + primary key) or explicitly reference where the schema is defined in each sub-implementation’s schema() function.

Copilot uses AI. Check for mistakes.
Comment thread neo4j/requirements.txt
@fivetran-rishabhghosh fivetran-rishabhghosh removed their request for review April 9, 2026 12:00

@fivetran-rishabhghosh fivetran-rishabhghosh left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed please point to public facing docs instead of hardcoding versions

Copilot AI review requested due to automatic review settings April 13, 2026 06:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated 4 comments.

Comment thread hubspot/README.md
Comment thread newsapi/README.md
Comment thread oauth2_and_accelo_api_connector_multithreading_enabled/README.md Outdated
Comment thread grey_hr/README.md
Copilot AI review requested due to automatic review settings April 13, 2026 07:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 35 out of 35 changed files in this pull request and generated 3 comments.

Comment thread n8n/README.md
Comment thread google_trends/README.md
Comment thread neo4j/README.md
@fivetran-JenasVimal fivetran-JenasVimal merged commit 38e7329 into main Apr 14, 2026
3 checks passed
@fivetran-JenasVimal fivetran-JenasVimal deleted the readme-batch-02 branch April 14, 2026 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants