fluent / fluent/fluentd-docs-gitbook

Suggestion: Markdown Linting with Spelling and Grammar Reporting (Possible automated CI pipeline)

Abierto
#232 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
CSS
Estrellas
46
Forks
136
Merge medio
4 h 47 min
PR fusionados (30 d)
16

Descripción

It is suggested to use [markdown-lint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) extension of VSCode or some other tool(s) to automate the linting of the markdown files. The linting rules may also be configured for the exceptions in `.markdownlint.json` file and this may be added to this project to enforce the recommended Markdown format setting.

This integration may somehow be automated to create a CI pipeline for the submitted PRs.

The [redis-doc](https://github.com/redis/redis-doc) is worth to look at. It uses [Aspell](http://aspell.net/) for spelling mistakes.

Other relevant tools and/or solutions may also be suggested to automate the CI which would definitely help all the future work adhere to the recommended practices resulting in to-the-point reviews i.e. **documentation** and not the style, spelling, and grammar issues.

Regards!

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza revisando la configuración propuesta de .markdownlint.json y las referencias a markdown-lint y Aspell en el issue. Compara el enfoque de redis-doc y, después, inspecciona los puntos de entrada de CI disponibles en el repositorio. La tarea estará terminada cuando el proyecto tenga un enfoque acordado para el linting y la comprobación ortográfica, con comprobaciones automatizadas para los PRs enviados.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
markdown
Área
ci-cd, documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.