apache / apache/iotdb-extras

[Feature request] Adding README.md for all connectors like Grafana-connector

Open
#104 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
33
Forks
29
Avg merge
1d 3h
Merged PRs (30d)
5

Description

### Search before asking

- [x] I searched in the [issues](https://github.com/apache/iotdb/issues) and found nothing similar.

### Motivation

While exploring the `iotdb-extras repository`, I noticed that the `grafana-connector` module has a `README.md` providing clear documentation on installation, usage, and configuration. However the other connector modules do not have equivalent module-level documentation. Developers and contributors landing on these modules have no quick reference for understanding their purpose, architecture, configuration, or usage without diving directly into the source code. Standardizing README documentation across all connector modules would improve contributor onboarding, reduce friction for new users, and bring consistency to the repository.

### Solution

Add a `README.md` to each of the connector modules, following the same structure and style as the existing `grafana-connector` README:
Each README will cover module overview, prerequisites, build and installation instructions, basic usage examples, and configuration parameters — consistent with the existing `grafana-connector` documentation style.

### Alternatives

_No response_

### Are you willing to submit a PR?

- [x] I'm willing to submit a PR!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the existing grafana-connector README.md and inspect the other connector modules in the iotdb-extras repository. Use the existing README as the documentation structure, covering each module's overview, prerequisites, build and installation instructions, usage examples, and configuration parameters. Done means every connector module has equivalent module-level documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
grafana, java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.