dsccommunity / dsccommunity/DscResource.Test

Move QA test for Markdown style "Common Tests - Validate Markdown Files"

Open
#55 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted tests
Dominant language
PowerShell
Stars
6
Forks
9
PR merge metrics
No merged PRs in 30d

Description

We should move the QA test for markdown files.

https://github.com/PowerShell/DscResource.Tests/blob/dev/Meta.Tests.ps1#L861

This is text I removed from the SqlServerDsc repo that should be added (or something similar) to the guidelines on the DSC Community site.

#### Unit tests for style check of Markdown files

When sending in a Pull Request (PR) a style check will be performed on all Markdown
files, and if the tests find any error the build will fail.
See the section [Documentation with Markdown](#documentation-with-markdown) how
these errors kan be found before sending in the PR.

The Markdown tests can be run locally if the packet manager 'npm' is available.
To have npm available you need to install [node.js](https://nodejs.org/en/download/).
If 'npm' is not available, a warning text will print and the rest of the tests
will continue run.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Meta.Tests.ps1 around line 861 and compare the existing Markdown validation test with the supplied guidance text. Determine where the corresponding guidance belongs on the DSC Community site and what should be moved or retained in the test repository. Done means the Markdown test and its user-facing instructions are placed in their intended locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, node.js, powershell
Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.