localstack / localstack/localstack-extensions

aws-replicator: add meaningful documentation / schema for config yaml

Ouverte
#95 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
47
Forks
19
Merge moyen
2 h 2 min
PR mergées (30 j)
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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les petits exemples YAML existants dans l’extension aws-replicator et examinez la manière dont sa configuration est actuellement représentée. Documentez clairement la configuration disponible ou fournissez un schéma, y compris l’exemple de transfert SQS de l’issue ; le travail est terminé lorsque les utilisateurs disposent d’une référence complète pour personnaliser l’extension.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
aws, python
Domaine
cloud, documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.