kaxil commented on a change in pull request #12892: URL: https://github.com/apache/airflow/pull/12892#discussion_r538327995
########## File path: dev/README_RELEASE_PROVIDER_PACKAGES.md ########## @@ -884,6 +885,58 @@ twine upload -r pypi dist/* * Again, confirm that the packages are available under the links printed. +## Publish documentation + +Documentation is an essential part of the product and should be made available to users. +In our cases, documentation for the released versions is published in a separate repository - [`apache/airflow-site`](https://github.com/apache/airflow-site), but the documentation source code and build tools are available in the `apache/airflow` repository, so you have to coordinate between the two repositories to be able to build the documentation. + +Documentation for providers can be found in the `/docs/apache-airflow-providers` directory and the `/docs/apache-airflow-providers-*/` directory. The first directory contains the package contents lists and should be updated every time a new version of provider packages is released. + +- First, copy the airflow-site repository and set the environment variable ``AIRFLOW_SITE_DIRECTORY``. + + ```shell script + git clone https://github.com/apache/airflow-site.git airflow-site + cd airflow-site + export AIRFLOW_SITE_DIRECTORY="$(pwd)" + ``` + +- Then you can go to the directory and build the necessary documentation packages + + ```shell script + cd "${AIRFLOW_REPO_ROOT}" + ./breeze build-docs -- \ + --package apache-airflow-providers \ + --package apache-airflow-providers-apache-airflow \ + --package apache-airflow-providers-telegram \ + --for-production + ``` + +- Now you can preview the documentation. + + ```shell script + ./docs/start_doc_server.sh + `` Review comment: ```suggestion ``` ``` ########## File path: dev/README_RELEASE_PROVIDER_PACKAGES.md ########## @@ -884,6 +885,58 @@ twine upload -r pypi dist/* * Again, confirm that the packages are available under the links printed. +## Publish documentation + +Documentation is an essential part of the product and should be made available to users. +In our cases, documentation for the released versions is published in a separate repository - [`apache/airflow-site`](https://github.com/apache/airflow-site), but the documentation source code and build tools are available in the `apache/airflow` repository, so you have to coordinate between the two repositories to be able to build the documentation. + +Documentation for providers can be found in the `/docs/apache-airflow-providers` directory and the `/docs/apache-airflow-providers-*/` directory. The first directory contains the package contents lists and should be updated every time a new version of provider packages is released. + +- First, copy the airflow-site repository and set the environment variable ``AIRFLOW_SITE_DIRECTORY``. + + ```shell script + git clone https://github.com/apache/airflow-site.git airflow-site + cd airflow-site + export AIRFLOW_SITE_DIRECTORY="$(pwd)" + ``` + +- Then you can go to the directory and build the necessary documentation packages + + ```shell script + cd "${AIRFLOW_REPO_ROOT}" + ./breeze build-docs -- \ + --package apache-airflow-providers \ + --package apache-airflow-providers-apache-airflow \ + --package apache-airflow-providers-telegram \ + --for-production + ``` + +- Now you can preview the documentation. + + ```shell script + ./docs/start_doc_server.sh + `` + +- Copy the documentation to the ``airflow-site`` repository + + ```shell script + ./docs/publish_docs.py \ + --package apache-airflow-providers \ + --package apache-airflow-providers-apache-airflow \ + --package apache-airflow-providers-telegram \ + + cd "${AIRFLOW_SITE_DIRECTORY}" + ```` Review comment: ```suggestion ``` ``` ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
