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

Add documentation for Deckard's fields/methods usage with different use cases #25

Open
lucasoares opened this issue Jun 27, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@lucasoares
Copy link
Member

lucasoares commented Jun 27, 2023

This issue proposes the addition documentation for Deckard covering the usage of its fields and methods in different use cases. The documentation will serve as a valuable resource for developers, providing clear instructions and examples on how to use Deckard's features effectively.

Example:

  • breakpoint field - commonly used when a message is used to process a large number of elements, enabling the worker applications to track the progress and resume from where it left off. For example, if we have a social media page with 10,000 posts and need to process them in batches of 10, the "breakpoint" field allows the application to store the last processed position, ensuring it can continue from there in subsequent iterations on different workers.
@lucasoares lucasoares added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 27, 2023
@lucasoares
Copy link
Member Author

We improved the documentation of our message fields: https://github.com/takenet/deckard/blob/main/docs/proto.md

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant