PowerShell · SteveL-MSFT · Aug 1, 2023 · Jul 24, 2023
@@ -0,0 +1,3 @@
+* text eol=lf
+*.png binary
+*.gif binary
@@ -0,0 +1,56 @@
+name: "🐛 Report a documentation issue"
+description: >-
+  Report an issue with current documentation.
+labels:
+  - bug
+  - needs-triage
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        Use this template to report issues with documentation. This can include typos, technical
+        and factual errors, grammar, spelling, formatting, presentation, etc.
+  - type: checkboxes
+    id: prerequisites
+    attributes:
+      label: Prerequisites
+      description: >-
+        These steps are required. After you've completed each step, check the box for it before
+        moving on.
+      options:
+        - label: >-
+            **Existing Issue:** Search the existing issues for this repository. If there is an
+            issue that fits your needs do not file a new one. Subscribe, react, or comment on that
+            issue instead.
+          required: true
+        - label: >-
+            **Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
+            provide context.
+          required: true
+  - type: textarea
+    id: summary
+    validations:
+      required: true
+    attributes:
+      label: Summary
+      description: >-
+        Write a clear and concise description of the problem.
+  - type: textarea
+    id: details
+    validations:
+      required: false
+    attributes:
+      label: Details
+      description: >-
+        If possible, please provide extended details that will add context and help the team update
+        the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
+        For technical or factual errors, please include code snippets and output to show how the
+        documentation or implementation is incorrect.
+  - type: textarea
+    id: suggestion
+    validations:
+      required: false
+    attributes:
+      label: Suggested Fix
+      description: >-
+        If you have an idea for how to fix the problem you're identifying, include it here.
@@ -0,0 +1,72 @@
+name: "📝 Request a new tutorial"
+description: >-
+  Request a new tutorial for the DSC Samples. If you want to request a new language implementation
+  for an existing tutorial, use the "Request a new implementation" template instead.
+labels:
+  - request-tutorial
+  - needs-triage
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        Use this template to request or suggest a new tutorial for the DSC samples. Tutorials are
+        always accompanied by sample code. DSC Resource tutorials have multiple language
+        implementations for a shared set of learning goals. You can find more information about
+        contributing tutorials in the
+        [contributing guide](https://powershell.github.io/DSC-Samples/contributing/tutorials/).
+
+  - type: checkboxes
+    id: prerequisites
+    attributes:
+      label: Prerequisites
+      description: >-
+        These steps are required. After you've completed each step, check the box for it before
+        moving on.
+      options:
+        - label: >-
+            **Existing Issue:** Search the existing issues for this repository. If there is an
+            issue that fits your needs do not file a new one. Subscribe, react, or comment on that
+            issue instead.
+          required: true
+        - label: >-
+            **Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
+            provide context. For example, "Tutorial for error handling in a DSC Resource" instead
+            of "Handle errors"
+          required: true
+  - type: dropdown
+    id:   kind
+    attributes:
+      label: Tutorial Kind
+      description: >-
+        Generic tutorials only have a single implementation. These tutorials are primarily for
+        authoring DSC Configuration documents and showing how to use DSC itself. Resource tutorials
+        may be implemented in any number of languages. Resource tutorial implementations always
+        share the same learning goals and their sample code implements the same specification.
+      multiple: false
+      options:
+        - Generic
+        - Resource
+  - type: textarea
+    id: summary
+    validations:
+      required: true
+    attributes:
+      label: Summary
+      description: >-
+        Write a clear and concise description of the proposed tutorial. Why is it needed? What gap
+        will it fill? Who is the intended user? What scenarios will it address?
+      placeholder: |
+        Try formulating the need for this tutorial as a user story.
+
+        > As a <role>, I want a tutorial that <synopsis of learning goals>.
+  - type: textarea
+    id: details
+    validations:
+      required: false
+    attributes:
+      label: Details
+      description: >-
+        If possible, please provide extended details that will add context and help the team
+        understand the proposed tutorial. If you're requesting a resource tutorial and are
+        interested in contributing an implementation, please indicate which language you'd like to
+        author the implementation in.
@@ -0,0 +1,59 @@
+name: "📦 Request a new implementation"
+description: >-
+  Request a new language implementation for an existing tutorial. If you want to request an
+  entirely new tutorial, use the "Request a new tutorial" template instead.
+labels:
+  - request-implementation
+  - needs-triage
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        Use this template to request a new language implementation for an existing resource
+        tutorial. DSC Resource tutorials have multiple language implementations for a shared set of
+        learning goals. You can find more information about contributing tutorials in the
+        [contributing guide](https://powershell.github.io/DSC-Samples/contributing/tutorials/).
+  - type: checkboxes
+    id:   prerequisites
+    attributes:
+      label: Prerequisites
+      description: >-
+        These steps are required. After you've completed each step, check the box for it before
+        moving on.
+      options:
+        - label: >-
+            **Existing Issue:** Search the existing issues for this repository. If there is an
+            issue that fits your needs do not file a new one. Subscribe, react, or comment on that
+            issue instead.
+          required: true
+        - label: >-
+            **Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
+            provide context. For example, "Tutorial for error handling in a DSC Resource" instead
+            of "Handle errors"
+          required: true
+  - type: dropdown
+    id:   tutorial
+    attributes:
+      label: Tutorial
+      description: >-
+        Specify the name of the tutorial you're requesting a new language implementation for.
+      multiple: false
+      options:
+        - Write your first DSC Resource
+  - type: input
+    id:   language
+    attributes:
+      label: Implementation language
+      description: >-
+        Specify the programming language you want the new implementation to use. The team has
+        experience with C#, Go, and Rust, but you can request the implementation in any language.
+  - type: textarea
+    id: details
+    validations:
+      required: false
+    attributes:
+      label: Details
+      description: >-
+        If possible, please provide extended details that will add context and help the team
+        with the implementation. If you're willing to contribute the implementation, please
+        include that information.
@@ -0,0 +1,18 @@
+Projects/Modules/Documentarian*/[0-9]*.[0-9]*.[0-9]*/
+# Source/Styles/*
+# !Source/Styles/PowerShell-Docs/
+# !Source/Styles/Vocab/
+.vscode/styles
+PackagedStyles
+.vale
+
+# Hugo ignores
+Site/public
+Site/assets/vale
+Projects/Hugo/**/public
+**/resources/_gen
+**/.hugo_build.lock
+**/node_modules
+
+# Test ignores
+Projects/Modules/**/*.Results.xml
@@ -0,0 +1,35 @@
+# Rule definitions live in .markdownlint.json
+
+# Include a custom rule package
+# customRules:
+#   - markdownlint-rule-titlecase
+
+# Fix any fixable errors
+fix: true
+
+# Define a custom front matter pattern
+# frontMatter: (^---\s*$[^]*?^---\s*$)(\r\n|\r|\n|$)
+
+# Define glob expressions to use (only valid at root)
+# globs:
+#   - "!*bout.md"
+
+# Define glob expressions to ignore
+ignores:
+  - .vscode
+  - assets
+  - tests
+  - tools
+
+# Use a plugin to recognize math
+# markdownItPlugins:
+#   - - "@iktakahiro/markdown-it-katex"
+
+# Disable inline config comments
+noInlineConfig: false
+
+# Disable progress on stdout (only valid at root)
+noProgress: true
+# Use a specific formatter (only valid at root)
+# outputFormatters:
+#   - [markdownlint-cli2-formatter-default]
@@ -0,0 +1,120 @@
+{
+  "blanks-around-fences": true,
+  "blanks-around-headers": true,
+  "blanks-around-lists": true,
+  "code-block-style": {
+    "style": "fenced"
+  },
+  "code-fence-style": {
+    "style": "backtick"
+  },
+  "commands-show-output": true,
+  "emphasis-style": {
+    "style": "underscore"
+  },
+  "fenced-code-language": false,
+  "first-line-h1": {
+    "front_matter_title": "^\\s*title\\s*[:=]"
+  },
+  "header-increment": true,
+  "header-start-left": true,
+  "header-style": {
+    "style": "atx"
+  },
+  "hr-style": {
+    "style": "---"
+  },
+  "line-length": {
+    "code_block_line_length": 90,
+    "code_blocks": true,
+    "heading_line_length": 100,
+    "headings": true,
+    "line_length": 100,
+    "stern": true,
+    "tables": false
+  },
+  "list-indent": true,
+  "list-marker-space": true,
+  "no-alt-text": true,
+  "no-bare-urls": true,
+  "no-blanks-blockquote": true,
+  "no-duplicate-header": {
+    "siblings_only": true
+  },
+  "no-emphasis-as-header": true,
+  "no-empty-links": true,
+  "no-hard-tabs": true,
+  "no-inline-html": {
+    "allowed_elements": [
+      "a",
+      "br",
+      "code",
+      "kbd",
+      "li",
+      "properties",
+      "sup",
+      "tags",
+      "ul"
+    ]
+  },
+  "no-missing-space-atx": true,
+  "no-missing-space-closed-atx": true,
+  "no-multiple-blanks": true,
+  "no-multiple-space-atx": true,
+  "no-multiple-space-blockquote": true,
+  "no-multiple-space-closed-atx": true,
+  "no-reversed-links": true,
+  "no-space-in-code": true,
+  "no-space-in-emphasis": true,
+  "no-space-in-links": true,
+  "no-trailing-punctuation": {
+    "punctuation": ".,;:!。，；：！？"
+  },
+  "no-trailing-spaces": {
+    "br_spaces": 2,
+    "strict": true
+  },
+  "ol-prefix": {
+    "style": "one"
+  },
+  "proper-names": {
+    "code_blocks": false,
+    "names": [
+      "PowerShell",
+      "IntelliSense",
+      "Authenticode",
+      "CentOS",
+      "Contoso",
+      "CoreOS",
+      "Debian",
+      "Ubuntu",
+      "openSUSE",
+      "RHEL",
+      "JavaScript",
+      ".NET",
+      "NuGet",
+      "VS Code",
+      "Newtonsoft"
+    ]
+  },
+  "required-headers": false,
+  "single-h1": {
+    "front_matter_title": "",
+    "level": 1
+  },
+  "single-trailing-newline": true,
+  "strong-style": {
+    "style": "asterisk"
+  },
+  "ul-indent": {
+    "indent": 2,
+    "start_indented": false
+  },
+  "ul-start-left": true,
+  "ul-style": {
+    "style": "dash"
+  },
+  "link-fragments": true,
+  "reference-links-images": true,
+  "link-image-reference-definitions": true
+}
@@ -1 +1,5 @@
-# DSC-Samples
+# DSC-Samples
+
+This repository includes code samples for DSC v3.
+
+<!-- Todo: Actual readme -->
@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+