programatically generate plugin-type asciidocs
Nadie ha tomado este issue todavía.
- #8 de @jsvd — cerrado sin fusionar
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation, tooling
Línea de trabajo
Comienza revisando el proceso de obtención/generación de asciidoc; después, lee el issue de dependencia 6086 y la discusión en logstash-docs PR 422. Se considera terminado cuando los documentos de índice para los tipos de plugin inputs, filters, codecs y outputs se generan automáticamente, incluyendo la adición de plugins y la eliminación de plugins borrados sin editar manualmente el índice.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The asciidoc index documents for inputs, filters, codecs and outputs are currently manually edited.
If a plugin is removed from the documentation, it's necessary to delete the references from the index. If a plugin is added, the include must be added as well.
This process should be automatic during the asciidoc fetch/generation.
depends on https://github.com/elastic/logstash/issues/6086
more information on https://github.com/elastic/logstash-docs/pull/422#issuecomment-339751316
- Lenguaje dominante
- Ruby
- Estrellas
- 4
- Forks
- 12
- 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 elastic/docs-tools
-
LSR
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
elastic/docs-tools#110 · 5 comentarios ·
-
VPR
Dificultad 4/5 3-5 días Aptitud para principiantes 42/100
elastic/docs-tools#109 · 1 comentario ·
-
Missing plugin VPR docs between placeholder generation and last commit date.Quizá libre de nuevo @mashhurs la tomó hace 1110 días y no hay ningún pull request abierto. Abierto
elastic/docs-tools#100 · 2 comentarios · 1 asignado ·
-
VPR: Revisit allowing a non-standard landing page (use case: new integrations)Quizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. AbiertoVPR
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
elastic/docs-tools#89 · 1 comentario ·
-
VPR
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
elastic/docs-tools#88 ·
Todos los issues de elastic/docs-tools
Issues similares
-
verified
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
Los mantenedores suelen responder en 5 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
zerocracy/judges-action#2984 ·
Los mantenedores suelen responder en 1 día