Skip to content

Correct Example Style to meet HQRM and Enable Example Tests - Fixes #82#86

Merged
PlagueHO merged 8 commits intodsccommunity:devfrom
PlagueHO:Issue-82
Jul 22, 2017
Merged

Correct Example Style to meet HQRM and Enable Example Tests - Fixes #82#86
PlagueHO merged 8 commits intodsccommunity:devfrom
PlagueHO:Issue-82

Conversation

@PlagueHO
Copy link
Copy Markdown
Member

@PlagueHO PlagueHO commented Jul 22, 2017

This PR:

  • Corrects the examples so that the meet the standards required to enable the Common Tests - Validate Example Files.
  • Opts-in to the Common Tests - Validate Example Files tests.
  • Renames the example files to support the change over to auto documentation resource module style.
  • Ensures all examples in README.MD match examples in files and none are missing.

Note: I could instead link the examples in README.MD instead of keeping copies in there, but as these will very soon be removed anyway due to the move to auto-documentation I didn't bother, as they get automatically assembled anyway.


This change is Reviewable

@PlagueHO PlagueHO added the needs review The pull request needs a code review. label Jul 22, 2017
@PlagueHO PlagueHO added this to the HQRM milestone Jul 22, 2017
@PlagueHO PlagueHO requested a review from bgelens July 22, 2017 01:59
@codecov-io
Copy link
Copy Markdown

codecov-io commented Jul 22, 2017

Codecov Report

Merging #86 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@        Coverage Diff        @@
##           dev   #86   +/-   ##
=================================
  Coverage   68%   68%           
=================================
  Files        6     6           
  Lines      719   719           
=================================
  Hits       494   494           
  Misses     225   225

@johlju
Copy link
Copy Markdown
Member

johlju commented Jul 22, 2017

I did not style check the examples in README.md. Since you will remove them. Why not remove them now and add an Examples header instead pointing to the Examples folder?
https://github.com/PowerShell/xSQLServer#examples


Reviewed 16 of 16 files at r1.
Review status: all files reviewed at latest revision, 2 unresolved discussions, some commit checks failed.


Examples/xOfflineDomainJoin/1-JoinDomainUsingODJBlob.ps1, line 17 at r1 (raw file):

    Import-DscResource -ModuleName xComputerManagement

    node $NodeName

Node upper 'N'


Examples/xVirtualMemory/1-SetVirtualMemory.ps1, line 21 at r1 (raw file):

        xVirtualMemory pagingSettings
        {
            Type = "CustomSize"

Single quotes, here and the three lines below.


Comments from Reviewable

@PlagueHO
Copy link
Copy Markdown
Member Author

Thanks for reviewing @johlju! I've moved all the examples out of the README.MD and replaced them with links - I also moved the example links to be under the resource header they actually apply to.

While I was at it I found some spelling errors in the filenames and corrected those.


Review status: 8 of 13 files reviewed at latest revision, 2 unresolved discussions.


Examples/xOfflineDomainJoin/1-JoinDomainUsingODJBlob.ps1, line 17 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Node upper 'N'

Done.


Examples/xVirtualMemory/1-SetVirtualMemory.ps1, line 21 at r1 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Single quotes, here and the three lines below.

Done. And aligned.


Comments from Reviewable

@johlju
Copy link
Copy Markdown
Member

johlju commented Jul 22, 2017

Reviewed 1 of 18 files at r1, 7 of 7 files at r2.
Review status: all files reviewed at latest revision, all discussions resolved, some commit checks failed.


Comments from Reviewable

@johlju
Copy link
Copy Markdown
Member

johlju commented Jul 22, 2017

:lgtm:


Review status: all files reviewed at latest revision, all discussions resolved, some commit checks failed.


Comments from Reviewable

@PlagueHO
Copy link
Copy Markdown
Member Author

Thanks for reviewing @johlju

@PlagueHO PlagueHO merged commit 1bbbf03 into dsccommunity:dev Jul 22, 2017
@PlagueHO PlagueHO deleted the Issue-82 branch July 22, 2017 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs review The pull request needs a code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants