Skip to content

Conversation

@joppevos
Copy link
Contributor

@joppevos joppevos commented May 27, 2020

A simple guide based on the example_dataproc file. Addressing this issue

notes/qs

  • @mik-laj All the examples we have of job configurations are added in the guide. Maybe it is too much, but I assumed people will probably just search through the page.
  • Is an explanation of the arguments needed? The operators themself are richly documented already so I kept it out for now.

Make sure to mark the boxes below before creating PR: [x]

  • Description above provides context of the change
  • Unit tests coverage for changes (not needed for documentation changes)
  • Target Github ISSUE in description if exists
  • Commits follow "How to write a good git commit message"
  • Relevant documentation is updated including usage instructions.
  • I will engage committers as explained in Contribution Workflow Example.

In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.
Read the Pull Request Guidelines for more information.

@boring-cyborg boring-cyborg bot added area:docs provider:google Google (including GCP) related issues labels May 27, 2020
@mik-laj mik-laj requested a review from turbaszek May 27, 2020 15:35
Copy link
Member

@turbaszek turbaszek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job! Only few suggestions

Copy link
Member

@turbaszek turbaszek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should fix the docs I think. The problem is that referenced code is not indented (those fragments are not definied inside DAG context manager).

@turbaszek
Copy link
Member

@joppevos can you adjust tests? We've got test that checks that guides are not missing...

tests/test_project_structure.py:218: AssertionError

@turbaszek turbaszek merged commit 29eb68b into apache:master May 31, 2020
@turbaszek
Copy link
Member

Thanks @joppevos !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

provider:google Google (including GCP) related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants