-
Notifications
You must be signed in to change notification settings - Fork 13.8k
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
[OpenLineage] docs: Update whole OpenLineage Provider docs. #37620
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56ad9d3
to
8bc3619
Compare
dirrao
suggested changes
Feb 23, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I would request open lineage expert look into this.
910898c
to
5264af8
Compare
JDarDagran
reviewed
Feb 25, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, I love the changes. Very well done 🚀 Added some minor comments.
8ed8e8b
to
e94ee6e
Compare
mobuchowski
approved these changes
Feb 26, 2024
9f27288
to
8089eb8
Compare
mobuchowski
approved these changes
Feb 28, 2024
79 tasks
abhishekbhakat
pushed a commit
to abhishekbhakat/my_airflow
that referenced
this pull request
Mar 5, 2024
utkarsharma2
pushed a commit
to astronomer/airflow
that referenced
this pull request
Apr 22, 2024
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The OpenLineage Provider docs needed some refreshment.
I went through current docs and tried to find anything that is outdated, validated already provided information against the actual code and tried to add some new useful information. Some part added to the docs are sourced from current OL Airflow integration docs on OL website, but they have been updated to work for the provider package. I believe it's the right direction to keep everything here, as we may want to remove OL website docs on Airflow integration in the future, as it's mostly living in the provider package.
I also simplified the Menu structure, so it's easier to find everything and it's not as nested as before.
Let me know what You think, if there is something missing, misleading, not clear enough etc. Any feedback is highly appreciated.
How to view the new docs ?
The easiest way is to use BREEZE and run:
then You can run the server with:
and view the docs at localhost
Next steps
I think we need a new version of this image, with
provider
instead ofopenlineage-airflow
, included on the Intro page. I will try to update it, and as soon as we host it somewhere, we can do the switch.^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an 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 a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in newsfragments.