diff --git a/docs/concepts/resources/authoring/adapter/resource-manifest.md b/docs/concepts/resources/authoring/adapter/resource-manifest.md new file mode 100644 index 000000000..f77048a74 --- /dev/null +++ b/docs/concepts/resources/authoring/adapter/resource-manifest.md @@ -0,0 +1,78 @@ +--- +description: >- + Considerations and guidance for authoring the document that defines an adapter resource. +ms.date: 08/15/2025 +title: Authoring a DSC adapter resource manifest +--- + +# Authoring a DSC adapter resource manifest + + + +## Defining the initial manifest + + + +## Defining operations + + + +### Defining validate + + + +### Defining get + + + +### Defining set + + + +### Defining whatIf + + + +### Defining test + + + +### Defining export + + + +### Defining delete + + + +## Defining exit codes + + + +## Best practices + + diff --git a/docs/concepts/resources/authoring/emitting-messages.md b/docs/concepts/resources/authoring/emitting-messages.md new file mode 100644 index 000000000..2993773d2 --- /dev/null +++ b/docs/concepts/resources/authoring/emitting-messages.md @@ -0,0 +1,30 @@ +--- +description: >- + Considerations and guidance for emitting messages from a DSC resource. +ms.date: 08/15/2025 +title: Emitting messages from a DSC resource +--- + +# Emitting messages from a DSC resource + + + +## Emitting trace messages + + + +## Emitting debug messages + + + +## Emitting info messages + + + +## Emitting warning messages + + + +## Emitting error messages + + diff --git a/docs/concepts/resources/authoring/exit-codes.md b/docs/concepts/resources/authoring/exit-codes.md new file mode 100644 index 000000000..609ddc2c1 --- /dev/null +++ b/docs/concepts/resources/authoring/exit-codes.md @@ -0,0 +1,18 @@ +--- +description: >- + Considerations and guidance for defining exit codes for a resource. +ms.date: 08/15/2025 +title: Defining exit codes for a DSC resource +--- + +# Defining exit codes for a DSC resource + + + +## Minimal exit codes + + + +## Defining useful exit codes + + diff --git a/docs/concepts/resources/authoring/exporter/resource-manifest.md b/docs/concepts/resources/authoring/exporter/resource-manifest.md new file mode 100644 index 000000000..4364610d0 --- /dev/null +++ b/docs/concepts/resources/authoring/exporter/resource-manifest.md @@ -0,0 +1,42 @@ +--- +description: >- + Considerations and guidance for authoring the document that defines an exporter resource. +ms.date: 08/15/2025 +title: Authoring a DSC exporter resource manifest +--- + +# Authoring a DSC exporter resource manifest + + + +## Defining the initial manifest + + + +## Defining operations + + + +### Defining export + + + +## Defining exit codes + + + +## Best practices + + diff --git a/docs/concepts/resources/authoring/index.md b/docs/concepts/resources/authoring/index.md new file mode 100644 index 000000000..dc854280c --- /dev/null +++ b/docs/concepts/resources/authoring/index.md @@ -0,0 +1,36 @@ +--- +description: >- + Overview of the process and considerations for authoring a DSC resource. +ms.date: 03/25/2025 +title: Authoring a DSC resource +--- + +# Authoring a DSC resource + + + +## Choosing a resource kind + + + +## Defining resource metadata + + + +## Defining exit codes + + + +## Resource messaging + + diff --git a/docs/concepts/resources/authoring/toc.yml b/docs/concepts/resources/authoring/toc.yml new file mode 100644 index 000000000..6eb013276 --- /dev/null +++ b/docs/concepts/resources/authoring/toc.yml @@ -0,0 +1,22 @@ +items: + - name: Overview + href: index.md + - name: Typical resources + items: + - name: Resource manifest + href: typical/resource-manifest.md + - name: Resource instance schema + href: typical/resource-instance-schema.md + - name: Adapter resources + items: + - name: Resource manifest + href: adapter/resource-manifest.md + - name: Exporter resources + items: + - name: Resource manifest + href: exporter/resource-manifest.md + - name: Emitting messages + href: emitting-messages.md + - name: Defining exit codes + href: exit-codes.md + - diff --git a/docs/concepts/resources/authoring/typical/resource-instance-schema.md b/docs/concepts/resources/authoring/typical/resource-instance-schema.md new file mode 100644 index 000000000..c592b9e47 --- /dev/null +++ b/docs/concepts/resources/authoring/typical/resource-instance-schema.md @@ -0,0 +1,50 @@ +--- +description: >- + Considerations and guidance for defining the JSON Schema that represents an instance of a typical + DSC resource. +ms.date: 08/15/2025 +title: Authoring a typical DSC resource instance JSON Schema +--- + +# Authoring a DSC resource instance JSON Schema + + + +## Defining the initial schema + + + +## Handling whether an instance exists + + + +## Defining configurable properties + + + +## Defining read-only properties + + + +## Defining write-only properties + + + +## Handling complex schemas + + + +## Best practices + + \ No newline at end of file diff --git a/docs/concepts/resources/authoring/typical/resource-manifest.md b/docs/concepts/resources/authoring/typical/resource-manifest.md new file mode 100644 index 000000000..c34f234dd --- /dev/null +++ b/docs/concepts/resources/authoring/typical/resource-manifest.md @@ -0,0 +1,72 @@ +--- +description: >- + Considerations and guidance for defining the document that defines a typical DSC resource. +ms.date: 08/15/2025 +title: Authoring a typical DSC resource manifest +--- + +# Authoring a typical DSC resource manifest + + + +## Defining the initial manifest + + + +## Defining operations + + + +### Defining get + + + +### Defining set + + + +### Defining whatIf + + + +### Defining test + + + +### Defining export + + + +### Defining delete + + + +## Defining exit codes + + + +## Best practices + +