-
Notifications
You must be signed in to change notification settings - Fork 403
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
chore(batch): deprecate sqs_batch_processor #1463
chore(batch): deprecate sqs_batch_processor #1463
Conversation
@heitorlessa I do not know if the way I've implemented the banner on the docs is the correct way to do it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! Two notes on repurposing announcement bar to inform customers of v2, and admonition for batch.md
@@ -1,5 +1,10 @@ | |||
{% extends "base.html" %} | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This would add an announcement for the entire documentation, we'd want under batch.md
instead with admonition:
???+ warning
our message...
This type of announcement will be super useful to let people know we're going to launch v2. So perhaps rephrase to inform them that? I think it'll also need to make it auto-hide so those who already seen don't see it again: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/?h=announcement#automatic-hiding
Co-authored-by: Heitor Lessa <[email protected]>
Moved the warning to the batch doc page, and added a banner to documentation saying "v2 is coming". As always, feedback on wording is very important to me. |
Issue number: #1459
Summary
Changes
This PR adds a deprecation warning to the
sqs_batch_processor
decorator andPartialSQSProcessor
class.It also adds a banner on the documentation urging customers to upgrade before the next major version.
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
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.