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

Update queue_url documentation #38

Merged
merged 3 commits into from
Oct 30, 2019
Merged

Conversation

vanetix
Copy link
Contributor

@vanetix vanetix commented Oct 30, 2019

This adds the requested changes for #37 as I ran into the same thing with full queue urls. Also wanted to clarify the wait_time_seconds documentation with a link to the AWS docs.

Fixes #37

Copy link

@benwilson512 benwilson512 left a comment

Choose a reason for hiding this comment

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

Largely correct but the example should be updated to match the domain in the AWS docs.

@@ -30,7 +30,7 @@ Broadway.start_link(MyBroadway,
producers: [
default: [
module: {BroadwaySQS.Producer,
queue_url: "https://us-east-2.queue.amazonaws.com/100000000001/my_queue"
queue_url: "https://sqs.amazonaws.com/1234567890/queue"

Choose a reason for hiding this comment

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

Examples in the AWS docs show this as https://queue.amazonaws.com not sqs.amazonaws.com

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm okay to update this, but the URL I posted is going to be what folks will get as a url from the console, however it looks like those legacy urls are still returned from aws-cli.

I'm fine either way I just wanted to make sure it was straightforward for new users that aren't as familiar with AWS. Maybe we should add both url formats under the queue url option example?

Link to issue: aws/aws-cli#1715

Choose a reason for hiding this comment

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

Ah yes you're right, I ended up on the legacy docs. What you have is perfect, so :shipit:

@josevalim josevalim merged commit ebccff0 into dashbitco:master Oct 30, 2019
@josevalim
Copy link
Member

❤️ 💚 💙 💛 💜

@vanetix vanetix deleted the f/docs-update branch October 30, 2019 21:16
@msaraiva msaraiva mentioned this pull request Nov 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

queue_url & region config
3 participants