Skip to content
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.

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

Fix typos, older versions, and deprecated operators with AI platform example DAG #9618

Closed
wants to merge 9 commits into from

Conversation

vuppalli
Copy link
Contributor

@vuppalli vuppalli commented Jul 1, 2020

The AI platform example DAG had typos, was using older versions, and had deprecated operators. This PR is an attempt to fix these problems and corresponds to this Github issue. The relevant documentation will be updated soon (most likely next week), which corresponds to this Github issue. I will address any comments next Monday (07/06) since we have US holidays for the rest of the week. I look forward to getting feedback!


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.

vuppalli and others added 2 commits July 1, 2020 16:37
Fix typos, older versions, and deprecated operators with AI platform example DAG
@boring-cyborg boring-cyborg bot added the provider:google Google (including GCP) related issues label Jul 1, 2020
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 1, 2020

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, pylint and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://apache-airflow-slack.herokuapp.com/

@vuppalli
Copy link
Contributor Author

vuppalli commented Jul 1, 2020

@mik-laj You mentioned that this DAG does not have accompanying tests. How should I go about addressing the Unit tests coverage bullet above? Additionally, should I make this a draft PR while I work on the corresponding documentation?

@mik-laj
Copy link
Member

mik-laj commented Jul 2, 2020

@vuppalli We don't need unit tests for DAG. We use them in the documentation and in system tests. System tests are sufficient in this case. Have the files that are needed to run the tests changed?

It is better if the contribution is small because then it is much easier to review and merge in the project. In this case, I would prefer you to create a new PR that will only contain documentation. If you need any changes that are included in this PR then you can copy the changes from this PR and add annotations in the PR title [depends on XXXX]. Additionally, you can add a note in the description, but not everyone reads the description of the changes.
Example:

Add guide for MLEngine [depends on #9618]

In order for this change to be merged, you must fix static check errors.

airflow/providers/google/cloud/example_dags/example_mlengine.py:29:89: W291 trailing whitespace
airflow/providers/google/cloud/example_dags/example_mlengine.py:30:80: W291 trailing whitespace

+ isort

For more information:
https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst#id1

How do you like an internship at Google? Do you have any concerns about contributing to Open Source? The community of this project is very open to new contributors and interns. We currently have two active interns who contribute to the project. If you would like to get more involved in this project, we'll be happy to help. Apache Airflow is the core of the Cloud Composer service, so contributions to this project will be appreciated by your company.

@vuppalli
Copy link
Contributor Author

vuppalli commented Jul 6, 2020

@mik-laj Thanks so much for your response. I am not sure which files are needed to run the tests so I do not know if they have changed. The only file I have contributed to is the example DAG. Also, I have fixed the trailing whitespace issues and will create a new PR for the guide sometime this week.

I am really enjoying my internship at Google and this contribution is quite relevant the work I am doing! Since I am working with Cloud Composer and AI Platform, I am grateful to have helped with this contribution as I learned a lot about both products. I would love to get more involved with Open Source and appreciate the help!

@mik-laj
Copy link
Member

mik-laj commented Jul 6, 2020

@vuppalli Are you available on our official Airflow Slack channel? https://apache-airflow-slack.herokuapp.com/ If you plan to contribute more to Airflow, we can coordinate my team and your work. My team looks after all Google integrations, so we'll have a lot of contacts.

@vuppalli
Copy link
Contributor Author

vuppalli commented Jul 6, 2020

@mik-laj Yes, thank you!

@mik-laj
Copy link
Member

mik-laj commented Jul 6, 2020

I sent DM to you. ;-)

@vuppalli vuppalli closed this Jul 8, 2020
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