Skip to content

Commit 7608302

Browse files
johljujohlju
authored
Add wiki documentation and update pipeline files (#53)
- Moved documentation from README.md to the GitHub repository Wiki. - Removed the exported DSC resource from the module manifest under the source folder. They are automatically added to the module manifest in built module during the build process so that contributors don't have to add them manually. - Rearranged the Azure Pipelines jobs in the file `azure-pipelines.yml` so it is easier to updated the file from the Sampler's Plaster template in the future. - The HQRM tests was run twice in the pipeline, now they are run just once. - Updated the README.md with new section and updated the links.
1 parent 37750eb commit 7608302

31 files changed

+780
-386
lines changed

‎.gitattributes

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
2-
* text eol=crlf
2+
* text eol=autocrlf
3+
4+
*.mof text eol=crlf
5+
*.sh text eol=lf
6+
*.svg eol=lf
37

48
# Ensure any exe files are treated as binary
59
*.exe binary
610
*.jpg binary
711
*.xl* binary
812
*.pfx binary
13+
*.png binary
14+
*.dll binary
15+
*.so binary
916
*.pssc text=auto
1017
*.pssc diff
1118
*.psrc text=auto

‎.github/ISSUE_TEMPLATE/Problem_with_resource.md

-57
This file was deleted.

‎.github/ISSUE_TEMPLATE/Problem_with_resource.yml

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: Problem with a resource
2+
description: If you have a problem, bug, or enhancement with a resource in this resource module.
3+
labels: []
4+
assignees: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please prefix the issue title (above) with the resource name, e.g. 'ResourceName: Short description of my issue'!
10+
11+
Your feedback and support is greatly appreciated, thanks for contributing!
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Problem description
16+
description: Details of the scenario you tried and the problem that is occurring.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: logs
21+
attributes:
22+
label: Verbose logs
23+
description: |
24+
Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
25+
placeholder: |
26+
Paste verbose logs here
27+
render: text
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: configuration
32+
attributes:
33+
label: DSC configuration
34+
description: |
35+
The DSC configuration that is used to reproduce the issue (as detailed as possible). **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as PowerShell code._
36+
placeholder: |
37+
Paste DSC configuration here
38+
render: powershell
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: suggestedSolution
43+
attributes:
44+
label: Suggested solution
45+
description: Do you have any suggestions how to solve the issue?
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: targetNodeOS
50+
attributes:
51+
label: Operating system the target node is running
52+
description: |
53+
Please provide as much as possible about the target node, for example edition, version, build, and language. _Will be automatically formatted as plain text._
54+
55+
On OS with WMF 5.1 the following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
56+
placeholder: |
57+
Add operating system information here
58+
render: text
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: targetNodePS
63+
attributes:
64+
label: PowerShell version and build the target node is running
65+
description: |
66+
Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
67+
68+
To help with this information, please run this command: `$PSVersionTable`
69+
placeholder: |
70+
Add PowerShell information here
71+
render: text
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: moduleVersion
76+
attributes:
77+
label: JeaDsc version
78+
description: |
79+
Please provide the version of the JeaDsc module that was used. _Will be automatically formatted as plain text._
80+
81+
To help with this information, please run this command: `Get-Module -Name 'JeaDsc' -ListAvailable | ft Name,Version,Path`
82+
placeholder: |
83+
Add module information here
84+
render: text
85+
validations:
86+
required: true
87+

‎.github/ISSUE_TEMPLATE/Resource_proposal.md

-21
This file was deleted.

‎.github/ISSUE_TEMPLATE/Resource_proposal.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: New resource proposal
2+
description: If you have a new resource proposal that you think should be added to this resource module.
3+
title: "NewResourceName: New resource proposal"
4+
labels: []
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Please replace `NewResourceName` in the issue title (above) with your proposed resource name.
11+
12+
Thank you for contributing and making this resource module better!
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Resource proposal
17+
description: Provide information how this resource will/should work and how it will help users.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: proposedProperties
22+
attributes:
23+
label: Proposed properties
24+
description: |
25+
List all the proposed properties that the resource should have (key, required, write, and/or read). For each property provide a detailed description, the data type, if a default value should be used, and if the property is limited to a set of values.
26+
value: |
27+
Property | Type qualifier | Data type | Description | Default value | Allowed values
28+
--- | --- | --- | --- | --- | ---
29+
PropertyName | Key | String | Detailed description | None | None
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: considerations
34+
attributes:
35+
label: Special considerations or limitations
36+
description: |
37+
Provide any considerations or limitations you can think of that a contributor should take in account when coding the proposed resource, and or what limitations a user will encounter or should consider when using the proposed resource.
38+
validations:
39+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "Virtual PowerShell User Group #DSC channel"
4+
url: https://dsccommunity.org/community/contact/
5+
about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel."
6+

‎.github/PULL_REQUEST_TEMPLATE.md

+31-28
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,50 @@
11
<!--
2-
Thanks for submitting a Pull Request (PR) to this project.
3-
Your contribution to this project is greatly appreciated!
2+
Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project
3+
is greatly appreciated!
44
5-
Please prefix the PR title with the resource name,
6-
e.g. 'ResourceName: My short description'.
7-
If this is a breaking change, then also prefix the PR title
8-
with 'BREAKING CHANGE:',
5+
Please prefix the PR title with the resource name, e.g. 'ResourceName: My short description'.
6+
If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:',
97
e.g. 'BREAKING CHANGE: ResourceName: My short description'.
108
11-
You may remove this comment block, and the other comment blocks, but please
12-
keep the headers and the task list.
9+
You may remove this comment block, and the other comment blocks, but please keep the headers
10+
and the task list.
1311
-->
12+
1413
#### Pull Request (PR) description
14+
1515
<!--
16-
Replace this comment block with a description of your PR.
16+
Replace this comment block with a description of your PR. Also, make sure you have updated the
17+
CHANGELOG.md, see the task list below. An entry in the CHANGELOG.md is mandatory for all PRs.
1718
-->
1819

1920
#### This Pull Request (PR) fixes the following issues
21+
2022
<!--
21-
If this PR does not fix an open issue, replace this comment block with None.
22-
If this PR resolves one or more open issues, replace this comment block with
23-
a list the issues using a GitHub closing keyword, e.g.:
24-
- Fixes #123
25-
- Fixes #124
23+
If this PR does not fix an open issue, replace this comment block with None. If this PR
24+
resolves one or more open issues, replace this comment block with a list of the issues using
25+
a GitHub closing keyword, e.g.:
26+
27+
- Fixes #123
28+
- Fixes #124
2629
-->
2730

2831
#### Task list
32+
2933
<!--
30-
To aid community reviewers in reviewing and merging your PR, please take
31-
the time to run through the below checklist and make sure your PR has
32-
everything updated as required.
34+
To aid community reviewers in reviewing and merging your PR, please take the time to run
35+
through the below checklist and make sure your PR has everything updated as required.
3336
34-
Change to [x] for each task in the task list that applies to your PR.
35-
For those task that don't apply to you PR, leave those as is.
37+
Change to [x] for each task in the task list that applies to your PR. For those task that
38+
don't apply to you PR, leave those as is.
3639
-->
37-
- [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md.
38-
Entry should say what was changed, and how that affects users (if applicable).
39-
- [ ] Resource documentation added/updated in README.md in resource folder.
40-
- [ ] Resource parameter descriptions added/updated in schema.mof
41-
and comment-based help.
42-
- [ ] Comment-based help added/updated.
40+
41+
- [ ] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md.
42+
Entry should say what was changed and how that affects users (if applicable), and
43+
reference the issue being resolved (if applicable).
44+
- [ ] Resource documentation added/updated in comment-based help.
45+
- [ ] Resource parameter descriptions added/updated in comment-based help.
4346
- [ ] Localization strings added/updated in all localization files as appropriate.
4447
- [ ] Examples appropriately added/updated.
45-
- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
46-
- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
47-
- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md).
48+
- [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
49+
- [ ] Integration tests added/updated (where possible). See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines).
50+
- [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ output/
55
!**/README.md
66
.kitchen/
77

8+
*.nupkg
89
*.suo
910
*.user
1011
*.coverage

‎.vscode/settings.json

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
{
2+
"powershell.codeFormatting.openBraceOnSameLine": false,
23
"powershell.codeFormatting.newLineAfterOpenBrace": true,
34
"powershell.codeFormatting.newLineAfterCloseBrace": true,
45
"powershell.codeFormatting.whitespaceBeforeOpenBrace": true,
56
"powershell.codeFormatting.whitespaceBeforeOpenParen": true,
67
"powershell.codeFormatting.whitespaceAroundOperator": true,
78
"powershell.codeFormatting.whitespaceAfterSeparator": true,
89
"powershell.codeFormatting.ignoreOneLineBlock": false,
9-
"powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline",
10+
"powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
1011
"powershell.codeFormatting.preset": "Custom",
1112
"powershell.codeFormatting.alignPropertyValuePairs": true,
12-
"files.trimTrailingWhitespace": true,
13-
"files.insertFinalNewline": true,
13+
"powershell.developer.bundledModulesPath": "${cwd}/output/RequiredModules",
1414
"powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1",
1515
"powershell.scriptAnalysis.enable": true,
16+
"files.trimTrailingWhitespace": true,
17+
"files.trimFinalNewlines": true,
18+
"files.insertFinalNewline": true,
1619
"files.associations": {
1720
"*.ps1xml": "xml"
1821
},

‎.vscode/tasks.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"label": "build",
4242
"type": "shell",
4343
"command": "&${cwd}/build.ps1",
44-
"args": ["-AutoRestore"],
44+
"args": [],
4545
"presentation": {
4646
"echo": true,
4747
"reveal": "always",

‎CHANGELOG.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1+
# Changelog for JeaDsc
2+
13
The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
24
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
35

4-
# Change log for JeaDsc
5-
66
## [Unreleased]
77

88
### Added
@@ -16,11 +16,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616

1717
### Changed
1818

19+
- Moved documentation from README.md to the GitHub repository Wiki.
1920
- Moving the class based resources from nested modules to root module.
2021
- Moving LocalizedData of class based resources in .strings.psd1 files.
21-
Based on [stylesguidelines](https://dsccommunity.org/styleguidelines/localization/) of DscCommunity.
22+
Based on [style guidelines](https://dsccommunity.org/styleguidelines/localization/) of DscCommunity.
2223
- Updated the Required Modules and Build.Yaml with Sampler.GitHubTasks.
23-
- Updated pipeline to current pattern and added Invoke0-Build tasks.
24+
- Updated pipeline to current pattern and added Invoke-Build tasks.
25+
- Removed the exported DSC resource from the module manifest under the
26+
source folder. They are automatically added to the module manifest in
27+
built module during the build process so that contributors don't have
28+
to add them manually.
29+
- Rearranged the Azure Pipelines jobs in the file `azure-pipelines.yml`
30+
so it is easier to updated the file from the Sampler's Plaster template
31+
in the future.
32+
- The HQRM tests was run twice in the pipeline, now they are run just once.
33+
- Updated the README.md with new section and updated the links.
2434

2535
### Removed
2636

‎CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# Contributing
22

33
Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
4+
5+
## Running the Tests
6+
7+
If want to know how to run this module's tests you can look at the [Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines/#running-tests)

0 commit comments

Comments
 (0)