kaxil opened a new pull request, #73556: URL: https://github.com/apache/airflow/pull/73556
The `common.ai` landing page opened like a package reference: package name, the provider-selection table, an explanation, a code excerpt, links, then the generated dependency tables. The excerpt asked a model to summarize a quarterly report the snippet never supplied, so the first code a reader saw was not a credible task. The quick start ended at "run it like any other Dag" without saying where the answer lands or what a successful run looks like. This PR makes the first-use path deliver a result. The landing page now opens with what the provider does in Airflow terms, three starting links (quick start, use cases, model providers), and the same two-task Dag the quick start runs, with the "when to use this provider" table moved below it. The quick start gains the missing steps: where to save the file, how to trigger the Dag, and what to look for afterwards, naming the `LLM run complete` post-run log line, the downstream task's log line, and the `return_value` XCom entries in the UI. The example Dag supplies its input in the file and adds a `publish` task that receives the model's answer as an ordinary upstream result, so the Airflow integration is visible in the first example a reader runs. **Why extend the quick start example rather than the basic `LLMOperator` one.** Five pages embed markers from `example_llm.py`, including the batch, branch and use-case pages, so changing its shape would ripple. `example_quickstart.py` had two embedders (the quick start and the self-hosted models page), and both wanted the same thing. The self-hosted page still refers to the `summarize` task by name, which is unchanged. The acceptance test for this change is that someone with a working Airflow installation can follow the quick start and verify a useful result without opening the example's source file or another page. The generated package metadata and the standard provider toctrees are untouched. --- * Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information. Note: commit author/co-author name and email in commits become permanently public when merged. * For fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed. * When adding dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). * For significant user-facing changes create newsfragment: `{pr_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments). You can add this file in a follow-up commit after the PR is created so you know the PR number. -- 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]
