potiuk commented on a change in pull request #8807:
URL: https://github.com/apache/airflow/pull/8807#discussion_r425705605



##########
File path: airflow/providers/apache/cassandra/README.md
##########
@@ -0,0 +1,105 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied.  See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ -->
+
+
+# Package apache-airflow-backport-providers-apache-cassandra
+
+Release: 2020.05.19
+
+**Table of contents**
+
+- [Backport package](#backport-package)
+- [Installation](#installation)
+- [Compatibility](#compatibility)
+- [PIP requirements](#pip-requirements)
+- [Provider class summary](#provider-class-summary)
+    - [Sensors](#sensors)
+        - [Moved sensors](#moved-sensors)
+    - [Hooks](#hooks)
+        - [Moved hooks](#moved-hooks)
+- [Releases](#releases)
+    - [Release 2020.05.19](#release-20200519)
+
+## Backport package
+
+This is a backport providers package for `apache.cassandra` provider. All 
classes for this provider package
+are in `airflow.providers.apache.cassandra` python package.
+
+## Installation
+
+You can install this package on top of an existing airflow 1.10.* installation 
via
+`pip install apache-airflow-backport-providers-apache-cassandra`
+
+## Compatibility
+
+For full compatibility and test status of the backport packages check
+[Airflow Backport Package 
Compatibility](https://cwiki.apache.org/confluence/display/AIRFLOW/Backported+providers+packages+for+Airflow+1.10.*+series)
+
+## PIP requirements
+
+| PIP package      | Version required   |
+|:-----------------|:-------------------|
+| cassandra-driver | &gt;=3.13.0,&lt;3.21.0   |
+
+# Provider class summary
+
+All classes in Airflow 2.0 are in `airflow.providers.apache.cassandra` package.
+
+
+
+
+## Sensors
+
+
+
+### Moved sensors
+
+| Airflow 2.0 sensors: `airflow.providers.apache.cassandra` package            
                                                              | Airflow 1.10.* 
previous location (usually `airflow.contrib`)                                   
                                                                 |
+|:-------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 
[sensors.record.CassandraRecordSensor](https://github.com/apache/airflow/blob/master/airflow/providers/apache/cassandra/sensors/record.py)
 | 
[sensors.cassandra_record_sensor.CassandraRecordSensor](https://github.com/apache/airflow/blob/v1-10-stable/airflow/contrib/sensors/cassandra_record_sensor.py)
 |
+| 
[sensors.table.CassandraTableSensor](https://github.com/apache/airflow/blob/master/airflow/providers/apache/cassandra/sensors/table.py)
    | 
[sensors.cassandra_table_sensor.CassandraTableSensor](https://github.com/apache/airflow/blob/v1-10-stable/airflow/contrib/sensors/cassandra_table_sensor.py)
    |
+
+
+
+## Hooks
+
+
+
+### Moved hooks
+
+| Airflow 2.0 hooks: `airflow.providers.apache.cassandra` package              
                                                        | Airflow 1.10.* 
previous location (usually `airflow.contrib`)                                   
                                   |
+|:-------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|
+| 
[hooks.cassandra.CassandraHook](https://github.com/apache/airflow/blob/master/airflow/providers/apache/cassandra/hooks/cassandra.py)
 | 
[hooks.cassandra_hook.CassandraHook](https://github.com/apache/airflow/blob/v1-10-stable/airflow/contrib/hooks/cassandra_hook.py)
 |

Review comment:
       I wanted to make the tables "smaller" so I am removing the most common 
prefixes (table header is (mostly in "airflow.contrib" package) + we have link 
to the classes themselves. I think - especially in Github which has limited 
width this makes it much better (otherwise the tables will be very wide and you 
need to scroll them.
   
   Do you thin @ashb it's too confusing?




----------------------------------------------------------------
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


Reply via email to