Skip to content

docs(contributing): add link check information#8659

Merged
TravisEz13 merged 12 commits intoPowerShell:masterfrom
RDIL:patch-2
Jan 16, 2019
Merged

docs(contributing): add link check information#8659
TravisEz13 merged 12 commits intoPowerShell:masterfrom
RDIL:patch-2

Conversation

@RDIL
Copy link
Contributor

@RDIL RDIL commented Jan 16, 2019

PR Summary

title

PR Context

@TravisEz13 told me to do this
Travis if your reading this just know I have to update the other file please no merge yet

PR Checklist

@TravisEz13 TravisEz13 self-assigned this Jan 16, 2019
adityapatwardhan and others added 3 commits January 15, 2019 20:31
@RDIL RDIL changed the title [ WIP ] docs(contributing): add link check information docs(contributing): add link check information Jan 16, 2019
@RDIL
Copy link
Contributor Author

RDIL commented Jan 16, 2019

@adityapatwardhan feedback addressed, @TravisEz13 ready for review.

@RDIL
Copy link
Contributor Author

RDIL commented Jan 16, 2019

@adityapatwardhan please re-review since requested changes were addressed.

* if the `.spelling` file is updated, commit and push it

#### Checking links in documentation
Documentation is link-checked. We make use of the
Copy link
Member

Choose a reason for hiding this comment

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

I would suggest saying that this and markdown syntax checking (like the newline before and after headers.) can be checked by running start-pspester -includecommontests

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍

#### Spellchecking documentation

Documentation are spellchecked. We make use of the
Documentation is spellchecked. We use the
Copy link
Member

Choose a reason for hiding this comment

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

This file apparently isn't being checked for markdown syntax issues.
You can add it by updating this list

'./.github/CONTRIBUTING.md'
'./*.md'
'./demos/python/*.md'
'./docker/*.md'
'./docs/*.md'
'./docs/building/*.md'
'./docs/cmdlet-example/*.md'
'./docs/maintainers/*.md'
'./docs/testing-guidelines/testing-guidelines.md'
'./test/powershell/README.md'
'./tools/*.md'

Not a requirement. If you are using, vscode, you can just install the markdownlinq extension and you should get the issues as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay 👍

@TravisEz13
Copy link
Member

Thanks a lot.

@TravisEz13 TravisEz13 added the CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log label Jan 16, 2019
@TravisEz13 TravisEz13 merged commit 9eb6fc9 into PowerShell:master Jan 16, 2019
@RDIL RDIL deleted the patch-2 branch January 16, 2019 23:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-Docs Indicates that a PR should be marked as a documentation change in the Change Log

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments