Skip to content

Commit ae29420

Browse files
michaeltlombardiSteveL-MSFTmgreenegit
committed
Apply suggestions from review
Co-authored-by: Steve Lee <slee@microsoft.com> Co-authored-by: Michael Greene <mgreenegit@users.noreply.github.com>
1 parent a7c0a73 commit ae29420

File tree

5 files changed

+16
-15
lines changed

5 files changed

+16
-15
lines changed

docs/concepts/configuration-documents/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ When you use this command, DSC also:
152152
- Provides metadata about the operation as a whole and for each resource instance.
153153

154154
```sh
155-
dsc config test --file /example.config.dsc.yaml
155+
dsc config test --file ./example.config.dsc.yaml
156156
```
157157

158158
```yaml

docs/concepts/output-accessibility.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,6 @@ Invoke-Item .\myFile.csv
6262

6363
The `Invoke-Item` command opens the file in the default application for CSV files.
6464

65-
### HyperText Markup Language (HTML) format
66-
67-
HTML files can be viewed by web browsers such as **Microsoft Edge**. The following example shows
68-
how to save the output of a command to an HTML file.
69-
70-
```powershell
71-
dsc resource list | ConvertFrom-Json | ConvertTo-HTML | Out-File .\myFile.html
72-
Invoke-Item .\myFile.html
73-
```
74-
75-
The `Invoke-Item` command opens the file in your default web browser.
76-
7765
## Reduce the amount of output
7866

7967
One way to improve the accessibility of the output is to reduce the amount of output displayed in

docs/concepts/resources/anatomy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If the JSON file validates against the schema, DSC can use the DSC Resource.
3939

4040
At a minimum, the manifest must define:
4141

42-
- The version of the DSC resource manifest JSON schema it's compatible with.
42+
- The semantic version (semver) of the DSC resource manifest JSON schema it's compatible with.
4343
- The fully qualified name of the resource, like `Microsoft.Windows/Registry`. The fully qualified
4444
name syntax is `<owner>[.<group>][.<area>]/<name>`. The group and area components of the fully
4545
qualified name enable organizing resources into namespaces.

docs/concepts/resources/capabilities.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,17 @@ resource. DSC performs the synthetic test by:
7575

7676
1. Invoking the **Get** operation on the resource to retrieve the actual state of the instance.
7777
1. Synthetically testing each property for the desired state of an instance against the actual
78-
state returned. The synthetic test uses strict, case-sensitive equivalence.
78+
state returned. The synthetic test:
79+
80+
- Uses strict, case-sensitive equivalence for strings.
81+
- Uses simple equivalence for numerical, boolean, and null values.
82+
- For arrays, item order doesn't matter. Arrays are considered equivalent if both the desired
83+
state and actual state arrays have the same number of items and if each item in the desired
84+
state is contained in the actual state array.
85+
- For objects, property order doesn't matter. The actual state of the resource can be a superset
86+
of the desired state. Objects are considered equivalent if each specified property for the
87+
desired state is equal to the same property for the actual state. If an actual state property
88+
isn't defined in the desired state, DSC ignores that property for the synthetic test.
7989
1. If the desired state for a property and the actual state aren't the same, DSC marks the property
8090
as out of the desired state.
8191
1. If any properties are out of the desired state, DSC reports the entire instance as not being in

docs/concepts/resources/properties.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,9 @@ expectations. These reusable properties are called canonical resource properties
127127
Any resource that defines a canonical resource property in the instance schema must adhere to the
128128
requirements and behaviors defined for the canonical property.
129129

130+
Canonical properties always begin with an underscore (`_`). Non-canonical property names should
131+
never begin with an underscore. The leading underscore is reserved for canonical property names.
132+
130133
For more information about the available canonical properties, see
131134
[DSC canonical resource properties][02].
132135

0 commit comments

Comments
 (0)