Merge pull request #123 from PlagueHO/Issue-122

Automate Wiki Publish - Issue #122
dsccommunity · Jul 4, 2020 · bcdcf2a · bcdcf2a
2 parents e41b12e + a35c22e
commit bcdcf2a
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- ActiveDirectoryCSDsc
+  - Automatically publish documentation to GitHub Wiki - Fixes [Issue #122](https://github.com/dsccommunity/ActiveDirectoryCSDsc/issues/122).
+
 ## [5.0.0] - 2020-06-20
 
 ### Changed

diff --git a/build.yaml b/build.yaml
@@ -45,11 +45,12 @@ BuildWorkflow:
 
   test:
     - Pester_Tests_Stop_On_Fail
-    - Pester_if_Code_Coverage_Under_Threshold
+    - Pester_If_Code_Coverage_Under_Threshold
 
   publish:
-    - Publish_release_to_GitHub
-    - publish_module_to_gallery
+    - Publish_Release_to_GitHub
+    - Publish_Module_to_gallery
+    - Publish_GitHub_Wiki_Content
 
 ####################################################
 #       PESTER Configuration                       #

diff --git a/source/WikiSource/Home.md b/source/WikiSource/Home.md
@@ -0,0 +1,35 @@
+# Welcome to the ActiveDirectoryCSDsc wiki
+
+<sup>*ActiveDirectoryCSDsc v#.#.#*</sup>
+
+Here you will find all the information you need to make use of the ActiveDirectoryCSDsc
+DSC resources, including details of the resources that are available, current
+capabilities and known issues, and information to help plan a DSC based
+implementation of ActiveDirectoryCSDsc.
+
+Please leave comments, feature requests, and bug reports in then
+[issues section](https://github.com/dsccommunity/ActiveDirectoryCSDsc/issues) for this module.
+
+## Getting started
+
+To get started download ActiveDirectoryCSDsc from the [PowerShell Gallery](http://www.powershellgallery.com/packages/ActiveDirectoryCSDsc/)
+and then unzip it to one of your PowerShell modules folders
+(such as $env:ProgramFiles\WindowsPowerShell\Modules).
+
+To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0)
+run the following command:
+
+```powershell
+Find-Module -Name ActiveDirectoryCSDsc -Repository PSGallery | Install-Module
+```
+
+To confirm installation, run the below command and ensure you see the ActiveDirectoryCSDsc
+DSC resources available:
+
+```powershell
+Get-DscResource -Module ActiveDirectoryCSDsc
+```
+
+## Change Log
+
+A full list of changes in each version can be found in the [change log](https://github.com/dsccommunity/ActiveDirectoryCSDsc/blob/master/CHANGELOG.md).