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

Standarize Markdownlinter #453

Closed
brusMX opened this issue Mar 26, 2019 · 1 comment · Fixed by #740
Closed

Standarize Markdownlinter #453

brusMX opened this issue Mar 26, 2019 · 1 comment · Fixed by #740
Labels
documentation All issues related to documentation on how to use it, deploy it, etc enhancement Enhancements for current features

Comments

@brusMX
Copy link
Contributor

brusMX commented Mar 26, 2019

It would be desirable to lint markdown for the documentation and have it in a standard format.

Specification

  • Update all files to be lint to markdown
  • Implement the markdown lint cli in the devops pipeline
@brusMX brusMX added documentation All issues related to documentation on how to use it, deploy it, etc enhancement Enhancements for current features labels Mar 26, 2019
adamconnelly added a commit to adamconnelly/promitor that referenced this issue Oct 12, 2019
@adamconnelly
Add markdownlint to project
fcbf5bb 
- Added markdownlint via npm, and added a basic configuration file that.
  At the moment I've just setup the defaults, but disabled the line
  length rule for code blocks and tables.
- Updated the contributing guide to include information on running it.
- Added a new stage to the build pipeline to run the linting.

Fixes tomkerkhove#453
adamconnelly added a commit to adamconnelly/promitor that referenced this issue Oct 12, 2019
@adamconnelly
Add markdownlint to project
1367437 
- Added markdownlint via npm, and added a basic configuration file.
  At the moment I've just setup the defaults, but disabled the line
  length rule for code blocks and tables.
- Updated the contributing guide to include information on running it.
- Added a new stage to the build pipeline to run the linting.

Fixes tomkerkhove#453
@adamconnelly adamconnelly mentioned this issue Oct 12, 2019
Merged
adamconnelly added a commit to adamconnelly/promitor that referenced this issue Oct 12, 2019
@adamconnelly
Add markdownlint to project
8a24956 
- Added markdownlint via npm, and added a basic configuration file.
  At the moment I've just setup the defaults, but disabled the line
  length rule for code blocks and tables.
- Updated the contributing guide to include information on running it.
- Added a new stage to the build pipeline to run the linting.

Fixes tomkerkhove#453
adamconnelly added a commit to adamconnelly/promitor that referenced this issue Oct 12, 2019
@adamconnelly
Add markdownlint to project
d7e79cb 
- Added markdownlint via npm, and added a basic configuration file.
  At the moment I've just setup the defaults, but disabled the line
  length rule for code blocks and tables.
- Updated the contributing guide to include information on running it.
- Added a new stage to the build pipeline to run the linting.

Fixes tomkerkhove#453
adamconnelly added a commit to adamconnelly/promitor that referenced this issue Oct 12, 2019
@adamconnelly
Add markdownlint to project
36c5070 
- Added markdownlint via npm, and added a basic configuration file.
  At the moment I've just setup the defaults, but disabled the line
  length rule for code blocks and tables.
- Updated the contributing guide to include information on running it.
- Added a new stage to the build pipeline to run the linting.

Fixes tomkerkhove#453
@adamconnelly
Copy link
Contributor

I've created a PR that adds markdownlint to the project, runs it in Azure Pipelines, and fixes all the issues in the existing files.

I think we could go a bit further and use Husky to help prevent code that fails linting from being committed, but I want to wait to see what Tom thinks before doing that.

tomkerkhove pushed a commit that referenced this issue Oct 14, 2019
@adamconnelly @tomkerkhove
Add markdownlint support (#740)
3ba6655 
* Add markdownlint to project

- Added markdownlint via npm, and added a basic configuration file.
  At the moment I've just setup the defaults, but disabled the line
  length rule for code blocks and tables.
- Updated the contributing guide to include information on running it.
- Added a new stage to the build pipeline to run the linting.

Fixes #453

* Fix markdownlint issues in files

I've tried to only fix the issues highlighted by markdownlint in this commit, and keep the files as close as possible to how they were before these changes, although I did fix a couple of typos that I spotted as I was going through.

I've had to increase the heading level by one on most of the files because they had multiple h1s.

* fixup! Add markdownlint to project
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation All issues related to documentation on how to use it, deploy it, etc enhancement Enhancements for current features
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add markdownlint support adamconnelly/promitor
2 participants
@brusMX @adamconnelly