search

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

Refresh the `README.md` #327

Closed mamercad closed 1 year ago

mamercad commented 1 year ago

Fix the broken Slack badge image, remove contractions, make grammar changes, write OS names and versions more consistently, show long options in commands, etc. I'll add markdown linting ~in another PR~ shortly.

mamercad commented 1 year ago

I'm 👍 for the Readme refresh, but 👎 for Markdown linting as that's another uneeded check that might block a PR or change.

I think markdown linting makes sense for the projects where every file is documentation, but not for a single README.md when the frequency of change is low and the chance of breaking a Markdown file is even lower (they just work!). Let's avoid utilizing computing resources in this case 🍏

Sure, I'll push without the workflow shortly.

mamercad commented 1 year ago

I'm 👍 for the Readme refresh, but 👎 for Markdown linting as that's another uneeded check that might block a PR or change. I think markdown linting makes sense for the projects where every file is documentation, but not for a single README.md when the frequency of change is low and the chance of breaking a Markdown file is even lower (they just work!). Let's avoid utilizing computing resources in this case 🍏

Sure, I'll push without the workflow shortly.

Done, I rebased as well so the history should be clean.

mamercad commented 1 year ago

In the spirit of not running workflows unnecessarily, I'm noticing that the build workflow is running (for this README.md update, we should probably fix that).