StackStorm / ansible-st2

Ansible Roles and Playbooks to deploy StackStorm
https://galaxy.ansible.com/StackStorm/stackstorm/
Apache License 2.0
100 stars 77 forks source link

Markdown linting README.md #307

Closed mamercad closed 2 years ago

mamercad commented 2 years ago

Fixes #306; ~adding markdownlint to CI as well~.

mamercad commented 2 years ago

Down to only line length warnings:

❯ mdl README.md 
README.md:51: MD013 Line length
README.md:53: MD013 Line length
README.md:54: MD013 Line length
README.md:55: MD013 Line length
README.md:56: MD013 Line length
README.md:57: MD013 Line length
README.md:59: MD013 Line length
README.md:60: MD013 Line length
README.md:61: MD013 Line length
README.md:63: MD013 Line length
README.md:64: MD013 Line length
README.md:65: MD013 Line length
README.md:66: MD013 Line length
README.md:67: MD013 Line length
README.md:69: MD013 Line length
README.md:70: MD013 Line length
README.md:71: MD013 Line length
README.md:72: MD013 Line length
README.md:74: MD013 Line length
README.md:75: MD013 Line length
README.md:76: MD013 Line length
README.md:77: MD013 Line length
README.md:78: MD013 Line length
README.md:79: MD013 Line length

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
arm4b commented 2 years ago

Hi @mamercad, we don't enforce the line length limit for Markdown files. Is there any specific issue you're having with rendering the README.md? Please include those practical fixes and enhancements only.

To make the build green, you can update your working branch with the most recent upstream master.

mamercad commented 2 years ago

Hi @mamercad, we don't enforce the line length limit for Markdown files. Is there any specific issue you're having with rendering the README.md? Please include those practical fixes and enhancements only.

To make the build green, you can update your working branch with the most recent upstream master.

The linting problems were visual noise in my IDE, that's all. I'll rebase shortly.

mamercad commented 2 years ago

If you'd like me to undo line length, just let me know.

arm4b commented 2 years ago

@mamercad Yes, please.