[GitHub] [airflow] mik-laj commented on issue #5459: [AIRFLOW-XXX] Rewrite the contributing guide

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

mik-laj commented on issue #5459: [AIRFLOW-XXX] Rewrite the contributing guide
URL: https://github.com/apache/airflow/pull/5459#issuecomment-504938657
 
 
   I think that it is worth moving the entire file to the docs directory and at the same time change its format to rst.
   This is important for several reasons.
   * creates space for another document that was discussed on the dev list
   https://lists.apache.org/thread.html/af7637c61acbb877dc68f337b633b2c34a43f91a2ebafc61208daf0c@%3Cdev.airflow.apache.org%3E
   * creates one source of knowledge. The user has all the materials available in one place.
   * historical versions of documents become available in the compiled version - https://readthedocs.org/projects/airflow/
   * unifies the documentation format in repo. 
   * easier editing of the file For example: you will be able to copy the fragment from one place to another.
   * linking between documents was difficult. It is now possible to refer to this document from the documentation. See: http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged This is more important when we also change the changelog file
   
   It is difficult for me to find serious disadvantages of this change. I see a lot of pluses.

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