Skip to content

(DOCS) Sync back minor fixes from docs publishing #1019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,15 @@ changes since the last release, see the [diff on GitHub][unreleased].
for the `v3.0.0.0-alpha.5` release. Leave the release links under the release section.
-->

## [v3.1.0][release-v3.1.0] - 2025-06-18

This section includes a summary of changes for the `3.1.0` release. For the full list of changes
in this release, see the [diff on GitHub][compare-v3.1.0].

<!-- Release links -->
[release-v3.1.0]: https://github.com/PowerShell/DSC/releases/tag/v3.1.0 "Link to the DSC v3.1.0 release on GitHub"
[compare-v3.1.0]: https://github.com/PowerShell/DSC/compare/v3.0.2...v3.1.0

### Added

- Added support for defining adapted resource instances in configuration documents without
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/cli/resource/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ Validates the actual state of a resource instance against a desired state.
### Instance properties from input option

```sh
dsc resource set --input <INPUT> --resource <RESOURCE>
dsc resource test --input <INPUT> --resource <RESOURCE>
```

### Instance properties from file

```sh
dsc resource set --file <FILE> --resource <RESOURCE>
dsc resource test --file <FILE> --resource <RESOURCE>
```

### Instance properties from stdin

```sh
cat <FILE> | dsc resource set [Options] --resource <RESOURCE> --file -
cat <FILE> | dsc resource test [Options] --resource <RESOURCE> --file -
```

## Description
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/schemas/config/parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Parameters are defined as key-value pairs in the `parameters` property of a conf
The key is the parameter's name, which is used to reference the parameter in the [resources][01]
property of the configuration document. The value is an object that defines the parameter.

Every parameter defines its data type. Parameters may also define a default value, validation
Every parameter defines its data type. Parameters can also define a default value, validation
checks, a description of their purpose, and arbitrary metadata.

To reference parameters in resource instances, use the [parameters() configuration function][02].
Expand All @@ -42,7 +42,7 @@ To reference parameters in resource instances, use the [parameters() configurati

### description

Parameters may define a short explanation of their purpose and usage with the `description`
Parameters can define a short explanation of their purpose and usage with the `description`
property. To define a longer explanation in YAML, use the folded block syntax or literal block
syntax.

Expand All @@ -68,8 +68,8 @@ data type for every passed parameter before executing a configuration operation.

The `secure*` data types indicate that DSC and integrating tools shouldn't log or record the
values. If a secure data type parameter is used for a resource instance property that doesn't
expect a secure value, the resource may still log or record the value. If the resource has
independent logging or recording that isn't handled by DSC, the value may be stored insecurely.
expect a secure value, the resource might still log or record the value. If the resource has
independent logging or recording that isn't handled by DSC, the value might be stored insecurely.

Use secure strings for passwords and secrets.

Expand All @@ -84,7 +84,7 @@ ValidValues: [string, securestring, int, bool, object, secureobject, array]

### defaultValue

Parameters may define a default value with the `defaultValue` property. If the parameter isn't
Parameters can define a default value with the `defaultValue` property. If the parameter isn't
passed at runtime, DSC uses the default value for the parameter. If the parameter isn't passed at
runtime and no default value is defined, DSC raises an error. The value must be valid for the
parameter's `type`.
Expand All @@ -96,7 +96,7 @@ ValidJSONTypes: [string, integer, object, array, boolean]

### allowedValues

Parameters may limit the set of valid values for the parameter by defining the `allowedValues`
Parameters can limit the set of valid values for the parameter by defining the `allowedValues`
property. DSC validates parameters passed at runtime and defined as `defaultValue` against this
list of values. If any of the values is invalid, DSC raises an error.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/schemas/config/resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Pattern: ^\w+(\.\w+){0,2}\/\w+$
### properties

The `properties` of a resource instance define its desired state. The value of this property must
be an object. For assertion resources, the value may be an empty object (`{}`). DSC uses the
be an object. For assertion resources, the value can be an empty object (`{}`). DSC uses the
DSC Resource's instance schema to validate the defined properties.

<!-- For more information about instance schemas in DSC, see [DSC Resource instance schemas][aa]. -->
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/schemas/resource/properties/purge.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: JSON schema reference for the '_purge' well-known DSC Resource property.
description: JSON schema reference for the '_purge' canonical DSC Resource property.
ms.date: 07/03/2025
ms.topic: reference
title: DSC Resource _purge property schema
Expand Down