Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Apache Kafka #2642

Closed
wants to merge 1 commit into from
Closed

Add Apache Kafka #2642

wants to merge 1 commit into from

Conversation

vordimous
Copy link

@vordimous vordimous commented May 26, 2023 •
edited
Loading

https://github.com/semantalytics/awesome-kafka

This list is about kafka which is an open-source distributed event streaming platform used by many teams to manage stateful events.

PRs Reviewed:
#2622
#2607

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.

Requirements for your pull request

  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
    Try to prioritize unreviewed PRs, but you can also add more comments to reviewed PRs. Go through the below list when reviewing. This requirement is meant to help make the Awesome project self-sustaining. Comment here which PRs you reviewed. You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions. Comments pointing out lint violation are allowed, but does not count as a review.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
    • ✅ Add Swift
    • ✅ Add Software Architecture
    • ❌ Update readme.md
    • ❌ Add Awesome Swift
    • ❌ Add swift
    • ❌ add Swift
    • ❌ Adding Swift
    • ❌ Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • ✅ - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • ✅ - [Framer](…) - Prototyping interactive UI designs.
    • ❌ - [iOS](…) - Resources and tools for iOS development.
    • ❌ - [Framer](…)
    • ❌ - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • ✅ Mobile operating system for Apple phones and tablets.
    • ✅ Prototyping interactive UI designs.
    • ❌ Resources and tools for iOS development.
    • ❌ Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • ✅ awesome-swift
    • ✅ awesome-web-typography
    • ❌ awesome-Swift
    • ❌ AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • ✅ # Awesome Swift
    • ✅ # Awesome Web Typography
    • ❌ # awesome-swift
    • ❌ # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
    You can still use a CI for linting, but the badge has no value in the readme.
  • Does not include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

Go to the top and read it again.

@sindresorhus
Copy link
Owner

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

@asapelkin
Copy link

Hello, @vordimous! It looks like you need to fix some awesome-lint errors first.
-> % npx awesome-lint https://github.com/semantalytics/awesome-kafka
✖ Linting
...
55 errors

@asapelkin asapelkin mentioned this pull request May 28, 2023
Closed
32 tasks
@vordimous
Copy link
Author

Thank you! Ill see if I can get these errors fixed in that repo.

@awesome-doge
Copy link

awesome-doge commented May 30, 2023 •
edited
Loading

no license document

截圖 2023-05-31 上午2 12 34

And also this is your error log

 ~/github/awesome-kafka │ on master  npx awesome-lint                                                                                                                                                                                    ✔ │ at 02:15:03 AM
✖ Linting

  README.md:5:3
  ✖    1:1    Main heading must be in title case                            remark-lint:awesome-heading
  ✖    1:1    Missing file contributing.md                                  remark-lint:awesome-contributing
  ✖    1:1    The repository should have a description                      remark-lint:awesome-github
  ✖    1:1    License was not detected by GitHub                            remark-lint:awesome-github
  ✖    1:1    Missing or invalid Table of Contents                          remark-lint:awesome-toc
  ✖    1:18   Invalid badge source                                          remark-lint:awesome-badge
  ✖    5:3    https://github.com/pinterest/doctorkafka                      remark-lint:double-link
  ✖    8:43   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   10:47   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   14:3    https://github.com/grantneale/kafka-lag-based-assignor        remark-lint:double-link
  ✖   14:85   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖   16:47   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   18:70   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   19:51   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   20:66   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   21:3    https://github.com/grantneale/kafka-lag-based-assignor        remark-lint:double-link
  ✖   21:85   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   22:51   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   23:46   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   26:49   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   27:53   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   31:50   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   33:38   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   35:3    https://github.com/pinterest/doctorkafka                      remark-lint:double-link
  ✖   35:58   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   39:71   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   42:53   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   44:63   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   45:58   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   46:3    https://github.com/obsidiandynamics/kafdrop                   remark-lint:double-link
  ✖   46:57   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   47:76   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   48:111  List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   52:66   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   53:3    https://github.com/obsidiandynamics/kafdrop                   remark-lint:double-link
  ✖   68:3    https://github.com/wintoncode/winton-kafka-streams            remark-lint:double-link
  ✖   68:77   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   72:3    https://github.com/streamthoughts/kafka-connect-file-pulse    remark-lint:double-link
  ✖   73:97   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   74:79   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   76:100  List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   82:52   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   84:3    https://github.com/aiven/aiven-kafka-connect-transforms       remark-lint:double-link
  ✖   85:3    https://github.com/streamthoughts/kafka-connect-file-pulse    remark-lint:double-link
  ✖   85:89   List item description must start with valid casing            remark-lint:awesome-list-item
  ✖   86:3    https://github.com/aiven/aiven-kafka-connect-transforms       remark-lint:double-link
  ✖   92:59   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   93:73   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖   99:69   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖  100:69   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖  123:3    https://github.com/wintoncode/winton-kafka-streams            remark-lint:double-link
  ✖  123:76   List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖  124:46   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  126:55   List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  135:43   List item link and description must be separated with a dash  remark-lint:awesome-list-item

  55 errors

@awesome-doge awesome-doge mentioned this pull request May 30, 2023
Closed
32 tasks
@vordimous
Copy link
Author

@sindresorhus @asapelkin @awesome-doge I have sent in a PR to the maintainer addressing the issues semantalytics/awesome-kafka#22

@awesome-doge
Copy link

@sindresorhus @asapelkin @awesome-doge I have sent in a PR to the maintainer addressing the issues semantalytics/awesome-kafka#22

@vordimous

Hello, there are still the following problems in your PR.

 ~/github/awesome-kafka │ on master ⇡8  npx awesome-lint                                                                                                                                                                                 ✔ │ at 02:38:00 PM
✖ Linting

  README.md:1:1
  ✖    1:1   The repository should have a description                      remark-lint:awesome-github
  ✖    1:1   License was not detected by GitHub                            remark-lint:awesome-github
  ✖    1:1   Missing or invalid Table of Contents                          remark-lint:awesome-toc
  ✖   12:3   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   13:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   14:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   15:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   16:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   17:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   18:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   19:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   20:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   21:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   22:3   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   23:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   24:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   25:5   Invalid list item link URL                                    remark-lint:awesome-list-item
  ✖   56:50  List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖  110:89  List item description must start with valid casing            remark-lint:awesome-list-item
  ✖  117:73  List item description must end with proper punctuation        remark-lint:awesome-list-item
  ✖  148:46  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  150:55  List item link and description must be separated with a dash  remark-lint:awesome-list-item
  ✖  162:43  List item link and description must be separated with a dash  remark-lint:awesome-list-item

  23 errors

@vordimous
Copy link
Author

@awesome-doge All lint rules are fixed.

@awesome-doge
Copy link

@vordimous

It looks like you still have two issues that need to be fixed.

 ~/github/awesome-kafka │ on master ⇡9  npx awesome-lint                                                                        ✔ │ at 10:13:52 PM
✖ Linting

  README.md:1:1
  ✖  1:1  The repository should have a description  remark-lint:awesome-github
  ✖  1:1  License was not detected by GitHub        remark-lint:awesome-github

  2 errors

@vordimous
Copy link
Author

vordimous commented May 31, 2023 •
edited
Loading

@awesome-doge When I run it against my fork, it comes back clean. I believe those errors have to be handled by the repo maintainer, which I have mentioned in the PR.

awesome-kafka % npx awesome-lint https://github.com/vordimous/awesome-kafka
✔ Linting

@vordimous vordimous mentioned this pull request Jun 5, 2023
Merged
@vordimous
Copy link
Author

@zacharywhitley The only step left for these lint errors to be resolved is for you to add a repo description.

@vordimous
Copy link
Author

@sindresorhus @awesome-doge All of the linter rules are passing and the checks are passing.

@vordimous
Copy link
Author

@zacharywhitley @sindresorhus @awesome-doge bump

@sindresorhus
Copy link
Owner

You're expected to put a good effort into this and to be thorough. Look at previous PR reviews for inspiration. Just commenting “looks good” or simply marking the pull request as approved does not count! You have to actually point out mistakes or improvement suggestions.

@sindresorhus
Copy link
Owner

Entries have a description, unless the title is descriptive enough by itself. It rarely is though.

@vordimous vordimous closed this Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrzejsydor andrzejsydor andrzejsydor approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@vordimous @sindresorhus @asapelkin @awesome-doge @andrzejsydor