kaxil opened a new pull request #7015: [AIRFLOW-6436] Create & Automate docs on 
Airflow Configs
URL: https://github.com/apache/airflow/pull/7015
 
 
   This PR aims to automate the creation of Config docs and add pre-commit 
hooks that would also serve as tests.
   
   **Preview**:
   - **Layout 1**: https://near-cherry.surge.sh/configurations-ref.html
   - **Layout 2**: https://flowery-ray.surge.sh/configurations-ref.html 
(Similar to our CLI doc)
   
   Also, add a structure to the documentation by adding the following sections:
   
   - Description
   - Example
   - Type
   - Default
   - for each config
   
   ---
   Link to JIRA issue: https://issues.apache.org/jira/browse/AIRFLOW-6436
   
   - [x] Description above provides context of the change
   - [x] Commit message starts with `[AIRFLOW-NNNN]`, where AIRFLOW-NNNN = JIRA 
ID*
   - [x] Unit tests coverage for changes (not needed for documentation changes)
   - [x] Commits follow "[How to write a good git commit 
message](http://chris.beams.io/posts/git-commit/)"
   - [x] Relevant documentation is updated including usage instructions.
   - [x] I will engage committers as explained in [Contribution Workflow 
Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
   
   (*) For document-only changes, no JIRA issue is needed. Commit message 
starts `[AIRFLOW-XXXX]`.
   
   ---
   In case of fundamental code change, Airflow Improvement Proposal 
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals))
 is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party 
License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in 
[UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
   Read the [Pull Request 
Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)
 for more information.
   

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


With regards,
Apache Git Services

Reply via email to