apache/beam

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

Closed

#34,694 opened on Apr 21, 2025

View on GitHubContributor guide
 (17 comments) (0 reactions) (1 assignee)Java (4,097 forks)batch import
P2buggood first issue

Repository metrics

Stars
 (7,313 stars)
PR merge metrics
 (Avg merge 6d) (243 merged PRs in 30d)

Description

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 direction
Investigate the `generate yaml docs` script and the release process that publishes the YAML documentation to the website. Check if the script is being executed correctly during releases, and if the generated output is properly uploaded to the site. Also verify that the website configuration includes all generated sections.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65