Skip to content

Commit

Permalink
NG: Refactor maintenance-related content from README to MAINTAINERS
Browse files Browse the repository at this point in the history
  • Loading branch information
@amotl
amotl committed Aug 1, 2023
1 parent f756c28 commit a4e4099
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 69 deletions.
67 changes: 67 additions & 0 deletions MAINTAINERS.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
###########
Maintainers
###########


About
=====

At Crate.io we are defining so called Power Users to ensure the integrations
keep working.

Responsibilities of Power Users:

* Keep track of releases, updates and developments of the tools.
* Test integration after minor and mayor CrateDB releases.
* Test integration after tool releases.
* Have a working setup available including a quick demo.
* Being able to answer questions for the specific tool.
* Ensuring guides are up to date.


Power Users
===========

+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Tool | User | Version | CrateDB Version | |
+=================+===================+=========+=================+======================================================+
| Grafana | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues Grafana`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| PowerBI | `WolfgangHerbst`_ | *X.Y* | *X.Y.Z* | `Known Issues PowerBI`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Tableau | `marregui`_ | *X.Y* | *X.Y.Z* | `Known Issues Tableau`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Zeppelin | | | | |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Looker | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues Looker`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Node-Red | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues Node Red`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| NiFi | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues NiFi`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Telegraf | | | | |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Prometheus | `infoverload`_ | *X.Y* | *X.Y.Z* | `Known Issues Prometheus`_, `Known Issues Adapter`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| R | `autophagy`_ | *X.Y* | *X.Y.Z* | `Known Issues R`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Azure Functions | `autophagy`_ | *X.Y* | *X.Y.Z* | `Known Issues Azure Functions`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+


.. _autophagy: https://github.com/autophagy
.. _infoverload: https://github.com/infoverload
.. _marregui: https://github.com/marregui
.. _proddata: https://github.com/proddata
.. _WolfgangHerbst: https://github.com/WolfgangHerbst

.. _Known Issues Adapter: https://github.com/crate/crate_adapter/issues
.. _Known Issues Azure Functions: https://github.com/crate/crate/labels/tool%3A%20Azure%20Functions
.. _Known Issues Grafana: https://github.com/crate/crate/labels/tool%3A%20Grafana
.. _Known Issues Looker: https://github.com/crate/crate/labels/tool%3A%20Looker
.. _Known Issues NiFi: https://github.com/crate/crate/labels/tool%3A%20NiFi
.. _Known Issues Node Red: https://github.com/crate/crate/labels/tool%3A%20Node-Red
.. _Known Issues PowerBI: https://github.com/crate/crate/labels/tool%3A%20PowerBI
.. _Known Issues Prometheus: https://github.com/crate/crate/labels/tool%3A%20Prometheus
.. _Known Issues R: https://github.com/crate/crate/labels/tool%3A%20R
.. _Known Issues Tableau: https://github.com/crate/crate/labels/tool%3A%20Tableau
77 changes: 8 additions & 69 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,92 +2,31 @@
CrateDB Clients and Tools
=========================

Clients and tools for working with `CrateDB`_.
We are also maintaining a more up-to-date list of `CrateDB integration tutorials`_.
Client libraries, applications, tools, and integrations for `CrateDB`_.
We are also maintaining an up-to-date list of `CrateDB integration tutorials`_.

Contributing
============

This project is primarily maintained by `Crate.io`_, but we welcome community
contributions!

See the `developer docs`_ and the `contribution docs`_ for more information.


Tool Power User
===============

At Crate.io we are defining so called Power Users to ensure the integrations
keep working.

Responsiblities of Power Users:

* Keep track of releases, updates and developments of the tools.
* Test integration after minor and mayor CrateDB releases.
* Test integration after tool releases.
* Have a working setup available including a quick demo.
* Being able to answer questions for the specific tool.
* Ensuring guides are up to date.


Power Users
-----------

+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Tool | User | Version | CrateDB Version | |
+=================+===================+=========+=================+======================================================+
| Grafana | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues Grafana`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| PowerBI | `WolfgangHerbst`_ | *X.Y* | *X.Y.Z* | `Known Issues PowerBI`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Tableau | `marregui`_ | *X.Y* | *X.Y.Z* | `Known Issues Tableau`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Zeppelin | | | | |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Looker | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues Looker`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Node-Red | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues Node Red`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| NiFi | `proddata`_ | *X.Y* | *X.Y.Z* | `Known Issues NiFi`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Telegraf | | | | |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Prometheus | `infoverload`_ | *X.Y* | *X.Y.Z* | `Known Issues Prometheus`_, `Known Issues Adapter`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| R | `autophagy`_ | *X.Y* | *X.Y.Z* | `Known Issues R`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+
| Azure Functions | `autophagy`_ | *X.Y* | *X.Y.Z* | `Known Issues Azure Functions`_ |
+-----------------+-------------------+---------+-----------------+------------------------------------------------------+

This project is primarily maintained by `Crate.io`_, and community contributions
are welcome. See the `developer docs`_ and the `contribution docs`_ for more
information.

Help
====

Looking for more help?
Looking for help?

- Read the `live docs`_
- Check out our `support channels`_
- Visit the `community forum`_


.. _autophagy: https://github.com/autophagy
.. _contribution docs: CONTRIBUTING.rst
.. _community forum: https://community.crate.io/
.. _Crate.io: http://crate.io/
.. _CrateDB: https://crate.io/products/cratedb/
.. _CrateDB integration tutorials: https://community.crate.io/t/overview-of-cratedb-integration-tutorials/1015
.. _developer docs: DEVELOP.rst
.. _infoverload: https://github.com/infoverload
.. _Known Issues Adapter: https://github.com/crate/crate_adapter/issues
.. _Known Issues Azure Functions: https://github.com/crate/crate/labels/tool%3A%20Azure%20Functions
.. _Known Issues Grafana: https://github.com/crate/crate/labels/tool%3A%20Grafana
.. _Known Issues Looker: https://github.com/crate/crate/labels/tool%3A%20Looker
.. _Known Issues NiFi: https://github.com/crate/crate/labels/tool%3A%20NiFi
.. _Known Issues Node Red: https://github.com/crate/crate/labels/tool%3A%20Node-Red
.. _Known Issues PowerBI: https://github.com/crate/crate/labels/tool%3A%20PowerBI
.. _Known Issues Prometheus: https://github.com/crate/crate/labels/tool%3A%20Prometheus
.. _Known Issues R: https://github.com/crate/crate/labels/tool%3A%20R
.. _Known Issues Tableau: https://github.com/crate/crate/labels/tool%3A%20Tableau
.. _live docs: https://crate.io/docs/crate/clients-tools/en/latest/
.. _marregui: https://github.com/marregui
.. _proddata: https://github.com/proddata
.. _support channels: https://crate.io/support/
.. _WolfgangHerbst: https://github.com/WolfgangHerbst

0 comments on commit a4e4099

Please sign in to comment.