You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fiber added its first add-on in PR #1972, called retry. The documentation for this add-on is not currently included in v3's documentation on docs.gofiber.io.
This issue is to propose to add this missing documentation under a new collapsible tab under the middleware tab, similar to the concept screenshots below:
Before:
After:
We can discuss about the best emoji/naming style of the tab, but overall this is where we could include the docs for retry and future add-ons.
Impact on the Project
Once added to docs.gofiber.io, we will have more users know about the existence of the retry add-on, and know how to use it.
Additionally, future add-ons can be added here to keep the docs all in one place.
Additional Context (optional)
The retry add-on is similar to fiber.Client in that it allows users to make client calls from within a Fiber handler. The main difference is that it retries these client calls if an error occurs, using an exponential backoff algorithm with jitter to avoid constantly spamming a server's endpoint if it isn't responding. The initial examples are included in the PR #1972 and its issue #1840.
Additionally, it appears that there is some missing documentation about how to use the retry mechanism in the README.md file. Specifically, the Example section seems to be incomplete, as it only includes the import, and not a use case.
Checklist:
I have confirmed that this maintenance task is currently not being addressed.
I understand that this task will be evaluated by the maintainers and prioritized accordingly.
I am available to provide further information if needed.
The text was updated successfully, but these errors were encountered:
Maintenance Task Description
Fiber added its first add-on in PR #1972, called retry. The documentation for this add-on is not currently included in v3's documentation on
docs.gofiber.io
.This issue is to propose to add this missing documentation under a new collapsible tab under the middleware tab, similar to the concept screenshots below:
Before:
After:
We can discuss about the best emoji/naming style of the tab, but overall this is where we could include the docs for
retry
and future add-ons.Impact on the Project
Once added to
docs.gofiber.io
, we will have more users know about the existence of theretry
add-on, and know how to use it.Additionally, future add-ons can be added here to keep the docs all in one place.
Additional Context (optional)
The
retry
add-on is similar tofiber.Client
in that it allows users to make client calls from within a Fiber handler. The main difference is that it retries these client calls if an error occurs, using an exponential backoff algorithm with jitter to avoid constantly spamming a server's endpoint if it isn't responding. The initial examples are included in the PR #1972 and its issue #1840.Additionally, it appears that there is some missing documentation about how to use the
retry
mechanism in the README.md file. Specifically, the Example section seems to be incomplete, as it only includes the import, and not a use case.Checklist:
The text was updated successfully, but these errors were encountered: