Skip to content

Commit

Permalink
Documentation updates (#1)
Browse files Browse the repository at this point in the history
* Minor doc corrections
* Doc updates and add GitHub issue templates
  • Loading branch information
BernieWhite authored Nov 24, 2018
1 parent c27d0a0 commit de74683
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 21 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Report errors or unexpected behaviour
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behaviour.

**Expected behaviour**
A clear and concise description of what you expected to happen.

**Error output**
Capture any error messages and or verbose messages with `-Verbose`.

**Module in use and version (please complete the following information):**
- Module: [e.g. PSRule]
- Version [e.g. 0.1.0]

**Additional context**
Add any other context about the problem here.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature request
about: Suggest an idea
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
# Change log

## Unreleased
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,23 @@

A PowerShell module with commands to validate objects on the pipeline.

| AppVeyor (Windows) | Codecov (Windows) |
| --- | --- |
| [![av-image][]][av-site] | [![cc-image][]][cc-site] |

[av-image]: https://ci.appveyor.com/api/projects/status/pl7tu7ktue388n7s
[av-site]: https://ci.appveyor.com/project/BernieWhite/PSRule
[cc-image]: https://codecov.io/gh/BernieWhite/PSRule/branch/master/graph/badge.svg
[cc-site]: https://codecov.io/gh/BernieWhite/PSRule
![ci-badge]

## Disclaimer

This project is to be considered a **proof-of-concept** and **not a supported Microsoft product**.
This project is to be considered a **proof-of-concept** and **not a supported product**.

If you have any problems please check our GitHub [issues](https://github.com/BernieWhite/PSRule/issues) page. If you do not see your problem captured, please file a new issue and follow the provided template.

## Modules

The following modules are included in this repository.
## Getting the modules

You can download and install these PowerShell modules from the PowerShell Gallery.

| Module | Description | Latest version |
| ------ | ----------- | -------------- |
| PSRule | A PowerShell rules engine. | Unreleased |
| Module | Description | Downloads / instructions |
| ------ | ----------- | ------------------------ |
| PSRule | A PowerShell rules engine | Unreleased |

## Getting started

Expand Down Expand Up @@ -64,4 +61,6 @@ Modules in this repository will use the [semantic versioning](http://semver.org/

This project is [licensed under the MIT License](LICENSE).

[psg-psrule]: https://www.powershellgallery.com/packages/PSRule
[install]: docs/scenarios/install-instructions.md
[ci-badge]: https://bewhite.visualstudio.com/PSRule/_apis/build/status/PSRule-CI?branchName=master
[psg-psrule]: https://www.powershellgallery.com/packages/PSRule
9 changes: 5 additions & 4 deletions docs/commands/PSRule/en-US/Invoke-RuleEngine.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: PSRule-help.xml
Module Name: PSRule
online version:
online version: https://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/Invoke-RuleEngine.md
schema: 2.0.0
---

Expand All @@ -13,7 +13,7 @@ Evaluate pipeline objects against matching rules.

## SYNTAX

```
```text
Invoke-RuleEngine [-Path] <String> [[-ConfigurationData] <Object>] [-InputObject] <PSObject>
[[-Status] <String[]>] [<CommonParameters>]
```
Expand All @@ -30,12 +30,13 @@ Evaluate pipeline objects against matching rules.
PS C:\> @{ Name = 'Item 1' } | Invoke-RuleEngine .
```

{{ Add example description here }}
Evaluate a simple hashtable on the pipeline against rules loaded from the current working path.

## PARAMETERS

### -ConfigurationData
{{Fill ConfigurationData Description}}

Additional configuration data that can be referenced from rules. ConfigurationData can be a hashtable or a valid file path to a `.psd1` file.

```yaml
Type: Object
Expand Down
4 changes: 2 additions & 2 deletions docs/keywords/PSRule/en-US/about_PSRule_Keywords.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ An online version of this document is available at https://github.com/BernieWhit

## SEE ALSO

- [Invoke-PSDocument]
- [Invoke-RuleEngine]

## KEYWORDS

Expand All @@ -292,4 +292,4 @@ An online version of this document is available at https://github.com/BernieWhit
- When
- TypeOf

[Invoke-RuleEngine]: https://github.com/BernieWhite/PSRule/docs/commands/PSRule/en-US/Invoke-RuleEngine.md
[Invoke-RuleEngine]: https://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/Invoke-RuleEngine.md

0 comments on commit de74683

Please sign in to comment.