apache/beam

[Bug]: Beam YAML documentation not reflecting full parameters.

Geschlossen

#34.694 geöffnet am 21.04.2025

Auf GitHub ansehenContributor Guide
 (17 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Java (4.097 Forks)batch import
P2buggood first issue

Repository-Metriken

Stars
 (7.313 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T) (243 gemergte PRs in 30 T)

Beschreibung

What happened?

The config sections at https://beam.apache.org/releases/yamldoc/current/#readfromkafka are nearly empty. This is despite the fact that, when I run

python -m apache_beam.yaml.generate_yaml_docs --include='.*Kafka' --markdown_file=out.md

manually a huge amount of documentation is correctly generated for these (and other) transforms.

It's unclear if this is a flaw in the release process or somewhere else, but at the very least we should try to update the website.

Issue Priority

Priority: 2 (default / most bugs should be filed as P2)

Issue Components

  • Component: Python SDK
  • Component: Java SDK
  • Component: Go SDK
  • Component: Typescript SDK
  • Component: IO connector
  • Component: Beam YAML
  • Component: Beam examples
  • Component: Beam playground
  • Component: Beam katas
  • Component: Website
  • Component: Infrastructure
  • Component: Spark Runner
  • Component: Flink Runner
  • Component: Samza Runner
  • Component: Twister2 Runner
  • Component: Hazelcast Jet Runner
  • Component: Google Cloud Dataflow Runner

Contributor Guide

Research-Richtung
Untersuchen Sie das Skript `generate yaml docs` und den Release Prozess, der die YAML Dokumentation auf der Website veröffentlicht. Prüfen Sie, ob das Skript während der Releases korrekt ausgeführt wird und die generierte Ausgabe ordnungsgemäß auf die Website hochgeladen wird. Überprüfen Sie auch, ob die Website Konfiguration alle generierten Abschnitte enthält.
Tech Stack
python
Domain
documentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65