Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
#104 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

Search before asking
  • I searched in the 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?
  • I'm willing to submit a PR!
Dominant language
Java
Stars
33
Forks
30
Avg merge
6h 2m
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/iotdb-extras

All issues in apache/iotdb-extras

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.