You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/12/08 12:45:32 UTC

[GitHub] [airflow] kaxil commented on a change in pull request #12892: Simplify publishing of documentation

kaxil commented on a change in pull request #12892:
URL: https://github.com/apache/airflow/pull/12892#discussion_r538325775



##########
File path: dev/README_RELEASE_AIRFLOW.md
##########
@@ -551,6 +552,43 @@ At this point we release an official package:
 
 - Update CHANGELOG.md with the details, and commit it.
 
+## 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.

Review comment:
       ```suggestion
   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.
   ```




----------------------------------------------------------------
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:
users@infra.apache.org