Documentation improvements
@fmachado ya está trabajando en esto.
Desde el 14/3/2020.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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?
- Lenguaje dominante
- Java
- Estrellas
- 1.2k
- Forks
- 468
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de influxdata/influxdb-java
-
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
influxdata/influxdb-java#1012 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
influxdata/influxdb-java#1006 · 1 comentario · 1 reacción ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
influxdata/influxdb-java#1005 · 3 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
influxdata/influxdb-java#999 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
influxdata/influxdb-java#970 ·
Todos los issues de influxdata/influxdb-java
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
objectionary/eo-graphs#80 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
-
enhancement good first issue
Dificultad 2/5 Medio día Aptitud para principiantes 66/100
apache/fineract-consumer-facing#175 ·
Los mantenedores suelen responder en 1 día
-
[BUG] 订单：会员凭订单号即可取消其他会员的待付款订单（取消接口不校验订单归属）Posiblemente ocupada @dadiyang la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
macrozheng/mall#1016 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100