airflow-declarative icon indicating copy to clipboard operation
airflow-declarative copied to clipboard

Published 20 hours ago • verified publisher icon rambler-digital-solutions

Documentation

Open kxepal opened this issue 7 years ago • 4 comments

We need document what we have here. Currently all we have is reference to source code. That's geeky, but not user friendly. Documentation should cover at least the following topics:

  • [ ] Quick start
  • [ ] Contribution guide
  • [ ] YAML schema definition
  • [ ] Public API reference
  • [ ] Troubleshooting

kxepal avatar Jul 30 '17 11:07 kxepal

Fixed via #23

kxepal avatar Jul 08 '19 19:07 kxepal

Some topics are still not covered though. Quick start/Installation is definitely an important piece which is still missing.

KostyaEsmukov avatar Jul 08 '19 19:07 KostyaEsmukov

Ok, reopening to tracking missing bits. However, quick start / installation is in README and +/- actual.

kxepal avatar Jul 08 '19 19:07 kxepal

Quick start

Not sure what should we put there. I tend to think that the "Installation" page from #28 would cover this.

Contribution guide

Still missing. There's a convention at GitHub to put such a guide in a CONTRIBUTING.md file (instead of RTD), so I suggest to follow it.

YAML schema definition

Done.

Public API reference

Done (sort of).

Troubleshooting

Still missing. Any idea what should be covered here?

KostyaEsmukov avatar Jul 19 '19 06:07 KostyaEsmukov