kacpermuda opened a new pull request, #37620:
URL: https://github.com/apache/airflow/pull/37620
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
## 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](https://openlineage.io/docs/integrations/airflow/), 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.
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](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst)
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](http://localhost:8000/docs/apache-airflow-providers-openlineage/stable/guides/structure.html)
## Next steps
I think we need a new version of
[this](https://openlineage.io/assets/images/af-schematic-ad8c295a182cb32b94ee27b96727fa98.svg)
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.
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
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](https://github.com/apache/airflow/tree/main/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
