apache/beam

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

Fermée

#34 694 ouverte le 21 avr. 2025

Voir sur GitHubGuide contributeur
 (17 commentaires) (0 réaction) (1 personne assignée)Java (4 097 forks)batch import
P2buggood first issue

Métriques du dépôt

Stars
 (7 313 étoiles)
Métriques de merge PR
 (Merge moyen 6j) (243 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez le script `generate yaml docs` et le processus de publication qui diffuse la documentation YAML sur le site Web. Vérifiez si le script est exécuté correctement lors des versions et si la sortie générée est correctement téléchargée sur le site. Assurez vous également que la configuration du site inclut toutes les sections générées.
Stack technique
python
Domaine
documentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65