Skip to content

Commit

Permalink
(DOCS) Address editorial feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeltlombardi committed May 9, 2024
1 parent 1cf1990 commit 513195c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 12 deletions.
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,8 @@ in this release, see the [diff on GitHub][compare-v3.0.0-preview.7].
metadata property under the `Microsoft.DSC` namespace in a configuration document to specify
which security context to use:

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

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

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

<details><summary>Related work items</summary>
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli/resource/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ command as a JSON or YAML object. The object can be passed to this command from
`--input` option. You can also use the `--path` option to read the object from a JSON or YAML file.

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

## Examples

Expand Down Expand Up @@ -155,4 +155,4 @@ Mandatory: false
## Output

This command returns no output when successful. When the resource errors, DSC surfaces the error on
stderr.
stderr and exits with a non-zero exit code.
8 changes: 5 additions & 3 deletions docs/reference/schemas/config/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ Type: object
## Description
Defines a set of informational key-value pairs for the configuration. Except for the
`Microsoft.DSC` property, this metadata isn't validated. You can pass any data into your configuration as a property of `metadata`.
`Microsoft.DSC` property, this metadata isn't validated. You can pass any data into your
configuration as a property of `metadata`.

For example, you could define information about the configuration used by your teams or internal tools:
For example, you could define information about the configuration used by your teams or internal
tools:

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

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

### Properties

Expand Down
11 changes: 7 additions & 4 deletions docs/reference/schemas/definitions/resourceKind.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ Group resources always operate on nested DSC Resource instances. Group resources
nested instances are processed, like the `Microsoft.DSC/Assertion` group resource.

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

### Nested resource instances

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

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

```yaml
resources:
# The top level echo references and depends on the top-level OSInfo.
# It also depends on the top-level Group.
- name: Top level echo
type: Test/Echo
properties:
Expand All @@ -152,6 +154,7 @@ resources:
).actualState]
dependsOn:
- "[resourceId('Microsoft/OSInfo', 'Top level OSInfo')]"
- "[resourceId('Microsoft.DSC/Group', 'Top level group')]"
# The top level OSInfo depends on the top-level Group.
- name: Top level OSInfo
type: Microsoft/OSInfo
Expand Down

0 comments on commit 513195c

Please sign in to comment.