eladkal commented on code in PR #50464: URL: https://github.com/apache/airflow/pull/50464#discussion_r2084937356
########## dev/README_RELEASE_PROVIDERS.md: ########## @@ -486,137 +485,6 @@ If you want to disable this behaviour, set the env **CLEAN_LOCAL_TAGS** to false breeze release-management tag-providers ``` -## Prepare 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 distributions 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 -P)" -``` - -Note if this is not the first time you clone the repo make sure main branch is rebased: - -```shell script -cd "${AIRFLOW_SITE_DIRECTORY}" -git checkout main -git pull --rebase -``` - -- Then you can go to the directory and build the necessary documentation packages - -```shell script -cd "${AIRFLOW_REPO_ROOT}" -breeze build-docs --clean-build apache-airflow-providers all-providers --include-removed-providers --include-commits -``` - -Usually when we release packages we also build documentation for the "documentation-only" packages. This -means that unless we release just few selected packages or if we need to deliberately skip some packages -we should release documentation for all Provider distributions and the above command is the one to use. - -If we want to just release some providers you can release them using package names: - -```shell script -cd "${AIRFLOW_REPO_ROOT}" -breeze build-docs apache-airflow-providers cncf.kubernetes sftp --clean-build --include-commits -``` - -Alternatively, if you have set the environment variable: `DISTRIBUTIONS_LIST` above, just run the command: - -```shell script -cd "${AIRFLOW_REPO_ROOT}" -breeze build-docs --clean-build --include-commits -``` - -Or using `--distributions-list` argument: - -```shell script -breeze build-docs --distributions-list PACKAGE1,PACKAGE2 --include-commits -``` - -- Now you can preview the documentation. - -```shell script -./docs/start_doc_server.sh -``` - -If you encounter error like: - -```shell script -airflow git:(main) ./docs/start_doc_server.sh -./docs/start_doc_server.sh: line 22: cd: /Users/eladkal/PycharmProjects/airflow/docs/_build: No such file or directory -``` - -That probably means that the doc folder is empty thus it can not build the doc server. -This indicates that previous step of building the docs did not work. - -- Copy the documentation to the ``airflow-site`` repository - -All providers (including overriding documentation for doc-only changes) - note that publishing is -way faster on multi-cpu machines when you are publishing multiple providers: - - -```shell script -cd "${AIRFLOW_REPO_ROOT}" - -breeze release-management publish-docs apache-airflow-providers all-providers --include-removed-providers \ - --override-versioned --run-in-parallel - -breeze release-management add-back-references all-providers -``` - -If you have providers as list of provider ids because you just released them you can build them with - -```shell script -cd "${AIRFLOW_REPO_ROOT}" - -breeze release-management publish-docs amazon apache.beam google .... -breeze release-management add-back-references all-providers -``` - -Alternatively, if you have set the environment variable: `DISTRIBUTIONS_LIST` above, just run the command: - -```shell script -breeze release-management publish-docs -breeze release-management add-back-references all-providers -``` - -Or using `--distributions-list` argument: - -```shell script -breeze release-management publish-docs --distributions-list PACKAGE1,PACKAGE2 -breeze release-management add-back-references all-providers -``` - - -Review the state of removed, suspended, new packages in -[the docs index](https://github.com/apache/airflow-site/blob/master/landing-pages/site/content/en/docs/_index.md): - -- If you publish a new package, you must add it to the list of packages in the index. -- If there are changes to suspension or removal status of a package you must move it appropriate section. - -- Create the commit and push changes. - -```shell script -cd "${AIRFLOW_SITE_DIRECTORY}" -branch="add-documentation-$(date "+%Y-%m-%d%n")" -git checkout -b "${branch}" -git add . -git commit -m "Add documentation for packages - $(date "+%Y-%m-%d%n")" -git push --set-upstream origin "${branch}" -``` Review Comment: We still need to do this if we add new provider or change his index place -- 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: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
