localstack / localstack/localstack-extensions

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

Offen
#95 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
47
Forks
19
Ø Merge
2 Std. 2 Min.
Gemergte PRs (30 T.)
1

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit den vorhandenen kleinen YAML-Beispielen in der Erweiterung aws-replicator und prüfe, wie ihre Konfiguration derzeit dargestellt wird. Dokumentiere die verfügbare Konfiguration klar oder stelle ein Schema bereit, einschließlich des SQS-Weiterleitungsbeispiels aus dem Issue; abgeschlossen ist die Aufgabe, wenn Benutzer eine umfassende Referenz zur Anpassung der Erweiterung haben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
aws, python
Bereich
cloud, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.