fluent / fluent/fluentd-docs-gitbook

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

Offen
#232 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
CSS
Sterne
46
Forks
136
Ø Merge
4 Std. 47 Min.
Gemergte PRs (30 T.)
16

Beschreibung

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!

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginnen Sie mit der Prüfung der vorgeschlagenen .markdownlint.json-Konfiguration sowie der Verweise auf markdown-lint und Aspell im Issue. Vergleichen Sie den Ansatz von redis-doc und sehen Sie sich anschließend die verfügbaren CI-Einstiegspunkte des Repositorys an. Erledigt ist die Aufgabe, wenn das Projekt einen abgestimmten Ansatz für Linting und Rechtschreibprüfung sowie automatisierte Prüfungen für eingereichte PRs hat.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
ci-cd, documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.