apache/beam

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

Chiusa

#34.694 aperta il 21 apr 2025

Vedi su GitHubGuida contributor
 (17 commenti) (0 reazioni) (1 assegnatario)Java (4097 fork)batch import
P2buggood first issue

Metriche repository

Star
 (7313 stelle)
Metriche merge PR
 (Merge medio 6g) (243 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Indaga lo script `generate yaml docs` e il processo di rilascio che pubblica la documentazione YAML sul sito web. Controlla se lo script viene eseguito correttamente durante i rilasci e se l'output generato viene caricato correttamente sul sito. Verifica inoltre che la configurazione del sito includa tutte le sezioni generate.
Tech stack
python
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65