search

newrelic / docs-website

Source code for @newrelic docs. We welcome pull requests and questions on our docs!
https://docs.newrelic.com
Other
175 stars 1.27k forks source link

Add custom markdown linting rules for writers #382

Closed theletterf closed 3 years ago

theletterf commented 3 years ago

Is your enhancement request related to a problem?

Contributions might not always adhere to the style guide and there are many rules that New Relic adheres to that would be better enforced by using a markdown linter rules that can check a commit prior to creating a PR for review.

Sample linter rules

Describe the solution you'd like

There are several differ approaches we could take.

Vale is a prose linter which can check markdown and code for issues against a a set of rules. It's relatively easy to set up, has VS Code integration, and can be extended to cover the New Relic style guide.

https://docs.errata.ai/vale/about

Markdownlint is an opensource library we could build a base linter from and we can author custom rules

https://github.com/DavidAnson/markdownlint

Authoring custom rules: https://github.com/DavidAnson/markdownlint/blob/main/doc/CustomRules.md doc/CustomRules.md

Here is a custom rule someone developed for title case: https://www.npmjs.com/package/markdownlint-rule-titlecase

jpvajda commented 3 years ago

I've modified this issue to focus on the problem vs offering a solution.

theletterf commented 3 years ago

Thanks, @jpvajda !

jpvajda commented 3 years ago

@theletterf thanks for the suggestion! Hope you are well.

jpvajda commented 3 years ago

this seems to be getting more popular: https://github.com/errata-ai/vale

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be automatically closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be automatically closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 3 years ago

This issue has been automatically closed because it was a stale issue that had no recent activity. Thank you for your contributions.

jpvajda commented 3 years ago

Letting this stay closed as we haven't come back to it. If we decide to take this on it can be re-opened.

theletterf commented 1 year ago

Glad to this you're now using Vale, @austin-schaefer !