Add documentation for dataframe operator

[sunank200]

trafficstars

Description

What is the current behavior?

In the past, we had a tutorial which illustrated how to use each of our operators/decorators: https://github.com/astronomer/astro-sdk/blob/be6280df00ccff0d7a1c0dfb099b2065303dbe88/REFERENCE.md

closes: #593

What is the new behavior?

Have a reference page per operator/decorator similar to https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/operators/ecs.html#howto-operator-ecsoperator

In which we reference parts of an (automated tested) example DAG which illustrates the usage of that operator/decorator.

Many of these use cases already exist in our example DAGs - we should reference them.

Does this introduce a breaking change?

No

Checklist

• [x] Created tests which fail without the change (if possible)
• [x] Extended the README / documentation, if necessary

[codecov[bot]]

Codecov Report

Merging #631 (7290358) into main (27d88ea) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #631   +/-   ##
=======================================
  Coverage   92.76%   92.76%           
=======================================
  Files          42       42           
  Lines        1701     1701           
  Branches      216      216           
=======================================
  Hits         1578     1578           
  Misses         97       97           
  Partials       26       26           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.