Documentation improvements
@fmachado がすでに取り組んでいます。
2020年3月14日 から。
評価
この issue はまだ評価されていません。
説明
Current problem
At some point after the release of version 2.3 of this library, changelog and description of new features were frequently added to the README.md file. With more and more features being added, this file went from quickly showing what this project can do to a full documentation with 22 topics and there is not even a "Table of Contents" to help with navigation.
Proposed solution
I would like to suggest we move everything to a new location except:
- Project description including version and build status;
- A quick "how to use this library" with a few lines of code (does not need to be production grade code);
- A link to the complete documentation;
- How to contribute.
If you liked this idea, please vote with a 👍 here!
Wiki vs. big .md file
IMHO the best place for a more detailed documentation would be the "Wiki", currently enabled for this project. Unfortunately this Wiki does not allow edits from non-developers and would require InfluxData to change this configuration.
Here are the options I can identify:
- Use a big .md file
- Pros: anyone can contribute; single place with all documentation; easy to search for keywords (CTRL+F is enough).
- Cons: Painful to navigate
- Use multiple .md files
- Pros: anyone can contribute; smaller files with specific content.
- Cons: Difficult (if not impossible) to link one file to another; difficult to search for keywords (GitHub search bar is the only option).
- Use Wiki
- Pros: smaller pages with specific content; easy to navigate;
- Cons: difficult to search for keywords (GitHub search bar is the only option); can only be edited by InfluxData developers (i.e. part of the GitHub InfluxData team).
So, what do you think?
- 主要言語
- Java
- スター
- 1.2k
- フォーク
- 468
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
influxdata/influxdb-java のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
influxdata/influxdb-java#1012 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
influxdata/influxdb-java#1006 · コメント 1 件 · リアクション 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
influxdata/influxdb-java#1005 · コメント 3 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
influxdata/influxdb-java#999 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
influxdata/influxdb-java#970 ·
influxdata/influxdb-java の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
floci-io/floci#5425 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
objectionary/eo-graphs#80 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
objectionary/jucs#141 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
-
bug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
repowise-dev/repowise#3335 ·
メンテナーはふだん 1 日以内に返信