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
Hi, would there be interest in adding reference documentation for configuration?
As a newcomer to Laravel working on an app, I'm often unaware of what configuration options exist for some features and what they do.
I usually end up digging through the source code but, IMO, it would be incredibly useful to have these options in the documentation, similar to how some parts of the API (e.g. assertions, collection methods) are listed.
As an example of what I mean:
SQS (Simple Queue Service) driver
Pushes items into SQS queues.
The queue URL template is as follows: https://sqs.{$region}.amazonaws.com{$prefix}/{$queue}{$suffix}
key: the AWS key id, as usually set using the AWS_ACCESS_KEY_ID environment variable
prefix: a prefix added to the queue URL path. This should usually be set to the account id and must start with a forward slash, e.g./1235123.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi, would there be interest in adding reference documentation for configuration?
As a newcomer to Laravel working on an app, I'm often unaware of what configuration options exist for some features and what they do.
I usually end up digging through the source code but, IMO, it would be incredibly useful to have these options in the documentation, similar to how some parts of the API (e.g. assertions, collection methods) are listed.
As an example of what I mean:
SQS (Simple Queue Service) driver
Pushes items into SQS queues.
The queue URL template is as follows:
https://sqs.{$region}.amazonaws.com{$prefix}/{$queue}{$suffix}
key
: the AWS key id, as usually set using theAWS_ACCESS_KEY_ID
environment variableprefix
: a prefix added to the queue URL path. This should usually be set to the account id and must start with a forward slash, e.g./1235123
.suffix
: a suffix added to the queue URLSqsClient
constructor, see the S3Client docs for available settingsExamples
Assuming this configuration for the
sqs
queue connection:The generated queue URLs are as follows:
I'd be more than happy to contribute these for the modules that I've used.
Beta Was this translation helpful? Give feedback.
All reactions