Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Documentation improvements

Aperta
#662 4 commenti 1 reazione 1 assegnatario Vedi su GitHub

@fmachado ci sta già lavorando.

Dal 14/3/2020.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

question

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:

  1. 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
  1. 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).
  1. 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?

Lingua principale
Java
Stelle
1.2k
Fork
469
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di influxdata/influxdb-java

Tutte le issue di influxdata/influxdb-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.