fluent / fluent/fluentd-docs-gitbook

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

Open
#232 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
CSS
Stars
46
Forks
136
Avg merge
4h 47m
Merged PRs (30d)
16

Description

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!

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.