docs: improve README files for batch 01 (apache_hbase → gnews)#6
Conversation
There was a problem hiding this comment.
Pull request overview
Standardizes a batch of Connector SDK example READMEs (apache_hbase → gnews) to align more closely with _template_connector/README_template.md, improving consistency of section structure, getting-started instructions, and common notes.
Changes:
- Added a consistent
fivetran init --template <connector-name>block (plus a configuration reminder note) to Getting started sections. - Standardized Configuration file / Requirements file notes (community placeholder guidance + pre-installed packages note).
- Normalized headings (sentence case), list formatting, and code-block language hints across the batch.
Reviewed changes
Copilot reviewed 35 out of 35 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| apache_hbase/README.md | Standardizes structure/formatting and adds fivetran init instructions and notes. |
| apache_hive/using_sqlalchemy/README.md | Aligns sections and formatting with the template; adds fivetran init block and standard notes. |
| apache_hive/using_pyhive/README.md | Aligns sections and formatting with the template; adds fivetran init block and standard notes. |
| apache_pulsar/README.md | Template alignment + standardized notes and formatting. |
| arango_db/README.md | Template alignment + standardized notes and formatting. |
| awardco/README.md | Template alignment + standardized notes and formatting. |
| aws_athena/using_boto3/README.md | Template alignment + standardized notes and formatting. |
| aws_athena/using_sqlalchemy/README.md | Template alignment + standardized notes and formatting. |
| aws_dynamo_db_authentication/README.md | Template alignment + standardized notes and formatting. |
| aws_rds_oracle/readme.md | Template alignment + standardized notes and formatting. |
| betterstack/README.md | Template alignment + standardized notes and formatting. |
| cassandra/README.md | Template alignment + standardized notes and formatting. |
| checkly/README.md | Template alignment + standardized notes and formatting. |
| clerk/README.md | Template alignment + standardized notes and formatting. |
| clickhouse/README.md | Template alignment + standardized notes and formatting. |
| commonpaper/README.md | Template alignment + standardized notes and formatting. |
| couchbase_capella/README.md | Template alignment + standardized notes and formatting. |
| couchbase_magma/README.md | Template alignment + standardized notes and formatting. |
| courier/README.md | Template alignment + standardized notes and formatting. |
| customer_thermometer/README.md | Template alignment + standardized notes and formatting. |
| data_camp/README.md | Template alignment + standardized notes and formatting. |
| dgraph/README.md | Template alignment + standardized notes and formatting. |
| discord/README.md | Template alignment + standardized notes and formatting. |
| documentdb/README.md | Template alignment + standardized notes and formatting. |
| docusign/README.md | Template alignment + standardized notes and formatting (including Accreditation placement). |
| dolphin_db/README.md | Template alignment + standardized notes and formatting. |
| dragonfly_db/README.md | Template alignment + standardized notes and formatting (includes typo fix). |
| elastic_email/README.md | Template alignment + standardized notes and formatting. |
| firebird_db/README.md | Template alignment + standardized notes and formatting; moves schema.py content into Additional files. |
| fleetio/README.md | Template alignment + standardized notes and formatting; simplifies tables list formatting. |
| fred/README.md | Template alignment + standardized notes and formatting. |
| gcp_pub_sub/README.md | Template alignment + standardized notes and formatting. |
| github/README.md | Template alignment + standardized notes and formatting. |
| github_traffic/README.md | Larger restructure to add missing template sections and standard notes. |
| gnews/README.md | Template alignment + standardized notes and formatting. |
fivetran-JenasVimal
requested review from
fivetran-rishabhghosh and
fivetran-sahilkhirwal
fivetran-JenasVimal
added
ai-assisted/yes
risk/low
and removed
risk/unknown
ai-assisted/unknown
labels
|
@fivetran-rishabhghosh @fivetran-sahilkhirwal Added to every connector
Formatting fixes (applied broadly)
Per-connector specifics
|
fivetran-sahilkhirwal
left a comment
fivetran-sahilkhirwal
left a comment
There was a problem hiding this comment.
Looks good
Please create follow up tickets for the mentioned comments by copilot
|
Made a new ticket @fivetran-sahilkhirwal |
fivetran-rishabhghosh
left a comment
fivetran-rishabhghosh
left a comment
There was a problem hiding this comment.
As discussed we should point to public docs instead of hardcoding values here. These values will be outdated soon after a new release is done
| ## Additional files | ||
|
|
||
| ## Additional Files | ||
|
|
||
| `clickhouse_dummy_data_generator.py`: This python file contains functions to add dummy data to the Clickhouse database. It creates dummy database and table and generates random records with unique IDs and timestamps. This dummy data is inserted into the Clickhouse table for testing purposes. In production, you will not need to insert dummy data, as the connector will work with your existing Clickhouse database. | ||
|
|
||
| **`clickhouse_dummy_data_generator.py`**: This python file contains functions to add dummy data to the Clickhouse database. It creates dummy database and table and generates random records with unique IDs and timestamps. This dummy data is inserted into the Clickhouse table for testing purposes. In production, you will not need to insert dummy data, as the connector will work with your existing Clickhouse database. | ||
|
|
There was a problem hiding this comment.
clickhouse_dummy_data_generator.py is referenced under Additional files, but it is not present in the clickhouse/ directory. Either add the file (so users can follow the instructions) or remove/update this reference. Also consider formatting this as a bulleted list item (the repo README guidelines prefer bold filenames in lists under Additional files).
There was a problem hiding this comment.
@fivetran-sahilkhirwal @fivetran-rishabhghosh inputs on this please
There was a problem hiding this comment.
Please clean this up
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
fivetran-JenasVimal
requested review from
Copilot,
fivetran-rishabhghosh and
fivetran-sahilkhirwal
and removed request for
fivetran-rishabhghosh
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 36 out of 36 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
apache_hive/using_pyhive/README.md:43
- The configuration example uses "hostname": "YOUR_HIVE_HOSTNAME", which doesn’t follow the placeholder convention used elsewhere in these READMEs (for example,
<YOUR_HIVE_HOSTNAME>). Please update this value to the standard placeholder style for consistency and to reduce copy/paste ambiguity.
```json
{
"hostname": "YOUR_HIVE_HOSTNAME",
"port": "<YOUR_HIVE_PORT>",
"username": "<YOUR_HIVE_USERNAME>",
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 36 out of 36 changed files in this pull request and generated 3 comments.
Comments suppressed due to low confidence (1)
apache_hive/using_pyhive/README.md:45
- In the configuration snippet,
hostnameis shown as"YOUR_HIVE_HOSTNAME", but the actualapache_hive/using_pyhive/configuration.json(and the rest of the snippet) uses the angle-bracket placeholder format (for example,<YOUR_HIVE_HOSTNAME>). Update the README snippet to match the realconfiguration.jsonso it’s consistent and copy/paste friendly.
```json
{
"hostname": "YOUR_HIVE_HOSTNAME",
"port": "<YOUR_HIVE_PORT>",
"username": "<YOUR_HIVE_USERNAME>",
"password": "<YOUR_HIVE_PASSWORD>",
"database": "<YOUR_HIVE_DATABASE>"
| "api_key": "<INSERT_YOUR_GNEWS_API_KEY>", | ||
| "search_term": "<INSERT_SEARCH_TERM>", | ||
| "from_date": "<YYYY-MM-DD_START_DATE>" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
The example configuration.json snippet uses placeholders like <INSERT_YOUR_GNEWS_API_KEY> / <INSERT_SEARCH_TERM>, but the actual gnews/configuration.json uses <YOUR_GNEWS_API_KEY> / <YOUR_SEARCH_TERM>. Align the README placeholders with the checked-in configuration.json so users don’t copy/paste invalid keys.
| `fivetran init` initializes a new Connector SDK project by setting up the project structure, configuration files, and a connector you can run immediately with `fivetran debug`. For more information on `fivetran init`, refer to the [Connector SDK `init` documentation](https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/connector-sdk-commands#fivetraninit). | ||
|
|
There was a problem hiding this comment.
This README claims to be standardized against the repository README template, but the “Connector SDK init documentation” link points to https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/connector-sdk-commands#fivetraninit instead of the template’s link (https://fivetran.com/docs/connectors/connector-sdk/technical-reference/init). Please align this link with the template (or update the template if the canonical docs URL has changed).
| ```json | ||
| { | ||
| "Account-Token": "<accountToken>", | ||
| "Authorization": "Token <ApiKey>" | ||
| } |
There was a problem hiding this comment.
The configuration snippet uses placeholders (<accountToken>, Token <ApiKey>) that don’t match the checked-in fleetio/configuration.json (<YOUR_FLEETIO_ACCOUNT_TOKEN>, Token <YOUR_FLEETIO_API_KEY>). Align the README snippet with configuration.json so users can copy/paste the correct keys and placeholder format.
Closes RD-1190038
Description of Change
Standardizes README files for connectors #1–33 (apache_hbase → gnews) against the README template.
Covers 35 files (33 connectors +
apache_hive× 2 sub-implementations +aws_athena× 2 sub-implementations).Testing
README-only changes — no connector code modified.
Checklist
fivetran debugcommand.