aws-replicator: add meaningful documentation / schema for config yaml
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- aws, python
- Domain
- cloud, documentation
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.
Description
Currently, there are only a few very small examples of how to configure the 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.
- Dominant language
- Python
- Stars
- 47
- Forks
- 19
- Avg merge
- 2h 2m
- Merged PRs (30d)
- 1
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.
More from localstack/localstack-extensions
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
localstack/localstack-extensions#10 · 2 comments · 1 assignee ·
All issues in localstack/localstack-extensions
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·