[Feature request] Adding README.md for all connectors like Grafana-connector
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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/iotdb-extras
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
apache/iotdb-extras#97 · 1 comment ·
All issues in apache/iotdb-extras
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/gradle-plugins#157 ·
-
enhancement Tools
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
apache/rocketmq-dashboard#5008 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
DETECT_PARAMETER_NAMES=false silently disables @ConstructorProperties-based Creator detection too Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
FasterXML/jackson-databind#6229 ·