[Feature request] Adding README.md for all connectors like Grafana-connector
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- grafana, java
調査の方向性
既存の grafana-connector の README.md から始め、iotdb-extras リポジトリ内の他の connector モジュールを調査します。既存の README をドキュメント構成として使用し、各モジュールについて概要、前提条件、ビルドとインストールの手順、使用例、設定パラメーターを取り上げます。すべての connector モジュールに同等のモジュールレベルのドキュメントが用意されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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!
- 主要言語
- Java
- スター
- 33
- フォーク
- 30
- 平均マージ
- 6時間 2分
- マージ済み PR(30日)
- 3
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/iotdb-extras のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
apache/iotdb-extras#97 · コメント 1 件 ·
apache/iotdb-extras の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
infinispan/infinispan#18150 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
-
untriaged
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
opensearch-project/k-NN#3597 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100