Skip to content

Commit 48f2e06

Browse files
authored
Merge pull request #1019 from michaeltlombardi/docs/main/sync-back
(DOCS) Sync back minor fixes from docs publishing
2 parents c1f2eb9 + 162787d commit 48f2e06

File tree

5 files changed

+20
-11
lines changed

5 files changed

+20
-11
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,15 @@ changes since the last release, see the [diff on GitHub][unreleased].
7575
for the `v3.0.0.0-alpha.5` release. Leave the release links under the release section.
7676
-->
7777

78+
## [v3.1.0][release-v3.1.0] - 2025-06-18
79+
80+
This section includes a summary of changes for the `3.1.0` release. For the full list of changes
81+
in this release, see the [diff on GitHub][compare-v3.1.0].
82+
83+
<!-- Release links -->
84+
[release-v3.1.0]: https://github.com/PowerShell/DSC/releases/tag/v3.1.0 "Link to the DSC v3.1.0 release on GitHub"
85+
[compare-v3.1.0]: https://github.com/PowerShell/DSC/compare/v3.0.2...v3.1.0
86+
7887
### Added
7988

8089
- Added support for defining adapted resource instances in configuration documents without

docs/reference/cli/resource/test.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ Validates the actual state of a resource instance against a desired state.
1616
### Instance properties from input option
1717

1818
```sh
19-
dsc resource set --input <INPUT> --resource <RESOURCE>
19+
dsc resource test --input <INPUT> --resource <RESOURCE>
2020
```
2121

2222
### Instance properties from file
2323

2424
```sh
25-
dsc resource set --file <FILE> --resource <RESOURCE>
25+
dsc resource test --file <FILE> --resource <RESOURCE>
2626
```
2727

2828
### Instance properties from stdin
2929

3030
```sh
31-
cat <FILE> | dsc resource set [Options] --resource <RESOURCE> --file -
31+
cat <FILE> | dsc resource test [Options] --resource <RESOURCE> --file -
3232
```
3333

3434
## Description

docs/reference/schemas/config/parameter.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Parameters are defined as key-value pairs in the `parameters` property of a conf
2929
The key is the parameter's name, which is used to reference the parameter in the [resources][01]
3030
property of the configuration document. The value is an object that defines the parameter.
3131

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

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

4343
### description
4444

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

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

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

7474
Use secure strings for passwords and secrets.
7575

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

8585
### defaultValue
8686

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

9797
### allowedValues
9898

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

docs/reference/schemas/config/resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Pattern: ^\w+(\.\w+){0,2}\/\w+$
6969
### properties
7070

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

7575
<!-- For more information about instance schemas in DSC, see [DSC Resource instance schemas][aa]. -->

docs/reference/schemas/resource/properties/purge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: JSON schema reference for the '_purge' well-known DSC Resource property.
2+
description: JSON schema reference for the '_purge' canonical DSC Resource property.
33
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC Resource _purge property schema

0 commit comments

Comments
 (0)