Skip to content

Commit f55e750

Browse files
(DOCS) Update for preview.9
This change updates the documentation for the `preview.9` release. In particular, it: - Adds reference documentation for the new `variables()` configuration function. - Removes the `url` sub-property from the `schema` property in the resource manifest schema documentation. - Adds a new example and syntax documentation to the configuration function overview to show how users can access object properties and array items in their configurations.
1 parent 7c41b69 commit f55e750

File tree

5 files changed

+456
-22
lines changed

5 files changed

+456
-22
lines changed

CHANGELOG.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.9].
136136

137137
- Added support for using variables in a configuration document. Prior to this release, variables
138138
could be defined in the document but not referenced from resource instances with a configuration
139-
function. This release includes the new `variables()` configuration function.
139+
function. This release includes the new `variables()` configuration function. For more
140+
information, see the [reference documentation][p9-01].
140141

141142
<details><summary>Related work items</summary>
142143

@@ -147,7 +148,9 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.9].
147148

148149
- Added support for indexing into arrays when using configuration functions. This enables users to
149150
access specific items in an array of values returned by a configuration function, such as whe
150-
referencing the output of a resource.
151+
referencing the output of a resource. For more information about configuration functions, see
152+
[DSC Configuration document functions reference][p9-02]. For a detailed example showing how to
153+
access items in an array, see [Example 4][p9-03].
151154

152155
<details><summary>Related work items</summary>
153156

@@ -200,7 +203,8 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.9].
200203

201204
</details>
202205

203-
- Added support for the [--what-if] to the `Microsoft.Windows/Registry` resource.
206+
- Added support for the [WhatIf capability][p9-04] to the `Microsoft.Windows/Registry` resource,
207+
improving the user experience when calling `dsc config set` with the [--what-if][p9-05] option.
204208

205209
<details><summary>Related work items</summary>
206210

@@ -296,6 +300,13 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.9].
296300

297301
</details>
298302

303+
<!-- Preview.9 links -->
304+
[p9-01]: docs/reference/schemas/config/functions/variables.md
305+
[p9-02]: docs/reference/schemas/config/functions/overview.md
306+
[p9-03]: docs/reference/schemas/config/functions/overview.md#example-4---access-object-properties-and-array-items
307+
[p9-04]: docs/reference/schemas/outputs/resource/list.md#capability-whatif
308+
[p9-05]: docs/reference/cli/config/set.md#-w---what-if
309+
299310
## [v3.0.0-preview.8][release-v3.0.0-preview.8] - 2024-06-19
300311

301312
This section includes a summary of changes for the `preview.8` release. For the full list of changes

0 commit comments

Comments
 (0)