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.

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

[DOP-14058] Improve Kafka documentation #276

Merged
merged 1 commit into from
May 22, 2024
Merged

Conversation

dolfinus
Copy link
Member

@dolfinus dolfinus commented May 20, 2024

Change Summary

  • Move parse_column and serialize_column examples to docstrings.
  • Update reading & writing Kafka documentation to match other connectors - include list of supported DBReader features, code examples, simplify Dataframe schema note.
  • Add Prerequisites section to Kafka, describing connection addresses, protocols, auth mechanisms and so on.
  • Add Troubleshooting section. Currently it's not much we can mention here, but this can be improved in future versions.

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

@dolfinus dolfinus self-assigned this May 20, 2024
@dolfinus dolfinus added the ci:skip-changelog Add this label to skip changelog file check label May 20, 2024
Copy link

codecov bot commented May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.71%. Comparing base (aa2b753) to head (dccd8c5).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #276      +/-   ##
===========================================
+ Coverage    94.69%   94.71%   +0.02%     
===========================================
  Files          204      204              
  Lines         8068     8068              
  Branches      1410     1410              
===========================================
+ Hits          7640     7642       +2     
+ Misses         305      304       -1     
+ Partials       123      122       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dolfinus dolfinus marked this pull request as ready for review May 20, 2024 14:50
@dolfinus dolfinus marked this pull request as draft May 20, 2024 15:57
@dolfinus dolfinus marked this pull request as ready for review May 21, 2024 14:33
@dolfinus dolfinus removed the ci:skip-changelog Add this label to skip changelog file check label May 21, 2024
@dolfinus dolfinus enabled auto-merge (rebase) May 22, 2024 09:19
@dolfinus dolfinus merged commit e9788fd into develop May 22, 2024
36 checks passed
@dolfinus dolfinus deleted the feature/DOP-14058 branch May 22, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants