Skip to content

Conversation

@kacpermuda
Copy link
Contributor

@kacpermuda kacpermuda commented Feb 22, 2024

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:

breeze build-docs --package-filter apache-airflow-providers-openlineage --clean-build

then You can run the server with:

 sh docs/start_doc_server.sh

and view the docs at localhost

Next steps

I think we need a new version of this image, with provider instead of openlineage-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.

@mobuchowski mobuchowski self-requested a review February 22, 2024 13:53
@kacpermuda kacpermuda force-pushed the docs/update-ol-provider branch 3 times, most recently from 56ad9d3 to 8bc3619 Compare February 22, 2024 15:38
@dirrao dirrao added the type:doc-only Changelog: Doc Only label Feb 23, 2024
Copy link
Contributor

@dirrao dirrao left a 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.

@kacpermuda kacpermuda force-pushed the docs/update-ol-provider branch 2 times, most recently from 910898c to 5264af8 Compare February 23, 2024 08:16
Copy link
Contributor

@JDarDagran JDarDagran left a 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.

@kacpermuda kacpermuda force-pushed the docs/update-ol-provider branch 2 times, most recently from 8ed8e8b to e94ee6e Compare February 26, 2024 09:07
@kacpermuda kacpermuda force-pushed the docs/update-ol-provider branch from 9f27288 to 8089eb8 Compare February 28, 2024 13:30
@mobuchowski mobuchowski merged commit fb65112 into apache:main Feb 28, 2024
@kacpermuda kacpermuda deleted the docs/update-ol-provider branch February 28, 2024 14:13
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