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

docs(data_classes): improve Event Source Data Classes documentation #5916

Merged
merged 8 commits into from
Jan 24, 2025

Conversation

anafalcao
Copy link
Collaborator

Issue number:
#1163

Summary

This PR enhances the Event Source Data Classes documentation by adding copy-and-paste examples, including event examples for all event sources, updating the header explanation, revising the Getting Started section, and adding explanations to data sources that previously lacked them.

Changes

  • Added copy-and-paste code examples for each event source data class
  • Included sample event JSON for all event sources
  • Updated the header explanation to provide a clearer overview of event source data classes
  • Revised the getting started section to make it more user-friendly
  • Added explanations to data sources that were missing them

User experience

Before:

  • Users had to manually construct event handling code
  • Limited examples and no sample event JSONs were provided
  • Some data sources lacked explanations, making it difficult for users to understand their purpose

After:

  • Users can copy and paste ready-to-use code examples for quick implementation
  • Sample event JSONs are provided, allowing users to understand the structure of incoming events
  • Comprehensive explanations for all data sources help users choose the appropriate event source for their use case
  • Improved getting started section guides users through the implementation process more effectively

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jan 24, 2025
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jan 24, 2025
@anafalcao anafalcao marked this pull request as ready for review January 24, 2025 19:07
@anafalcao anafalcao requested a review from a team as a code owner January 24, 2025 19:07
@anafalcao anafalcao self-assigned this Jan 24, 2025
@anafalcao anafalcao linked an issue Jan 24, 2025 that may be closed by this pull request
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.22%. Comparing base (5517f1d) to head (69ed199).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #5916   +/-   ##
========================================
  Coverage    96.22%   96.22%           
========================================
  Files          233      233           
  Lines        10965    10965           
  Branches       790      790           
========================================
  Hits         10551    10551           
  Misses         327      327           
  Partials        87       87           

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

@leandrodamascena leandrodamascena self-requested a review January 24, 2025 20:26
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AMAZING WORK @anafalcao! APPROVED!

@anafalcao anafalcao merged commit 015f923 into aws-powertools:develop Jan 24, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Revamp Data Classes utility docs to surface many unknown features
2 participants