[GitHub] [airflow] potiuk commented on a change in pull request #6947: [AIRFLOW-XXX] add note warning that bash>4.0 is required for docs build

[GitBox <gi...@apache.org>]

potiuk commented on a change in pull request #6947: [AIRFLOW-XXX] add note warning that bash>4.0 is required for docs build
URL: https://github.com/apache/airflow/pull/6947#discussion_r361845858
 
 

 ##########
 File path: CONTRIBUTING.rst
 ##########
 @@ -95,6 +95,10 @@ To generate a local version:
     ./build.sh
     ./start_doc_server.sh
 
+.. note::
+    The docs build script ``build.sh`` requires bash 4.0 or greater.
 
 Review comment:
   @dstandish: Or maybe we should tell people to use `breeze` instead? (we can wait with that until I merge some simplifications and optimisations to make it quite a bit lighter). 
   
   Breeze has stabilised a lot and it is being used by more people now so I think that might be good time to make it the "default" dev environment.
   
   We have `./breeze --build-docs` command that runs the build in automatically downloaded/updated docker container so no matter what  OS you run it all it will yield the same results (note that it is written in the way that it will generate the output files in host (the volumes are mounted from host during build). And you do not need the doc server in fact as you can simply open the index.html locally and it will work the same (except search maybe).
   
   Some more context: I have plans to remove all the locally run scripts from the documentation and leave breeze as the default way of doing most development tasks. I am going to remove most of the docs referring to the scripts and leave breeze docs only.
   
   WDYT @dstandish ? We can add this comment now, but maybe going 'breeze-first' should be the next step ?

----------------------------------------------------------------
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


With regards,
Apache Git Services