Skip to content

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

@robertwb

Description

@robertwb

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

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions