Skip to content

Commit

Permalink
(DOCS) Update for preview.9
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
michaeltlombardi committed Aug 22, 2024
1 parent 7c41b69 commit f55e750
Show file tree
Hide file tree
Showing 5 changed files with 456 additions and 22 deletions.
17 changes: 14 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.9].

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

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

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

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

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

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

</details>

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

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

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

</details>

<!-- Preview.9 links -->
[p9-01]: docs/reference/schemas/config/functions/variables.md
[p9-02]: docs/reference/schemas/config/functions/overview.md
[p9-03]: docs/reference/schemas/config/functions/overview.md#example-4---access-object-properties-and-array-items
[p9-04]: docs/reference/schemas/outputs/resource/list.md#capability-whatif
[p9-05]: docs/reference/cli/config/set.md#-w---what-if

## [v3.0.0-preview.8][release-v3.0.0-preview.8] - 2024-06-19

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

0 comments on commit f55e750

Please sign in to comment.