Skip to content

Commit 1ce6d48

Browse files
Apply suggestions from review
Co-authored-by: Sean Wheeler <[email protected]>
1 parent 8d2a432 commit 1ce6d48

File tree

4 files changed

+11
-12
lines changed

4 files changed

+11
-12
lines changed

dsc/docs-conceptual/dsc-3.0/concepts/configurations.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ desired state of a system as data files. Configuration documents define a collec
1616
[DSC resource][01] instances to describe what the desired state should be, not how to put the
1717
system into that state. The DSC resources handle the _how_ for each instance.
1818

19-
DSC can process configuration documents to:
19+
DSC processes configuration documents to:
2020

2121
- Retrieve the current state of the defined resource instances with the `dsc config get` command.
2222
- Validate whether the instances are in the desired state with the `dsc config test` command.
@@ -30,11 +30,10 @@ properties define how DSC processes the document. The top-level properties for a
3030
- `$schema` (required) - Defines the URI for the JSON Schema the document adheres to. DSC
3131
uses this to know how to validate and interpret the document.
3232
- `resources` (required) - Defines the collection of resource instances the document manages.
33-
- `metadata` (optional) - Defines an arbitrary set of annotations for the document. Except for
34-
metadata within the `Microsoft.DSC` property, DSC doesn't validate this data or use it directly.
35-
The annotations can include notes like who authored the document, the last time someone updated
36-
it, or any other information. DSC doesn't use the annotations. The metadata is for documentation
37-
or other tools to use.
33+
- `metadata` (optional) - Defines an arbitrary set of annotations for the document. The annotations
34+
can include notes like who authored the document, the last time someone updated it, or any other
35+
information. With one exception, DSC doesn't use the annotations. The metadata is for
36+
documentation or other tools to use.
3837

3938
DSC applies validation to the `Microsoft.DSC` property. For more information, see the
4039
[DSC Configuration document metadata schema][02] reference.

dsc/docs-conceptual/dsc-3.0/concepts/enhanced-authoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ specific workspace.
162162
```json
163163
"json.schemas": [
164164
{
165-
"fileMatch": ["**/*.dsc.resource.json", ],
165+
"fileMatch": ["**/*.dsc.resource.json"],
166166
"url": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.vscode.json"
167167
}
168168
]

dsc/docs-conceptual/dsc-3.0/concepts/resources.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,22 +75,22 @@ Most properties are one of the basic types:
7575
Complex properties require the property value to be an object with defined subproperties. The
7676
subproperties can be basic or complex, but they're usually a basic type.
7777

78-
Resources may define their properties as read-only or write-only:
78+
Resources can define their properties as read-only or write-only:
7979

8080
- A _read-only resource property_ defines metadata about an instance that the resource can retrieve
8181
but that a user can't directly set. You can't specify read-only properties in the desired state
8282
for an instance. Examples of read-only properties include the last time a file was modified or
8383
the author of an installed software package.
8484
- A _write-only resource property_ defines a value that the resource uses during a resource
85-
operation but which can't be returned for the current state of an instance. Examples of
85+
operation that can't be returned for the current state of an instance. Examples of
8686
write-only properties include credentials used to authenticate during a resource operation and
8787
the temporary directory to use when retrieving and unpacking a remote archive.
8888

89-
DSC defines a set of _canonical resource properties_ which indicate that a resource participates in
89+
DSC defines a set of _canonical resource properties_, which indicate that a resource participates in
9090
shared semantics the DSC engine provides. For example, any resource that includes the `_exist`
9191
canonical property in its instance schema indicates that the resource manages instances that can be
9292
created and deleted. If a resource has the `_exist` canonical property and the `delete` capability,
93-
DSC can handle invoking the **Delete** operation instead of **Set** when the desired state
93+
DSC can invoke the **Delete** operation instead of **Set** when the desired state
9494
indicates the instance shouldn't exist. For more information about the available canonical
9595
properties, see [DSC canonical properties](../reference/schemas/resource/properties/overview.md).
9696

dsc/docs-conceptual/dsc-3.0/resources/concepts/anatomy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ At a minimum, the manifest must define:
4444
- A command to validate nested DSC Resources. This last option only applies to DSC group
4545
resources and DSC adapter resources.
4646

47-
The manifest may define:
47+
The manifest can define:
4848

4949
- The kind of resource the manifest describes: `adapter`, `group`, `importer`, or `resource`.
5050

0 commit comments

Comments
 (0)