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

Add documentation create/update community providers #15061

Merged
merged 9 commits into from
Apr 3, 2021
Merged

Add documentation create/update community providers #15061

merged 9 commits into from
Apr 3, 2021

Conversation

marcosmarxm
Copy link
Contributor

@marcosmarxm marcosmarxm commented Mar 28, 2021

Add documentation to help contributors to add and update community providers.
I'm pulling the first version to check if the sections are okay and get some feedback.
I'm not a native english speaker so throughout the week I'll dedicate myself to writing more clearly, corrections are welcome.

Resolves issue #10386 and extends closed PR #13193.

I added the following sections so far:

  • How-to creating a new community provider
    • Initial Code and Unit Tests
    • Update Airflow validation tests (core/providers_manager.py and CI count providers)
    • Integration tests
    • Documentation
  • How-to Update a community provider

I'll focus to add the following items:

  • directory structure (possibly automated templates or script to create them)
  • usage scenarios for connections in hooks (see discussion in Standardising hooks / connections and adding TTLs #12128)
  • Information about what is required:
    • hooks
    • operators/sensors/transfers
    • unit tests with mocks
    • integration tests if applicable
    • example dags for examples and their use (examples, howtos, system tests)
    • howto guides
  • relation with backport providers.

@marcosmarxm marcosmarxm changed the title add initial create update provider doc Add documentation create/update communit providers Mar 28, 2021
@marcosmarxm marcosmarxm changed the title Add documentation create/update communit providers Add documentation create/update community providers Mar 28, 2021
Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

Nice! cool stuff. I've added few comments and clarifications! looking forward for fixes and happy to merge it!

docs/apache-airflow-providers/index.rst Outdated Show resolved Hide resolved
@marcosmarxm
Copy link
Contributor Author

@potiuk #14176 create a CONTRIBUTE-PROVIDER.rst which could be a good place to add the information of this PR, WDYT? My concern is that it is a big change and it may take time to be merged.

@potiuk
Copy link
Member

potiuk commented Mar 29, 2021

I think yours will be faster, so we might ask @paolaperaza to incorporate that one after she rebases ? WDYT @paolaperaza ?

@paolaperaza
Copy link

@marcosmarxm Excited to see this! I just commented in #14176, but I agree with @potiuk - let's get this merged first and I'll incorporate changes into my PR from there.

@github-actions
Copy link

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.

@potiuk potiuk merged commit 932f8c2 into apache:master Apr 3, 2021
@potiuk
Copy link
Member

potiuk commented Apr 3, 2021

@marcosmarxm Excited to see this! I just commented in #14176, but I agree with @potiuk - let's get this merged first and I'll incorporate changes into my PR from there.

Merged!

@kaxil
Copy link
Member

kaxil commented Apr 4, 2021

Thanks @marcosmarxm this looks really good 👏

@potiuk
Copy link
Member

potiuk commented Apr 4, 2021

It does indeed :)!

@potiuk
Copy link
Member

potiuk commented Apr 4, 2021

I will cherry-pick those to 2.0.2 as well so that it gets into 'stable' docs

@potiuk potiuk added this to the Airflow 2.0.2 milestone Apr 4, 2021
ashb pushed a commit that referenced this pull request Apr 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants