Improve local documentation validation #1028
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
When running the ValidateDocumentation command locally after running a build, the markdown linter picks up the nuget packages folder and adds noise too much noise to the commands output.
What
This PR moves the current ignore list into a markdownlintignore file, and adds the nuget packages directory to the ignore list.
Tests
The change was validated locally by running the build commands.
Checklist
No new functionality was added.
- [ ]CHANGELOG.mdis updated.- [ ] Documentation is updated.- [ ] New features are covered by tests.