[Feature] Please document the full structure of the config

[anentropic]

Description

AFAICT there is no comprehensive documentation of the YAML format

The docs site https://astronomer.github.io/dag-factory/latest/ or https://astronomer.github.io/dag-factory/latest/configuration/configuring_workflows/ details various features and shows some example configs

It's not clear - do the examples show the only possible keys? Are some of the keys shown optional?

What do all the keys mean? (I realise e.g. at task level they can probably be derived by cross-referencing for similar names in the Airflow docs)

Use case/motivation

No response

Related issues

No response

Are you willing to submit a PR?

• Yes, I am willing to submit a PR!

[ddeath]

Also currently link (in README.md) to the examples points to empty folder?

[pankajastro]

Also currently link (in README.md) to the examples points to empty folder?

Hi @ddeath, It points to a symbolic link ../dev/dags, but feel free to submit a PR.

[pankajastro]

Hi @anentropic, I believe that most, if not all, of the key names are the same as in Airflow. We’ve tried to document how you can translate Airflow features into dag-factory, but please let me know if you have any specific questions. You’re also welcome to submit a PR if you have suggestions to improve the documentation.

[gyli]

I agree that dag-factory should mention the gap of supported DAG parameters between dag-factory and Airflow. I am working on a review of such gap, and see if they can be all supported. If not, they should be documented.