[Bug]: Documentation update: Correct parameter name for running YAML pipeline

andreydevyatkin commented 7 months ago

What happened?

The documentation for running a pipeline using a YAML file on the Apache Beam website (https://beam.apache.org/documentation/sdks/yaml/) contains an outdated parameter name. The documentation currently mentions the parameter --yaml_pipeline_file=, but the correct and up-to-date name for this parameter is --pipeline_spec_file=

Issue Priority

Priority: 3 (minor)

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: Spark Runner
[ ] Component: Flink Runner
[ ] Component: Samza Runner
[ ] Component: Twister2 Runner
[ ] Component: Hazelcast Jet Runner
[ ] Component: Google Cloud Dataflow Runner

damccorm commented 7 months ago

The documented yaml_pipeline_file is preferred, but pipeline_spec_file is also fine (these options alias to each other).

@robertwb I don't think I can update your gists or propose a PR, so would you mind updating them to use yaml_pipeline_file? Should be clearer

Amar3tto commented 7 months ago

@damccorm Could you please take a look at this line. I think this error message is confusing, because it refers to 'pipeline_spec_file' parameter naming, and in the documentation we have 'yaml_pipeline_file' naming.

damccorm commented 7 months ago

Addressing this in #30544 - thanks

apache / beam