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

Rework SQS documentation to be clearer #50

Merged
merged 4 commits into from
Jul 4, 2021
Merged

Conversation

t-richard
Copy link
Member

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.

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.
Copy link
Member

@mnapoli mnapoli left a 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.
Copy link
Member

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?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Done 👍

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
t-richard and others added 2 commits July 4, 2021 11:54
Co-authored-by: Matthieu Napoli <matthieu@mnapoli.fr>
@mnapoli mnapoli added the documentation Improvements or additions to documentation label Jul 4, 2021
@mnapoli
Copy link
Member

mnapoli commented Jul 4, 2021

Thank you!

@mnapoli mnapoli merged commit 47aad4a into brefphp:master Jul 4, 2021
@t-richard t-richard deleted the patch-1 branch July 5, 2021 06:09
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants