astro-sdk icon indicating copy to clipboard operation
astro-sdk copied to clipboard

Improve the documentation before 1.0.0 is released

Open tatiana opened this issue 3 years ago • 0 comments
trafficstars

Improve https://astro-sdk.readthedocs.io/en/1.0.0b1/

Goal Improve the content itself.

Acceptance criteria

  • [ ] Add section about supported technologies: https://github.com/astronomer/astro-sdk#supported-technologies
  • [ ] API Reference and Changelog should be after the Getting Started section on the left menu
  • [ ] Configuration section: a summary of all available parameters and configuration
  • [ ] Things to hide in the API Reference
    • databases
    • utils
  • [ ] Have a Concepts section where we explain:
    • File
    • Tables (temporary table)
    • Operators/Decorators & Task Flow API
    • Details about native aql.load_file
    • Append x merge
  • [ ] Create section "Examples" - include the explanation of the example of dynamic task mapping

tatiana avatar Jul 27 '22 11:07 tatiana