docs: improve README files for batch 02 (google_trends → prometheus)#7
Conversation
There was a problem hiding this comment.
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 (notablyjson). - 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_tokenintest.py, but there is notest.pyin this connector folder andget_access_tokenis defined inconnector.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`).
|
|
||
| The connector relies on: | ||
| - Built-in Python modules: `csv`, `zipfile`, `json`, `datetime`, `urllib.parse` | ||
| - Pre-installed packages: `fivetran_connector_sdk:latest` and `requests:latest` |
There was a problem hiding this comment.
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.
| - Pre-installed packages: `fivetran_connector_sdk:latest` and `requests:latest` | |
| - Pre-installed packages: `fivetran_connector_sdk:latest` and `requests:2.33.0` |
| @@ -1,35 +1,44 @@ | |||
| # IBM Informix Connector using ibm_db | |||
| # IBM Informix Connector using ibm_db Connector Example | |||
There was a problem hiding this comment.
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.
| # IBM Informix Connector using ibm_db Connector Example | |
| # IBM Informix using ibm_db Connector Example |
69e916d to
21db6e5
Compare
0011251 to
212c2f7
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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.jsonexample 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.jsonexample 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>"
dae3e06 to
f474d4e
Compare
f474d4e to
0886f32
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@fivetran-rishabhghosh @fivetran-sahilkhirwal
|
| ## 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`. |
There was a problem hiding this comment.
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).
| ## 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 | |
There was a problem hiding this comment.
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.
fivetran-rishabhghosh
left a comment
There was a problem hiding this comment.
As discussed please point to public facing docs instead of hardcoding versions
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_apihad no existing documentation).Testing
README-only changes — no connector code modified.
Checklist
fivetran debugcommand.