Skip to content

update YAML instructions to be 1,2,3,4,5 rendered and update links #3058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chamikaramj merged 2 commits into from
Dec 17, 2025
Merged

update YAML instructions to be 1,2,3,4,5 rendered and update links #3058

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad5f40e
update instructions to be 1,2,3,4,5 rendered
derrickaw Dec 5, 2025
ecd0f47
update broken links
derrickaw Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions yaml/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ More detailed instructions on how to run the template can be found in the associ
1. **Contribution Instructions:** Read the code contributions located [here](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/contributor-docs/code-contributions.md).

1. **Add YAML Blueprint:** Create the YAML blueprint file that defines the template's structure and parameters.
Place this file in [here](https://github.com/GoogleCloudPlatform/DataflowTemplates/yaml/src/main/yaml).
Place this file in [here](https://github.com/GoogleCloudPlatform/DataflowTemplates/tree/main/yaml/src/main/yaml).

1. **Generate YAML Template (Optional):** If desired, create the YAML template using the generation script.

```shell
python yaml/src/main/python/generate_yaml_java_templates.py yaml/src/main/yaml
```
```shell
python yaml/src/main/python/generate_yaml_java_templates.py yaml/src/main/yaml
```

1. **Create Integration Test:** Develop an integration test to validate the functionality of the new template.
Place this file in [here](https://github.com/GoogleCloudPlatform/DataflowTemplates/yaml/src/test/java).
Place this file in [here](https://github.com/GoogleCloudPlatform/DataflowTemplates/tree/main/yaml/src/test/java/com/google/cloud/teleport/templates/yaml).
Additional instructions can be located [here](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/contributor-docs/add-integration-or-load-test.md).

1. **Generate Documentation:** Run the documentation generation script to create the official documentation for the template. You can find instructions on how to do this in the [contributor documentation](https://github.com/GoogleCloudPlatform/DataflowTemplates/blob/main/contributor-docs/code-contributions.md#generated-documentation).