Skip to content

Conversation

@dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Jul 31, 2023

Description of your changes

This PR introduces the following changes to the Batch Processing documentation page:

  • Add tooltips/callouts in the code snippets to better explain certain lines
  • Add flow charts to explain the data flow when processing batches & reporting failures
  • Added a new error handling section

Related issues, RFCs

Issue number: #1639

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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.

@dreamorosi dreamorosi requested a review from a team July 31, 2023 17:21
@dreamorosi dreamorosi self-assigned this Jul 31, 2023
@dreamorosi dreamorosi linked an issue Jul 31, 2023 that may be closed by this pull request
1 task
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jul 31, 2023
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Jul 31, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@dreamorosi dreamorosi merged commit 24b0ca1 into main Jul 31, 2023
@dreamorosi dreamorosi deleted the 1639-docs-include-flow-diagrams-in-batch-processing-docs branch July 31, 2023 18:21
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/L PRs between 100-499 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: include flow diagrams in Batch Processing docs

1 participant