oss/release: readme update #744
Conversation
WalkthroughThe README.md file was completely rewritten, replacing all original content with a brief disclaimer and overview. The new README clarifies that this repository is a fork of Airbnb’s Chronon, outlines key differences, and provides guidance on usage and contact, while removing all previous documentation and instructions. Changes
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
🧹 Nitpick comments (6)
README.md (6)
2-2: Use full URL for Airbnb repo
Replaceg.yxqyang.asia/airbnb/chrononwithhttps://github.com/airbnb/chronon.
5-9: Fix blockquote list formatting
Remove extra spaces after>so each item is> - …, and add missing period after “etc.” in list entries.🧰 Tools
🪛 LanguageTool
[style] ~6-~6: In American English, abbreviations like “etc.” require a period.
Context: ...ore libraries like spark, flink, thrift etc > - Performance optimizations to back...(ETC_PERIOD)
[uncategorized] ~8-~8: A determiner appears to be missing. Consider inserting it.
Context: ...izations to backfill and serving. > - Compiler has a specialized gcp and aws runners, ...(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
5-5: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
5-5: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
6-6: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
6-6: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
7-7: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
7-7: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
8-8: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
8-8: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
9-9: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
9-9: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
8-8: Capitalize acronyms and add determiner
Change to “> - The compiler has specialized GCP and AWS runners…” for grammar and consistent acronym casing.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: A determiner appears to be missing. Consider inserting it.
Context: ...izations to backfill and serving. > - Compiler has a specialized gcp and aws runners, ...(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
8-8: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
8-8: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
13-14: Align list under open-source section
Use> - …(no extra indent) for the bullets under “Why are we open-sourcing this?”.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
13-13: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
13-13: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
14-14: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
14-14: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
17-17: Rephrase for clarity
Consider:“Upstreaming is challenging due to modifications in the kvstore interface and Thrift API.”
🧰 Tools
🪛 LanguageTool
[style] ~17-~17: Consider shortening or rephrasing this to strengthen your wording.
Context: ...> > ### Why not upstream it? > We have made changes to the kvstore interface and the thrift ap...(MAKE_CHANGES)
22-22: Wrap email in markdown link
Use<[email protected]>or[[email protected]](mailto:[email protected])to avoid bare-URL warnings.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~6-~6: In American English, abbreviations like “etc.” require a period.
Context: ...ore libraries like spark, flink, thrift etc > - Performance optimizations to back...
(ETC_PERIOD)
[uncategorized] ~8-~8: A determiner appears to be missing. Consider inserting it.
Context: ...izations to backfill and serving. > - Compiler has a specialized gcp and aws runners, ...
(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~17-~17: Consider shortening or rephrasing this to strengthen your wording.
Context: ...> > ### Why not upstream it? > We have made changes to the kvstore interface and the thrift ap...
(MAKE_CHANGES)
🪛 markdownlint-cli2 (0.17.2)
README.md
5-5: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
5-5: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
6-6: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
6-6: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
7-7: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
7-7: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
8-8: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
8-8: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
9-9: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
9-9: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
13-13: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
13-13: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
14-14: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
14-14: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
22-22: Bare URL used
null
(MD034, no-bare-urls)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
3-9: Fix list indentation and acronym casing.
Use> -(no extra spaces) for blockquote lists and capitalizeGCP/AWS.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: A determiner appears to be missing. Consider inserting it.
Context: ...izations to backfill and serving. > - Compiler has specialized gcp and aws runners, an...(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
4-4: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
4-4: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
5-5: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
5-5: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
6-6: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
6-6: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
7-7: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
7-7: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
8-8: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
8-8: Multiple spaces after blockquote symbol
null(MD027, no-multiple-space-blockquote)
11-13: Convert bare URL to markdown link.
Use[Zipline](https://zipline.ai)or enclose in<...>.
15-17: Shorten 'on a regular basis'.
Replace withregularlyfor brevity.🧰 Tools
🪛 LanguageTool
[style] ~15-~15: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...on are picked and merged into this repo on a regular basis, and improvements made to this reposito...(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~7-~7: A determiner appears to be missing. Consider inserting it.
Context: ...izations to backfill and serving. > - Compiler has specialized gcp and aws runners, an...
(AI_EN_LECTOR_MISSING_DETERMINER)
[style] ~15-~15: ‘on a regular basis’ might be wordy. Consider a shorter alternative.
Context: ...on are picked and merged into this repo on a regular basis, and improvements made to this reposito...
(EN_WORDINESS_PREMIUM_ON_A_REGULAR_BASIS)
🪛 markdownlint-cli2 (0.17.2)
README.md
4-4: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
4-4: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
5-5: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
5-5: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
6-6: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
6-6: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
7-7: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
7-7: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
8-8: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
8-8: Multiple spaces after blockquote symbol
null
(MD027, no-multiple-space-blockquote)
19-19: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (2)
README.md (2)
1-2: Disclaimer reads well.
19-20: Usage note is clear.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
19-19: Bare URL used
null(MD034, no-bare-urls)
## Summary ## Checklist - [ ] Added Unit Tests - [x] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated the README with a concise overview and disclaimer about this repository being a fork of Airbnb’s Chronon. - Highlighted key differences including additional connectors, upgraded libraries, performance improvements, and specialized runners. - Clarified deployment options and maintenance practices. - Removed detailed usage instructions, examples, and conceptual explanations. - Noted that full documentation is forthcoming and invited users to contact maintainers for early access. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: ezvz <[email protected]>
## Summary ## Checklist - [ ] Added Unit Tests - [x] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated the README with a concise overview and disclaimer about this repository being a fork of Airbnb’s Chronon. - Highlighted key differences including additional connectors, upgraded libraries, performance improvements, and specialized runners. - Clarified deployment options and maintenance practices. - Removed detailed usage instructions, examples, and conceptual explanations. - Noted that full documentation is forthcoming and invited users to contact maintainers for early access. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: ezvz <[email protected]>
## Summary ## Cheour clientslist - [ ] Added Unit Tests - [x] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated the README with a concise overview and disclaimer about this repository being a fork of Airbnb’s Chronon. - Highlighted key differences including additional connectors, upgraded libraries, performance improvements, and specialized runners. - Clarified deployment options and maintenance practices. - Removed detailed usage instructions, examples, and conceptual explanations. - Noted that full documentation is forthcoming and invited users to contact maintainers for early access. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: ezvz <[email protected]>
Summary
Checklist
Summary by CodeRabbit