gopidesupavan commented on code in PR #47814: URL: https://github.com/apache/airflow/pull/47814#discussion_r2056788969
########## dev/breeze/doc/09_release_management_tasks.rst: ########## @@ -713,3 +713,57 @@ default is to build ``both`` type of distributions ``sdist`` and ``wheel``. :target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_release-management_prepare-airflow-ctl-distributions.svg :width: 100% :alt: Breeze release-management prepare-airflow-ctl-distributions + +Publishing the documentation to S3 +"""""""""""""""""""""""""""""""""" + +To publish the documentation generated by ``build-docs`` in Breeze to ``S3``, +use the ``release-management publish-docs-to-s3`` command: + +.. code-block:: bash + + breeze release-management publish-docs-to-s3 + +The documentation publish to S3 should be done after the ``breeze release-management publish-docs`` command. +Once documentation is available in ``docs-archive`` directory of airflow-site, it can be published to S3. + +The publishing documentation to S3 consists of the following steps: + +.. code-block:: bash + + breeze release-management publish-docs --source-dir-path <> --destination-location <> + +Where ``--source-dir-path`` is a doc-archive location path and ``--destination-location`` is the S3 bucket path. + +.. code-block:: bash + + breeze release-management publish-docs --source-dir-path /User/pavan/airflow-site/docs-archive + --destination-location s3://airflow-docs/docs + +To exclude any documentation from publishing to S3, you can use the ``--exclude`` flag. + +.. code-block:: bash Review Comment: >Or is this for the docs on main? This docs publishing for released artifacts. it requires input of tag or branch then it generates docs and publishes to s3. >or is this for archival of the old docs? Archival we can add separate process inside aws, once we start serving docs from s3 and we can archive. -- 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
