-
Notifications
You must be signed in to change notification settings - Fork 20
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
Rework SQS documentation to be clearer #50
Conversation
Following brefphp#49. The docs weren't clear about permissions which lead to the issue. Here I advise to disable auto_setup and set the appropriate permissions. I also took this as an opportunity to suggest using Lift.
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.
I think this is overall a very good improvement! I've added inline suggestions and we are good to merge, thank you!
README.md
Outdated
You can create the Queue yourself in the Console, write custom Cloudformation | ||
or use [Lift's Queue construct](https://github.com/getlift/lift/blob/master/docs/queue.md) that will handle that for you. | ||
|
||
Here is a simple example with Lift, check out the [full documentation](https://github.com/getlift/lift/blob/master/docs/queue.md) for more details. |
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.
Maybe mention that the Lift plugin needs to be installed? (with a link to the README?)
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.
Good point. Done 👍
Co-authored-by: Matthieu Napoli <matthieu@mnapoli.fr>
Thank you! |
Following #49.
The docs weren't clear about permissions which lead to the issue.
Here I advise to disable
auto_setup
and set the appropriate permissions. I also took this as an opportunity to suggest using Lift.Not sure we should keep examples both with and without Lift or just point to external docs when not using Lift.
Let me know what you think.