docs(batch): new visuals and error handling section

[heitorlessa]

Issue number: #2848

⭐ Inspired by @94Sip and @duc00 recent issues on Batch docs - THANK YOU

Summary

Revamps Batch Processing documentation to include visuals (state, class, sequences), several code annotations for more contextual information, improved Accessing processed messages, and new Error handling section.

Changes

Please provide a summary of what's being changed

• Diagram to introduce Batch Processing feature
• Diagram to introduce behavior without Batch Processing feature
• Cleaned up getting started
• Added code annotations for key examples for more contextual information (e.g., any exception is caught, etc.)
• New Error handling section
• Extend Partial failure mechanics section with sequence diagrams
• Sequence diagrams to explain behavior for each Processor and failure modes
• Improved callouts in Processing messages asynchronously
• Added sample raw processed messages in Accessing processed messages
• Improved wording to ease reading 3 tuple items in Accessing processed messages

User experience

Please share what the user experience looks like before and after this change

Intro diagram

🆕 Error handling section

Code annotation

Code annotation

🆕 Sequence diagrams section

SQS Standard queues

SQS FIFO

Kinesis and DynamoDB

Raw processing revamped plus samples

Class diagram for Bring Your Own Processor

Checklist

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

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

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.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication