localstack / localstack/localstack-extensions
aws-replicator: add meaningful documentation / schema for config yaml
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 47
- Forks
- 19
- Avg merge
- 2h 2m
- Merged PRs (30d)
- 1
Description
Currently, there are only a few very small examples of how to configure the [aws-replicator](https://github.com/localstack/localstack-extensions/tree/main/aws-replicator) extension via YAML. This makes it very hard to grok how to properly customise the extension.
It would be incredibly helpful to have something more comprehensive available as a reference.
For instance: Say I have a local SQS queue of `dev-sqs-queue` and I want to forward all requests to a remote `staging-aws-queue` - there is no easily available reference for this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing small YAML examples in the aws-replicator extension and review how its configuration is currently represented. Document the available configuration clearly, or provide a schema, including the SQS forwarding example from the issue; done means users have a comprehensive reference for customising the extension.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, python
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100