Skip to content

Commit b4d14a5

Browse files
SteveL-MSFTSteveL-MSFT
authored
Merge pull request #1 from michaeltlombardi/initial-work
Initial work
2 parents 12d7782 + a5ee6b5 commit b4d14a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+6432
-1
lines changed

‎.gitattributes‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* text eol=lf
2+
*.png binary
3+
*.gif binary

‎.github/ISSUE_TEMPLATE/00-bug.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "🐛 Report a documentation issue"
2+
description: >-
3+
Report an issue with current documentation.
4+
labels:
5+
- bug
6+
- needs-triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: >-
11+
Use this template to report issues with documentation. This can include typos, technical
12+
and factual errors, grammar, spelling, formatting, presentation, etc.
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Prerequisites
17+
description: >-
18+
These steps are required. After you've completed each step, check the box for it before
19+
moving on.
20+
options:
21+
- label: >-
22+
**Existing Issue:** Search the existing issues for this repository. If there is an
23+
issue that fits your needs do not file a new one. Subscribe, react, or comment on that
24+
issue instead.
25+
required: true
26+
- label: >-
27+
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
28+
provide context.
29+
required: true
30+
- type: textarea
31+
id: summary
32+
validations:
33+
required: true
34+
attributes:
35+
label: Summary
36+
description: >-
37+
Write a clear and concise description of the problem.
38+
- type: textarea
39+
id: details
40+
validations:
41+
required: false
42+
attributes:
43+
label: Details
44+
description: >-
45+
If possible, please provide extended details that will add context and help the team update
46+
the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
47+
For technical or factual errors, please include code snippets and output to show how the
48+
documentation or implementation is incorrect.
49+
- type: textarea
50+
id: suggestion
51+
validations:
52+
required: false
53+
attributes:
54+
label: Suggested Fix
55+
description: >-
56+
If you have an idea for how to fix the problem you're identifying, include it here.

‎.github/ISSUE_TEMPLATE/01-new-tutorial.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: "📝 Request a new tutorial"
2+
description: >-
3+
Request a new tutorial for the DSC Samples. If you want to request a new language implementation
4+
for an existing tutorial, use the "Request a new implementation" template instead.
5+
labels:
6+
- request-tutorial
7+
- needs-triage
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: >-
12+
Use this template to request or suggest a new tutorial for the DSC samples. Tutorials are
13+
always accompanied by sample code. DSC Resource tutorials have multiple language
14+
implementations for a shared set of learning goals. You can find more information about
15+
contributing tutorials in the
16+
[contributing guide](https://powershell.github.io/DSC-Samples/contributing/tutorials/).
17+
18+
- type: checkboxes
19+
id: prerequisites
20+
attributes:
21+
label: Prerequisites
22+
description: >-
23+
These steps are required. After you've completed each step, check the box for it before
24+
moving on.
25+
options:
26+
- label: >-
27+
**Existing Issue:** Search the existing issues for this repository. If there is an
28+
issue that fits your needs do not file a new one. Subscribe, react, or comment on that
29+
issue instead.
30+
required: true
31+
- label: >-
32+
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
33+
provide context. For example, "Tutorial for error handling in a DSC Resource" instead
34+
of "Handle errors"
35+
required: true
36+
- type: dropdown
37+
id: kind
38+
attributes:
39+
label: Tutorial Kind
40+
description: >-
41+
Generic tutorials only have a single implementation. These tutorials are primarily for
42+
authoring DSC Configuration documents and showing how to use DSC itself. Resource tutorials
43+
may be implemented in any number of languages. Resource tutorial implementations always
44+
share the same learning goals and their sample code implements the same specification.
45+
multiple: false
46+
options:
47+
- Generic
48+
- Resource
49+
- type: textarea
50+
id: summary
51+
validations:
52+
required: true
53+
attributes:
54+
label: Summary
55+
description: >-
56+
Write a clear and concise description of the proposed tutorial. Why is it needed? What gap
57+
will it fill? Who is the intended user? What scenarios will it address?
58+
placeholder: |
59+
Try formulating the need for this tutorial as a user story.
60+
61+
> As a <role>, I want a tutorial that <synopsis of learning goals>.
62+
- type: textarea
63+
id: details
64+
validations:
65+
required: false
66+
attributes:
67+
label: Details
68+
description: >-
69+
If possible, please provide extended details that will add context and help the team
70+
understand the proposed tutorial. If you're requesting a resource tutorial and are
71+
interested in contributing an implementation, please indicate which language you'd like to
72+
author the implementation in.

‎.github/ISSUE_TEMPLATE/02-new-implementation.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "📦 Request a new implementation"
2+
description: >-
3+
Request a new language implementation for an existing tutorial. If you want to request an
4+
entirely new tutorial, use the "Request a new tutorial" template instead.
5+
labels:
6+
- request-implementation
7+
- needs-triage
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: >-
12+
Use this template to request a new language implementation for an existing resource
13+
tutorial. DSC Resource tutorials have multiple language implementations for a shared set of
14+
learning goals. You can find more information about contributing tutorials in the
15+
[contributing guide](https://powershell.github.io/DSC-Samples/contributing/tutorials/).
16+
- type: checkboxes
17+
id: prerequisites
18+
attributes:
19+
label: Prerequisites
20+
description: >-
21+
These steps are required. After you've completed each step, check the box for it before
22+
moving on.
23+
options:
24+
- label: >-
25+
**Existing Issue:** Search the existing issues for this repository. If there is an
26+
issue that fits your needs do not file a new one. Subscribe, react, or comment on that
27+
issue instead.
28+
required: true
29+
- label: >-
30+
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
31+
provide context. For example, "Tutorial for error handling in a DSC Resource" instead
32+
of "Handle errors"
33+
required: true
34+
- type: dropdown
35+
id: tutorial
36+
attributes:
37+
label: Tutorial
38+
description: >-
39+
Specify the name of the tutorial you're requesting a new language implementation for.
40+
multiple: false
41+
options:
42+
- Write your first DSC Resource
43+
- type: input
44+
id: language
45+
attributes:
46+
label: Implementation language
47+
description: >-
48+
Specify the programming language you want the new implementation to use. The team has
49+
experience with C#, Go, and Rust, but you can request the implementation in any language.
50+
- type: textarea
51+
id: details
52+
validations:
53+
required: false
54+
attributes:
55+
label: Details
56+
description: >-
57+
If possible, please provide extended details that will add context and help the team
58+
with the implementation. If you're willing to contribute the implementation, please
59+
include that information.

‎.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Projects/Modules/Documentarian*/[0-9]*.[0-9]*.[0-9]*/
2+
# Source/Styles/*
3+
# !Source/Styles/PowerShell-Docs/
4+
# !Source/Styles/Vocab/
5+
.vscode/styles
6+
PackagedStyles
7+
.vale
8+
9+
# Hugo ignores
10+
Site/public
11+
Site/assets/vale
12+
Projects/Hugo/**/public
13+
**/resources/_gen
14+
**/.hugo_build.lock
15+
**/node_modules
16+
17+
# Test ignores
18+
Projects/Modules/**/*.Results.xml

‎.markdownlint-cli2.yaml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Rule definitions live in .markdownlint.json
2+
3+
# Include a custom rule package
4+
# customRules:
5+
# - markdownlint-rule-titlecase
6+
7+
# Fix any fixable errors
8+
fix: true
9+
10+
# Define a custom front matter pattern
11+
# frontMatter: (^---\s*$[^]*?^---\s*$)(\r\n|\r|\n|$)
12+
13+
# Define glob expressions to use (only valid at root)
14+
# globs:
15+
# - "!*bout.md"
16+
17+
# Define glob expressions to ignore
18+
ignores:
19+
- .vscode
20+
- assets
21+
- tests
22+
- tools
23+
24+
# Use a plugin to recognize math
25+
# markdownItPlugins:
26+
# - - "@iktakahiro/markdown-it-katex"
27+
28+
# Disable inline config comments
29+
noInlineConfig: false
30+
31+
# Disable progress on stdout (only valid at root)
32+
noProgress: true
33+
# Use a specific formatter (only valid at root)
34+
# outputFormatters:
35+
# - [markdownlint-cli2-formatter-default]

‎.markdownlint.json‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
{
2+
"blanks-around-fences": true,
3+
"blanks-around-headers": true,
4+
"blanks-around-lists": true,
5+
"code-block-style": {
6+
"style": "fenced"
7+
},
8+
"code-fence-style": {
9+
"style": "backtick"
10+
},
11+
"commands-show-output": true,
12+
"emphasis-style": {
13+
"style": "underscore"
14+
},
15+
"fenced-code-language": false,
16+
"first-line-h1": {
17+
"front_matter_title": "^\\s*title\\s*[:=]"
18+
},
19+
"header-increment": true,
20+
"header-start-left": true,
21+
"header-style": {
22+
"style": "atx"
23+
},
24+
"hr-style": {
25+
"style": "---"
26+
},
27+
"line-length": {
28+
"code_block_line_length": 90,
29+
"code_blocks": true,
30+
"heading_line_length": 100,
31+
"headings": true,
32+
"line_length": 100,
33+
"stern": true,
34+
"tables": false
35+
},
36+
"list-indent": true,
37+
"list-marker-space": true,
38+
"no-alt-text": true,
39+
"no-bare-urls": true,
40+
"no-blanks-blockquote": true,
41+
"no-duplicate-header": {
42+
"siblings_only": true
43+
},
44+
"no-emphasis-as-header": true,
45+
"no-empty-links": true,
46+
"no-hard-tabs": true,
47+
"no-inline-html": {
48+
"allowed_elements": [
49+
"a",
50+
"br",
51+
"code",
52+
"kbd",
53+
"li",
54+
"properties",
55+
"sup",
56+
"tags",
57+
"ul"
58+
]
59+
},
60+
"no-missing-space-atx": true,
61+
"no-missing-space-closed-atx": true,
62+
"no-multiple-blanks": true,
63+
"no-multiple-space-atx": true,
64+
"no-multiple-space-blockquote": true,
65+
"no-multiple-space-closed-atx": true,
66+
"no-reversed-links": true,
67+
"no-space-in-code": true,
68+
"no-space-in-emphasis": true,
69+
"no-space-in-links": true,
70+
"no-trailing-punctuation": {
71+
"punctuation": ".,;:!。，；：！？"
72+
},
73+
"no-trailing-spaces": {
74+
"br_spaces": 2,
75+
"strict": true
76+
},
77+
"ol-prefix": {
78+
"style": "one"
79+
},
80+
"proper-names": {
81+
"code_blocks": false,
82+
"names": [
83+
"PowerShell",
84+
"IntelliSense",
85+
"Authenticode",
86+
"CentOS",
87+
"Contoso",
88+
"CoreOS",
89+
"Debian",
90+
"Ubuntu",
91+
"openSUSE",
92+
"RHEL",
93+
"JavaScript",
94+
".NET",
95+
"NuGet",
96+
"VS Code",
97+
"Newtonsoft"
98+
]
99+
},
100+
"required-headers": false,
101+
"single-h1": {
102+
"front_matter_title": "",
103+
"level": 1
104+
},
105+
"single-trailing-newline": true,
106+
"strong-style": {
107+
"style": "asterisk"
108+
},
109+
"ul-indent": {
110+
"indent": 2,
111+
"start_indented": false
112+
},
113+
"ul-start-left": true,
114+
"ul-style": {
115+
"style": "dash"
116+
},
117+
"link-fragments": true,
118+
"reference-links-images": true,
119+
"link-image-reference-definitions": true
120+
}

‎README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
# DSC-Samples
1+
# DSC-Samples
2+
3+
This repository includes code samples for DSC v3.
4+
5+
<!-- Todo: Actual readme -->

‎_site/archetypes/default.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: true
5+
---
6+

0 commit comments

Comments
 (0)