Skip to content

Commit

Permalink
Automate Wiki Publish - Issue #41 (#42)
Browse files Browse the repository at this point in the history
* Automate Wiki Publish - Issue #41

* Fix Wiki Home
  • Loading branch information
PlagueHO authored Jul 5, 2020
1 parent ab80f8c commit 882a9f9
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 3 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- FSRMDsc
- Automatically publish documentation to GitHub Wiki - Fixes [Issue #41](https://github.com/dsccommunity/FSRMDsc/issues/41).

## [2.5.0] - 2020-06-20

### Changed
Expand Down
7 changes: 4 additions & 3 deletions build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,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 #
Expand Down
35 changes: 35 additions & 0 deletions source/WikiSource/Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Welcome to the FSRMDsc wiki

<sup>*FSRMDsc v#.#.#*</sup>

Here you will find all the information you need to make use of the FSRMDsc
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 FSRMDsc.

Please leave comments, feature requests, and bug reports in then
[issues section](https://github.com/dsccommunity/FSRMDsc/issues) for this module.

## Getting started

To get started download FSRMDsc from the [PowerShell Gallery](http://www.powershellgallery.com/packages/FSRMDsc/)
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 FSRMDsc -Repository PSGallery | Install-Module
```

To confirm installation, run the below command and ensure you see the FSRMDsc
DSC resources available:

```powershell
Get-DscResource -Module FSRMDsc
```

## Change Log

A full list of changes in each version can be found in the [change log](https://github.com/dsccommunity/FSRMDsc/blob/master/CHANGELOG.md).

0 comments on commit 882a9f9

Please sign in to comment.