Skip to content

Commit 513195c

Browse files
(DOCS) Address editorial feedback
1 parent 1cf1990 commit 513195c

File tree

4 files changed

+18
-12
lines changed

4 files changed

+18
-12
lines changed

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,8 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.7].
265265
metadata property under the `Microsoft.DSC` namespace in a configuration document to specify
266266
which security context to use:
267267

268-
- `Current` - Any security context.
268+
- `Current` - Any security context. This is the default if you don't specify this property in a
269+
configuration document.
269270
- `Elevated` - Elevated as root or an administrator.
270271
- `Restricted` - Not elevated as root or an administrator.
271272

@@ -506,8 +507,8 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.7].
506507
</details>
507508

508509
- Added the `Microsoft.DSC.Transitional/RunCommandOnSet` resource, which runs a specified
509-
executable with given arguments during a `set` operation. This resource is intended as a
510-
temporary transitional resource while migrating to DSCv3 and implementing resources for your
510+
executable or script with given arguments during a `set` operation. This resource is intended as
511+
a temporary transitional resource while migrating to DSCv3 and implementing resources for your
511512
needs.
512513

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

docs/reference/cli/resource/delete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ command as a JSON or YAML object. The object can be passed to this command from
4646
`--input` option. You can also use the `--path` option to read the object from a JSON or YAML file.
4747

4848
This command returns no output when successful. If it encounters an error, it surfaces the error to
49-
the caller on stderr.
49+
the caller on stderr and exits with a non-zero exit code.
5050

5151
## Examples
5252

@@ -155,4 +155,4 @@ Mandatory: false
155155
## Output
156156

157157
This command returns no output when successful. When the resource errors, DSC surfaces the error on
158-
stderr.
158+
stderr and exits with a non-zero exit code.

docs/reference/schemas/config/metadata.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ Type: object
2222
## Description
2323
2424
Defines a set of informational key-value pairs for the configuration. Except for the
25-
`Microsoft.DSC` property, this metadata isn't validated. You can pass any data into your configuration as a property of `metadata`.
25+
`Microsoft.DSC` property, this metadata isn't validated. You can pass any data into your
26+
configuration as a property of `metadata`.
2627

27-
For example, you could define information about the configuration used by your teams or internal tools:
28+
For example, you could define information about the configuration used by your teams or internal
29+
tools:
2830

2931
```yaml
3032
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/bundled/config/document.vscode.json
@@ -40,7 +42,7 @@ metadata:
4042

4143
The `Microsoft.DSC` metadata property contains directives and information that DSC itself uses when
4244
processing a configuration document. Unlike other metadata key-value pairs, DSC validates these
43-
properties.
45+
properties. This property is reserved and shouldn't contain any custom user-defined metadata.
4446

4547
### Properties
4648

docs/reference/schemas/definitions/resourceKind.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Group resources always operate on nested DSC Resource instances. Group resources
5555
nested instances are processed, like the `Microsoft.DSC/Assertion` group resource.
5656

5757
Group resources can also be used to bundle sets of resources together for processing, like the
58-
`Microsoft.DSC/Group` resource. You can use the [dependsOn][03] property for a resource instance in a
59-
configuration to point to a group resource instead of enumerating each resource in the list.
58+
`Microsoft.DSC/Group` resource. You can use the [dependsOn][03] property for a resource instance in
59+
a configuration to point to a group resource instead of enumerating each resource in the list.
6060

6161
### Nested resource instances
6262

@@ -137,12 +137,14 @@ This example configuration defines several valid references and dependencies. It
137137
instances of the `Microsoft.DSC/Group` resource, one nested inside the other.
138138

139139
The top level instance of the `Test/Echo` resource references and depends on the top-level instance
140-
of the `Microsoft/OSInfo` resource. The top-level instance of the `Microsoft/OSInfo` resource
141-
depends on the top-level instance of the `Microsoft.DSC/Group` resource.
140+
of the `Microsoft/OSInfo` resource. The top-level instances of the `Test/Echo` and
141+
`Microsoft/OSInfo` resources both depend on the top-level instance of the `Microsoft.DSC/Group`
142+
resource.
142143

143144
```yaml
144145
resources:
145146
# The top level echo references and depends on the top-level OSInfo.
147+
# It also depends on the top-level Group.
146148
- name: Top level echo
147149
type: Test/Echo
148150
properties:
@@ -152,6 +154,7 @@ resources:
152154
).actualState]
153155
dependsOn:
154156
- "[resourceId('Microsoft/OSInfo', 'Top level OSInfo')]"
157+
- "[resourceId('Microsoft.DSC/Group', 'Top level group')]"
155158
# The top level OSInfo depends on the top-level Group.
156159
- name: Top level OSInfo
157160
type: Microsoft/OSInfo

0 commit comments

Comments
 (0)