Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Markdown linting README.md #307

Merged
merged 2 commits into from
Jan 4, 2022
Merged

Markdown linting README.md #307

merged 2 commits into from
Jan 4, 2022

Conversation

mamercad
Copy link
Contributor

@mamercad mamercad commented Dec 26, 2021 •
edited

Fixes #306; adding markdownlint to CI as well.

@pull-request-size pull-request-size bot added the size/M PR that changes 30-99 lines. Good size to review. label Dec 26, 2021
arm4b
arm4b suggested changes Dec 29, 2021
View reviewed changes
Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

While the Markdown linting might look like a good enhancement at first, unlike .yaml linter where issues should be actionable or .rst linter for docs.stackstorm.com where the issue might lead to a broken template, or ansible-lint which is based on the best practices, Markdown linter provides just a little value while bringing lots of noise for a single README.md.

README.md Outdated
Comment on lines 3 to 11
> [StackStorm](http://stackstorm.com/) is event-driven automation platform written in Python.
With over [50+ integrations](https://github.com/StackStorm/st2contrib/tree/master/packs) like GitHub, Docker, Nagios, NewRelic, AWS, Ansible it allows you to wire together your existing infrastructure into complex Workflows with auto-remediation and many more.
Aka IFTTT orchestration for Ops.

> [StackStorm](http://stackstorm.com/) is event-driven automation platform
> written in Python.

With over [50+ integrations](https://github.com/StackStorm/st2contrib/tree/master/packs)
like GitHub, Docker, Nagios, NewRelic, AWS, Ansible it allows you to wire
together your existing infrastructure into complex Workflows with
auto-remediation and many more. Aka IFTTT orchestration for Ops.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old
image

vs new
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, I'll remove the CI and fix the problems in the README when I get a few.

@mamercad
Copy link
Contributor Author

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

@mamercad mamercad changed the title Markdown linting Markdown linting README.md Dec 30, 2021
@mamercad mamercad requested a review from arm4b January 3, 2022 13:40
@arm4b
Copy link
Member

arm4b commented Jan 3, 2022

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
Copy link
Contributor Author

mamercad commented Jan 4, 2022

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
Copy link
Contributor Author

mamercad commented Jan 4, 2022

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

@arm4b
Copy link
Member

arm4b commented Jan 4, 2022

@mamercad Yes, please.

arm4b
arm4b approved these changes Jan 4, 2022
View reviewed changes
Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@arm4b arm4b merged commit eb38c44 into StackStorm:master Jan 4, 2022
@arm4b arm4b mentioned this pull request Dec 19, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arm4b arm4b arm4b approved these changes

Assignees
No one assigned
Labels
enhancement size/M PR that changes 30-99 lines. Good size to review.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

README.md fails linting
2 participants
@mamercad @arm4b