docs: updated readme, contributing, and release docs #120
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces significant updates to the documentation for the Airbyte Python CDK, including the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Wanna add anything else or make any tweaks to the labels or reviewers? wdyt? Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (9)
README.md (2)
7-14: LGTM! Great improvement in guiding users through the options.The progression from Connector Builder to low-code CDK is well structured. Would you consider adding a percentage or example for the "more flexible and complex connectors" similar to how you quantified the simpler case (90%)? This could help users better self-select their path, wdyt?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: Possible missing preposition found.
Context: .../overview). It should be enough for 90% connectors out there. For more flexible and comple...(AI_EN_LECTOR_MISSING_PREPOSITION)
20-26: The component descriptions are clear and well-organized!Would you consider these minor grammatical tweaks to enhance readability?
-This module defines the `source-declarative-manifest` (aka "SDM") connector execution logic and associated CLI. +This module defines the execution logic and associated CLI for the `source-declarative-manifest` (aka "SDM") connector. -Basic Destination connector support! If you're building a Destination connector in Python, try that. +Basic Destination connector support! If you're building a Destination connector in Python, consider using this.docs/RELEASES.md (2)
5-18: The release instructions are comprehensive and well-structured!Would you consider formatting the bare URLs as proper markdown links for better readability? For example:
-https://github.com/airbytehq/airbyte-python-cdk/releases +[releases page](https://github.com/airbytehq/airbyte-python-cdk/releases) -https://github.com/airbytehq/airbyte-python-cdk/actions/workflows/pypi_publish.yml +[GitHub Actions view](https://github.com/airbytehq/airbyte-python-cdk/actions/workflows/pypi_publish.yml)🧰 Tools
🪛 Markdownlint (0.35.0)
5-5: null
Bare URL used(MD034, no-bare-urls)
16-16: null
Bare URL used(MD034, no-bare-urls)
18-18: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
18-18: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
26-27: Minor typo and consistency improvements needed.Would you consider these small fixes?
-3. In the tag selector, type the version number of the prerelease you'd like to create and copy-past the same into the Release name box. +3. In the tag selector, type the version number of the pre-release you'd like to create and copy-paste the same into the Release name box.🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: Do not mix variants of the same word (‘prerelease’ and ‘pre-release’) within a single text.
Context: ...elector, type the version number of the prerelease you’d like to create and copy-past the ...(EN_WORD_COHERENCY)
docs/CONTRIBUTING.md (5)
7-10: The introduction looks great, but maybe we could make it even more welcoming? 🤔The bullet points are clear, but what do you think about adding Oxford commas for consistency? For example:
-You can contribute by reporting bugs, posting github discussions, opening issues, improving docs, and submitting pull requests with bugfixes and new features alike. +You can contribute by reporting bugs, posting GitHub discussions, opening issues, improving docs, and submitting pull requests with bugfixes and new features alike.Also, should we capitalize "GitHub" for consistency with our branding? wdyt?
26-26: Tiny typo spotted in the Poe tasks description 🔍There's a small typo in "to define common development task" - should be "tasks" (plural), right? wdyt?
41-43: Small formatting suggestions for consistency 📝A couple of minor tweaks to consider:
- Adding a comma after "locally" in the first line
- Capitalizing "Markdown" since we're referring to the formatting language
What are your thoughts on these small changes?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Possible missing comma found.
Context: ... Iterate on the CDK code locally. - Runpoetry run poe format-fixto auto-fix formatt...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~43-~43: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...y want to format Python code (excluding markdown, yaml, etc.), you can use `poetry run r...(MARKDOWN_NNP)
73-73: Quick grammar suggestion in the maintainers section ✨Would you consider adding a comma after "Generally" to improve the flow? Like this:
-Generally these are Airbyte team members. +Generally, these are Airbyte team members.🧰 Tools
🪛 LanguageTool
[typographical] ~73-~73: Consider adding a comma after ‘Generally’ for more clarity.
Context: ...te permissions (or higher) on the repo. Generally these are Airbyte team members. ### Q:...(RB_LY_COMMA)
155-155: Quick fix needed in the acceptance tests section 🛠️There's a small grammatical issue in "acceptance tests for a single connectors" - should we change it to either:
- "acceptance tests for a single connector" or
- "acceptance tests for single connectors"
Which version do you prefer?
🧰 Tools
🪛 LanguageTool
[grammar] ~155-~155: The plural noun “connectors” cannot be used with the article “a”. Did you mean “a single connector” or “single connectors”?
Context: ...EADME.md)_ To run acceptance tests for a single connectors using the local CDK, from the connector...(A_NNS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
README.md(1 hunks)docs/CONTRIBUTING.md(1 hunks)docs/RELEASES.md(1 hunks)pyproject.toml(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/RELEASES.md
[uncategorized] ~26-~26: Do not mix variants of the same word (‘prerelease’ and ‘pre-release’) within a single text.
Context: ...elector, type the version number of the prerelease you’d like to create and copy-past the ...
(EN_WORD_COHERENCY)
README.md
[uncategorized] ~11-~11: Possible missing preposition found.
Context: .../overview). It should be enough for 90% connectors out there. For more flexible and comple...
(AI_EN_LECTOR_MISSING_PREPOSITION)
[uncategorized] ~17-~17: You might be missing the article “the” here.
Context: ....airbyte.com). ## Python CDK Overview Airbyte CDK code is within airbyte_cdk direct...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~18-~18: You might be missing the article “the” here.
Context: ...DK Overview Airbyte CDK code is within airbyte_cdk directory. Here's a high le...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~18-~18: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ithin airbyte_cdk directory. Here's a high level overview of what's inside: - `airbyte_...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/CONTRIBUTING.md
[uncategorized] ~42-~42: Possible missing comma found.
Context: ... Iterate on the CDK code locally. - Run poetry run poe format-fix to auto-fix formatt...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~43-~43: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...y want to format Python code (excluding markdown, yaml, etc.), you can use `poetry run r...
(MARKDOWN_NNP)
[style] ~49-~49: Consider a shorter alternative to avoid wordiness.
Context: ...rator, you may need to regenerate them. In order to do that, you can run: ```bash poetry r...
(IN_ORDER_TO_PREMIUM)
[style] ~49-~49: Consider a more expressive alternative.
Context: ...ay need to regenerate them. In order to do that, you can run: ```bash poetry run ...
(DO_ACHIEVE)
[typographical] ~73-~73: Consider adding a comma after ‘Generally’ for more clarity.
Context: ...te permissions (or higher) on the repo. Generally these are Airbyte team members. ### Q:...
(RB_LY_COMMA)
[uncategorized] ~79-~79: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...What GitHub slash commands are available and who can run them? Only Airbyte CDK mai...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~92-~92: Consider a shorter alternative to avoid wordiness.
Context: ...to do end-to-end testing at least once. In order to do so, you can emulate the server you w...
(IN_ORDER_TO_PREMIUM)
[grammar] ~108-~108: Did you mean “matching”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...unning the following command will allow to match any requests on path /data to return ...
(ALLOW_TO)
[uncategorized] ~128-~128: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...king directory. When testing is complete and you've published the CDK update, rememb...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~155-~155: The plural noun “connectors” cannot be used with the article “a”. Did you mean “a single connector” or “single connectors”?
Context: ...EADME.md)_ To run acceptance tests for a single connectors using the local CDK, from the connector...
(A_NNS)
🪛 Markdownlint (0.35.0)
docs/RELEASES.md
5-5: null
Bare URL used
(MD034, no-bare-urls)
16-16: null
Bare URL used
(MD034, no-bare-urls)
24-24: null
Bare URL used
(MD034, no-bare-urls)
37-37: null
Bare URL used
(MD034, no-bare-urls)
18-18: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
18-18: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
46-46: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
46-46: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
🔇 Additional comments (3)
pyproject.toml (2)
154-155: LGTM! Clear and helpful task descriptions.
The distinction between safe and unsafe fixes is well explained, and the warning about committing changes before applying unsafe fixes is particularly valuable.
179-180: LGTM! Documentation tasks are well defined.
The separation between generation and preview tasks is clear, and the help messages effectively explain their purposes.
docs/CONTRIBUTING.md (1)
1-159: Overall, this is a fantastic contribution to the docs! 🎉
The documentation is well-structured, comprehensive, and very helpful for contributors. The setup instructions are clear, and the advanced topics provide valuable guidance. The minor suggestions above are just for polishing what's already a great piece of documentation.
Great work on making the contributing process more accessible and well-documented! 👏
🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: Possible missing comma found.
Context: ... Iterate on the CDK code locally. - Run poetry run poe format-fix to auto-fix formatt...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~43-~43: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...y want to format Python code (excluding markdown, yaml, etc.), you can use `poetry run r...
(MARKDOWN_NNP)
[style] ~49-~49: Consider a shorter alternative to avoid wordiness.
Context: ...rator, you may need to regenerate them. In order to do that, you can run: ```bash poetry r...
(IN_ORDER_TO_PREMIUM)
[style] ~49-~49: Consider a more expressive alternative.
Context: ...ay need to regenerate them. In order to do that, you can run: ```bash poetry run ...
(DO_ACHIEVE)
[typographical] ~73-~73: Consider adding a comma after ‘Generally’ for more clarity.
Context: ...te permissions (or higher) on the repo. Generally these are Airbyte team members. ### Q:...
(RB_LY_COMMA)
[uncategorized] ~79-~79: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...What GitHub slash commands are available and who can run them? Only Airbyte CDK mai...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~92-~92: Consider a shorter alternative to avoid wordiness.
Context: ...to do end-to-end testing at least once. In order to do so, you can emulate the server you w...
(IN_ORDER_TO_PREMIUM)
[grammar] ~108-~108: Did you mean “matching”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...unning the following command will allow to match any requests on path /data to return ...
(ALLOW_TO)
[uncategorized] ~128-~128: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...king directory. When testing is complete and you've published the CDK update, rememb...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~155-~155: The plural noun “connectors” cannot be used with the article “a”. Did you mean “a single connector” or “single connectors”?
Context: ...EADME.md)_ To run acceptance tests for a single connectors using the local CDK, from the connector...
(A_NNS)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
README.md (2)
9-14: Consider standardizing the documentation links format, wdyt?The links to docs.airbyte.com are formatted in different ways:
[start with the Connector Builder](https://docs.airbyte.com/...)[docs.airbyte.com](https://docs.airbyte.com)Would you consider standardizing to use the descriptive format consistently? For example:
-[docs.airbyte.com](https://docs.airbyte.com) +[Airbyte Documentation](https://docs.airbyte.com)
18-18: Quick grammar fix: should we hyphenate "high-level"?Since "high-level" is functioning as a compound adjective modifying "overview", it should be hyphenated:
-Here's a high level overview of what's inside: +Here's a high-level overview of what's inside:🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ithinairbyte_cdkdirectory. Here's a high level overview of what's inside: - `airbyte_...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~18-~18: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ithin airbyte_cdk directory. Here's a high level overview of what's inside: - `airbyte_...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (2)
README.md (2)
20-26: Great job on the detailed directory structure! 👏
The breakdown of each component with clear descriptions helps users understand the codebase organization.
30-34: Clean and concise documentation structure! 💯
The Contributing and Release Management sections are well-organized, providing clear links to detailed documentation while keeping the README focused.
| @@ -4,226 +4,31 @@ Airbyte Python CDK is a framework for building Airbyte API Source Connectors. It | |||
| classes and helpers that make it easy to build a connector against an HTTP API (REST, GraphQL, etc), | |||
| or a generic Python source connector. | |||
|
|
|||
| ## Usage | |||
| ## Building Connectors with the CDK | |||
| This will generate a project with a type and a name of your choice and put it in | ||
| `airbyte-integrations/connectors`. Open the directory with your connector in an editor and follow | ||
| the `TODO` items. | ||
| For more information on building connectors, please see the [Connector Development](https://docs.airbyte.com/connector-development/) guide on [docs.airbyte.com](https://docs.airbyte.com). |
There was a problem hiding this comment.
Honestly, that's the way. Those always get out of date, so it's good to just link to the general guide.
This brings in the docs from the Notion page, and divides our README content into three main pages:
README.md- An intro to the project and its organization. Short enough to be a sane landing page.docs/CONTRIBUTING.md- The first place to go for info on how to contribute.docs/RELEASES.md- Info on maintenance and release processes. (Requires write permission on the repo so won't be relevant for external contributors.)Summary by CodeRabbit
Release Notes
README.md, focusing on building connectors.CONTRIBUTING.mdwith detailed setup instructions and new sections on development tasks.RELEASES.mdguide for managing stable and pre-release versions.pyproject.tomlfor better usability in documentation and linting processes.