From eaa6aceb335a8e595800c57e31242ceb17d0cfb5 Mon Sep 17 00:00:00 2001 From: Michael Lombardi Date: Wed, 17 Jan 2024 15:34:56 -0600 Subject: [PATCH] (MAINT) Backport fixes/updates from release docs sync --- docs/reference/cli/completer/command.md | 6 +++--- docs/reference/cli/config/get.md | 2 +- docs/reference/cli/config/set.md | 2 +- docs/reference/cli/config/test.md | 2 +- docs/reference/cli/dsc.md | 2 +- docs/reference/schemas/config/document.md | 2 +- docs/reference/schemas/config/functions/base64.md | 5 +++-- docs/reference/schemas/config/functions/concat.md | 2 +- docs/reference/schemas/config/functions/overview.md | 2 +- docs/reference/schemas/config/functions/resourceId.md | 2 +- docs/reference/schemas/config/parameter.md | 2 +- docs/reference/schemas/config/resource.md | 2 +- docs/reference/schemas/definitions/message.md | 2 +- docs/reference/schemas/definitions/parameters/dataTypes.md | 2 +- docs/reference/schemas/definitions/resourceType.md | 2 +- docs/reference/schemas/outputs/config/get.md | 2 +- docs/reference/schemas/outputs/config/set.md | 2 +- docs/reference/schemas/outputs/config/test.md | 2 +- docs/reference/schemas/outputs/resource/get.md | 2 +- docs/reference/schemas/outputs/resource/list.md | 2 +- docs/reference/schemas/outputs/resource/set.md | 2 +- docs/reference/schemas/outputs/resource/test.md | 2 +- docs/reference/schemas/resource/manifest/export.md | 4 ++-- docs/reference/schemas/resource/manifest/get.md | 2 +- docs/reference/schemas/resource/manifest/provider.md | 2 +- docs/reference/schemas/resource/manifest/root.md | 4 ++-- docs/reference/schemas/resource/manifest/schema/embedded.md | 2 +- docs/reference/schemas/resource/manifest/schema/property.md | 2 +- docs/reference/schemas/resource/manifest/set.md | 2 +- docs/reference/schemas/resource/manifest/test.md | 2 +- docs/reference/schemas/resource/manifest/validate.md | 2 +- docs/reference/schemas/resource/properties/ensure.md | 2 +- .../reference/schemas/resource/properties/inDesiredState.md | 2 +- docs/reference/schemas/resource/properties/overview.md | 2 +- docs/reference/schemas/resource/properties/purge.md | 2 +- .../schemas/resource/properties/rebootRequested.md | 2 +- 36 files changed, 42 insertions(+), 41 deletions(-) diff --git a/docs/reference/cli/completer/command.md b/docs/reference/cli/completer/command.md index 95a3a66d..84d2ce44 100644 --- a/docs/reference/cli/completer/command.md +++ b/docs/reference/cli/completer/command.md @@ -1,11 +1,11 @@ --- description: Command line reference for the 'dsc completer' command -ms.date: 10/05/2023 +ms.date: 01/17/2024 ms.topic: reference -title: dsc schema +title: dsc completer --- -# dsc schema +# dsc completer ## Synopsis diff --git a/docs/reference/cli/config/get.md b/docs/reference/cli/config/get.md index bbb36a19..36e4755e 100644 --- a/docs/reference/cli/config/get.md +++ b/docs/reference/cli/config/get.md @@ -1,6 +1,6 @@ --- description: Command line reference for the 'dsc config get' command -ms.date: 10/05/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc config get --- diff --git a/docs/reference/cli/config/set.md b/docs/reference/cli/config/set.md index 534a70fc..77e63d1c 100644 --- a/docs/reference/cli/config/set.md +++ b/docs/reference/cli/config/set.md @@ -1,6 +1,6 @@ --- description: Command line reference for the 'dsc config set' command -ms.date: 10/05/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc config set --- diff --git a/docs/reference/cli/config/test.md b/docs/reference/cli/config/test.md index eab4a314..995d6ebe 100644 --- a/docs/reference/cli/config/test.md +++ b/docs/reference/cli/config/test.md @@ -1,6 +1,6 @@ --- description: Command line reference for the 'dsc config test' command -ms.date: 10/05/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc config test --- diff --git a/docs/reference/cli/dsc.md b/docs/reference/cli/dsc.md index e08f4e69..8f0b6227 100644 --- a/docs/reference/cli/dsc.md +++ b/docs/reference/cli/dsc.md @@ -1,6 +1,6 @@ --- description: Command line reference for the 'dsc' command -ms.date: 10/05/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc --- diff --git a/docs/reference/schemas/config/document.md b/docs/reference/schemas/config/document.md index 98245a25..3665b2e0 100644 --- a/docs/reference/schemas/config/document.md +++ b/docs/reference/schemas/config/document.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a Desired State Configuration document. -ms.date: 11/15/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Configuration document schema reference --- diff --git a/docs/reference/schemas/config/functions/base64.md b/docs/reference/schemas/config/functions/base64.md index 3b061b59..573e0253 100644 --- a/docs/reference/schemas/config/functions/base64.md +++ b/docs/reference/schemas/config/functions/base64.md @@ -1,6 +1,6 @@ --- description: Reference for the 'base64' DSC configuration document function -ms.date: 11/15/2023 +ms.date: 01/17/2024 ms.topic: reference title: base64 --- @@ -56,7 +56,7 @@ hadErrors: false ### Example 2 - Convert a concatenated string to base64 -The configuration uses the [concat()] function inside the `base64()` function to combine the +The configuration uses the [concat()][02] function inside the `base64()` function to combine the strings `a`, `b`, and `c` into `abc` before returning the base64 representation. ```yaml @@ -108,3 +108,4 @@ Type: string [01]: https://en.wikipedia.org/wiki/Base64 +[02]: concat.md diff --git a/docs/reference/schemas/config/functions/concat.md b/docs/reference/schemas/config/functions/concat.md index f6f1df0f..82184801 100644 --- a/docs/reference/schemas/config/functions/concat.md +++ b/docs/reference/schemas/config/functions/concat.md @@ -1,6 +1,6 @@ --- description: Reference for the 'concat' DSC configuration document function -ms.date: 11/15/2023 +ms.date: 01/17/2024 ms.topic: reference title: concat --- diff --git a/docs/reference/schemas/config/functions/overview.md b/docs/reference/schemas/config/functions/overview.md index 5c4c0b71..5cd21875 100644 --- a/docs/reference/schemas/config/functions/overview.md +++ b/docs/reference/schemas/config/functions/overview.md @@ -1,6 +1,6 @@ --- description: Reference for available functions in a Desired State Configuration document. -ms.date: 11/15/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Configuration document functions reference --- diff --git a/docs/reference/schemas/config/functions/resourceId.md b/docs/reference/schemas/config/functions/resourceId.md index 647cedd3..3e16fa76 100644 --- a/docs/reference/schemas/config/functions/resourceId.md +++ b/docs/reference/schemas/config/functions/resourceId.md @@ -1,6 +1,6 @@ --- description: Reference for the 'resourceId' DSC configuration document function -ms.date: 11/15/2023 +ms.date: 01/17/2024 ms.topic: reference title: resourceId --- diff --git a/docs/reference/schemas/config/parameter.md b/docs/reference/schemas/config/parameter.md index 9f3ac388..50f78f02 100644 --- a/docs/reference/schemas/config/parameter.md +++ b/docs/reference/schemas/config/parameter.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a parameter in a Desired State Configuration document. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Configuration document parameter schema --- diff --git a/docs/reference/schemas/config/resource.md b/docs/reference/schemas/config/resource.md index c8a809d5..cf010204 100644 --- a/docs/reference/schemas/config/resource.md +++ b/docs/reference/schemas/config/resource.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a resource instance in a Desired State Configuration document. -ms.date: 11/15/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Configuration document resource instance schema --- diff --git a/docs/reference/schemas/definitions/message.md b/docs/reference/schemas/definitions/message.md index 7034f408..77c38470 100644 --- a/docs/reference/schemas/definitions/message.md +++ b/docs/reference/schemas/definitions/message.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a structured message returned from a 'dsc config' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: Structured message schema reference --- diff --git a/docs/reference/schemas/definitions/parameters/dataTypes.md b/docs/reference/schemas/definitions/parameters/dataTypes.md index 2e67e9e5..6654bd89 100644 --- a/docs/reference/schemas/definitions/parameters/dataTypes.md +++ b/docs/reference/schemas/definitions/parameters/dataTypes.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for valid parameter data types in a configuration document. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC configuration parameter data type schema reference --- diff --git a/docs/reference/schemas/definitions/resourceType.md b/docs/reference/schemas/definitions/resourceType.md index 7590358d..bb285bd6 100644 --- a/docs/reference/schemas/definitions/resourceType.md +++ b/docs/reference/schemas/definitions/resourceType.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a resource instance type name -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource fully qualified type name schema reference --- diff --git a/docs/reference/schemas/outputs/config/get.md b/docs/reference/schemas/outputs/config/get.md index 90ccdb60..f605cb0e 100644 --- a/docs/reference/schemas/outputs/config/get.md +++ b/docs/reference/schemas/outputs/config/get.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc config get' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc config get result schema reference --- diff --git a/docs/reference/schemas/outputs/config/set.md b/docs/reference/schemas/outputs/config/set.md index e584be26..81b9effc 100644 --- a/docs/reference/schemas/outputs/config/set.md +++ b/docs/reference/schemas/outputs/config/set.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc config set' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc config set result schema reference --- diff --git a/docs/reference/schemas/outputs/config/test.md b/docs/reference/schemas/outputs/config/test.md index cf520045..0faa28e9 100644 --- a/docs/reference/schemas/outputs/config/test.md +++ b/docs/reference/schemas/outputs/config/test.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc config test' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc config test result schema reference --- diff --git a/docs/reference/schemas/outputs/resource/get.md b/docs/reference/schemas/outputs/resource/get.md index a43672a7..552d49b4 100644 --- a/docs/reference/schemas/outputs/resource/get.md +++ b/docs/reference/schemas/outputs/resource/get.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource get' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc resource get result schema reference --- diff --git a/docs/reference/schemas/outputs/resource/list.md b/docs/reference/schemas/outputs/resource/list.md index 69cf5853..984b9935 100644 --- a/docs/reference/schemas/outputs/resource/list.md +++ b/docs/reference/schemas/outputs/resource/list.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource list' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc resource list result schema reference --- diff --git a/docs/reference/schemas/outputs/resource/set.md b/docs/reference/schemas/outputs/resource/set.md index e11e2fe9..c7ab0cf8 100644 --- a/docs/reference/schemas/outputs/resource/set.md +++ b/docs/reference/schemas/outputs/resource/set.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource set' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc resource set result schema reference --- diff --git a/docs/reference/schemas/outputs/resource/test.md b/docs/reference/schemas/outputs/resource/test.md index a86fb2eb..4df67392 100644 --- a/docs/reference/schemas/outputs/resource/test.md +++ b/docs/reference/schemas/outputs/resource/test.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the data returned by the 'dsc resource test' command. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: dsc resource test result schema reference --- diff --git a/docs/reference/schemas/resource/manifest/export.md b/docs/reference/schemas/resource/manifest/export.md index 92aea4eb..004e65e5 100644 --- a/docs/reference/schemas/resource/manifest/export.md +++ b/docs/reference/schemas/resource/manifest/export.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'export' property in a DSC Resource manifest -ms.date: 09/06/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest export property schema reference --- @@ -70,6 +70,6 @@ Default: [] [01]: ../../../cli/config/export.md [02]: ../../../cli/resource/export.md [03]: ../../../cli/resource/get.md -[04]: ../../../cli/resource/get.md#a---all +[04]: ../../../cli/resource/get.md#-a---all [05]: https://jsonlines.org/ [06]: schema/property.md diff --git a/docs/reference/schemas/resource/manifest/get.md b/docs/reference/schemas/resource/manifest/get.md index 24b5e163..857b41ba 100644 --- a/docs/reference/schemas/resource/manifest/get.md +++ b/docs/reference/schemas/resource/manifest/get.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'get' property in a DSC Resource manifest -ms.date: 09/27/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest get property schema reference --- diff --git a/docs/reference/schemas/resource/manifest/provider.md b/docs/reference/schemas/resource/manifest/provider.md index 5fb7f300..e3134e4c 100644 --- a/docs/reference/schemas/resource/manifest/provider.md +++ b/docs/reference/schemas/resource/manifest/provider.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'provider' property in a DSC Resource manifest -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest provider property schema reference --- diff --git a/docs/reference/schemas/resource/manifest/root.md b/docs/reference/schemas/resource/manifest/root.md index f0c54865..95c5c16b 100644 --- a/docs/reference/schemas/resource/manifest/root.md +++ b/docs/reference/schemas/resource/manifest/root.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for a DSC Resource manifest -ms.date: 09/27/2023 +ms.date: 01/17/2024 ms.topic: reference title: Command-based DSC Resource manifest schema reference --- @@ -260,7 +260,7 @@ Required: true [02]: ../../../cli/config/export.md [03]: ../../../cli/resource/export.md [04]: ../../../cli/resource/get.md -[05]: ../../../cli/resource/get.md#a---all +[05]: ../../../cli/resource/get.md#-a---all [06]: export.md [07]: get.md [08]: set.md diff --git a/docs/reference/schemas/resource/manifest/schema/embedded.md b/docs/reference/schemas/resource/manifest/schema/embedded.md index 843e2b69..48d03d1b 100644 --- a/docs/reference/schemas/resource/manifest/schema/embedded.md +++ b/docs/reference/schemas/resource/manifest/schema/embedded.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the embedded instance schema in a DSC Resource manifest -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest embedded schema reference --- diff --git a/docs/reference/schemas/resource/manifest/schema/property.md b/docs/reference/schemas/resource/manifest/schema/property.md index 7b3df680..3bcbbd8f 100644 --- a/docs/reference/schemas/resource/manifest/schema/property.md +++ b/docs/reference/schemas/resource/manifest/schema/property.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'schema' property in a DSC Resource manifest -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest schema property schema reference --- diff --git a/docs/reference/schemas/resource/manifest/set.md b/docs/reference/schemas/resource/manifest/set.md index 3187041b..6977734c 100644 --- a/docs/reference/schemas/resource/manifest/set.md +++ b/docs/reference/schemas/resource/manifest/set.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'set' property in a DSC Resource manifest -ms.date: 09/27/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest set property schema reference --- diff --git a/docs/reference/schemas/resource/manifest/test.md b/docs/reference/schemas/resource/manifest/test.md index 4faa467e..e2f7dc9f 100644 --- a/docs/reference/schemas/resource/manifest/test.md +++ b/docs/reference/schemas/resource/manifest/test.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'test' property in a DSC Resource manifest -ms.date: 09/27/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest test property schema reference --- diff --git a/docs/reference/schemas/resource/manifest/validate.md b/docs/reference/schemas/resource/manifest/validate.md index 65592cd1..c1824704 100644 --- a/docs/reference/schemas/resource/manifest/validate.md +++ b/docs/reference/schemas/resource/manifest/validate.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the 'validate' property in a DSC Resource manifest -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource manifest validate property schema reference --- diff --git a/docs/reference/schemas/resource/properties/ensure.md b/docs/reference/schemas/resource/properties/ensure.md index d98b67ff..97085e75 100644 --- a/docs/reference/schemas/resource/properties/ensure.md +++ b/docs/reference/schemas/resource/properties/ensure.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_ensure' well-known DSC Resource property. -ms.date: 10/05/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource _ensure property schema --- diff --git a/docs/reference/schemas/resource/properties/inDesiredState.md b/docs/reference/schemas/resource/properties/inDesiredState.md index 27c610e5..a32f29dc 100644 --- a/docs/reference/schemas/resource/properties/inDesiredState.md +++ b/docs/reference/schemas/resource/properties/inDesiredState.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_inDesiredState' well-known DSC Resource property. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource _inDesiredState property schema --- diff --git a/docs/reference/schemas/resource/properties/overview.md b/docs/reference/schemas/resource/properties/overview.md index 353476c3..2c023222 100644 --- a/docs/reference/schemas/resource/properties/overview.md +++ b/docs/reference/schemas/resource/properties/overview.md @@ -2,7 +2,7 @@ description: >- Information about the list of well-known DSC Resource properties, including their purpose and how to add them to a resource's manifest. -ms.date: 10/05/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC well-known properties --- diff --git a/docs/reference/schemas/resource/properties/purge.md b/docs/reference/schemas/resource/properties/purge.md index a8ba9bd7..16249795 100644 --- a/docs/reference/schemas/resource/properties/purge.md +++ b/docs/reference/schemas/resource/properties/purge.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_purge' well-known DSC Resource property. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource _purge property schema --- diff --git a/docs/reference/schemas/resource/properties/rebootRequested.md b/docs/reference/schemas/resource/properties/rebootRequested.md index f4eb4d9e..fd6f1394 100644 --- a/docs/reference/schemas/resource/properties/rebootRequested.md +++ b/docs/reference/schemas/resource/properties/rebootRequested.md @@ -1,6 +1,6 @@ --- description: JSON schema reference for the '_rebootRequested' well-known DSC Resource property. -ms.date: 08/04/2023 +ms.date: 01/17/2024 ms.topic: reference title: DSC Resource _rebootRequested property schema ---