Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/concepts/resources/anatomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If the JSON file validates against the schema, DSC can use the DSC Resource.

At a minimum, the manifest must define:

- The semantic version (semver) of the DSC resource manifest JSON schema it's compatible with.
- The semantic version (SemVer) of the DSC resource manifest JSON schema it's compatible with.
- The fully qualified name of the resource, like `Microsoft.Windows/Registry`. The fully qualified
name syntax is `<owner>[.<group>][.<area>]/<name>`. The group and area components of the fully
qualified name enable organizing resources into namespaces.
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/resources/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Every resource implements the **Get** operation, which retrieves the actual stat
instance. Use the `dsc resource get` command to invoke the operation.

For example, you can use the `Microsoft.Windows/Registry` resource to get the actual state for a
registry key value:
registry key-value:

```powershell
dsc resource get --resource Microsoft.Windows/Registry --input '{
Expand Down
6 changes: 3 additions & 3 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -427,13 +427,13 @@ subject matter experts.

### `dsc`

The DSC command line tool that invokes resources and manages configuration documents.
The DSC command-line tool that invokes resources and manages configuration documents.

#### Guidelines

- Specify the term as DSC when discussing the command line tool in general.
- Specify the term as DSC when discussing the command-line tool in general.
- Use code formatting when discussing running the command, a specific subcommand, or to distinguish
the command line tool from the conceptual platform.
the command-line tool from the conceptual platform.

#### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ DSC differs from PowerShell Desired State Configuration (PSDSC) in a few importa
PSDSC resources in Windows PowerShell. The resource is included in the DSC install packages for
Windows only.
- Because DSC doesn't depend on PowerShell, you can use DSC without PowerShell installed and manage
resources written in bash, Python, C#, Rust, or any other language.
resources written in Bash, Python, C#, Rust, or any other language.
- DSC doesn't include a local configuration manager. DSC is invoked as a command. It doesn't
run as a service.
- New DSC resources define their schemas with JSON or YAML files, not MOF files. Self-contained
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The data file must contain an object with the `parameters` key. The value of the
must be an object where each key is the name of a defined parameter and each value is a valid value
for that parameter.

This option is mutually exclusive with the `--parameters` option.
This option can be used with the `--parameters` option, where parameters specified with `--parameters` will take precedence over `--parameters-file`.

Starting with DSC version 3.1.0, you can pass the parameters data to a subcommand over stdin. When
you do, you must pass the configuration document as an input string or the path to a file on the
Expand Down Expand Up @@ -108,7 +108,7 @@ The data string must contain an object with the `parameters` key. The value of t
must be an object where each key is the name of a defined parameter and each value is a valid value
for that parameter.

This option is mutually exclusive with the `--parameters_file` option.
This option can be used with the `--parameters-file` option, where parameters specified with `--parameters` will take precedence over `--parameters-file`.

For more information about defining parameters in a configuration document, see
[DSC Configuration document parameter schema][06]. For more information about using parameters in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Install a package with Brew
# Install a package with Brew

This example demonstrates how to use the `DSC.PackageManagement/Brew` resource to install a package
on MacOS systems using Brew.
on macOS systems using Brew.

## Test if package is installed

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Remove a package with Brew
# Remove a package with Brew

This example demonstrates how to use the `DSC.PackageManagement/Brew` resource to remove a package
on MacOS systems using Brew.
on macOS systems using Brew.

## Test if package is installed

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ resources:

## Setup

This example installs the WinGet software packages for the Windows Terminal and VS Code. The output
in this example shows the behavior when these packages aren't already installed on the system.
This example installs the WinGet software packages for the Windows Terminal and Visual Studio Code.
The output in this example shows the behavior when these packages aren't already installed on the
system.

This example depends on the **Microsoft.WinGet.DSC** PowerShell module at version `1.12.440`. To
install the module, open a PowerShell session and invoke the following command:
Expand Down Expand Up @@ -230,5 +231,5 @@ dsc config --parameters $params set --file dev-tools.dsc.yaml
```

<!-- Link references -->
[01]: ../../../../../../cli/config/test.md
[02]: ../../../../../../cli/config/set.md
[01]: ../../../../../cli/config/test.md
[02]: ../../../../../cli/config/set.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@ failure.
[04]: /powershell/scripting/install/installing-powershell
[05]: examples/invoke-a-resource.md
[06]: examples/configure-a-machine.md
[07]: ../../../../concepts/type-names.md
[07]: ../../../../schemas/definitions/resourceType.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ changedProperties: []
- [Microsoft.DSC.Debug/Echo resource](../index.md)

<!-- Link reference definitions -->
[01]: ../../../../../cli/resource/test.md
[01]: ../../../../../../cli/resource/test.md
8 changes: 4 additions & 4 deletions docs/reference/resources/Microsoft/DSC/Debug/echo/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ non validating keywords are omitted.
- [DSC resource capabilities][01]

<!-- Link definitions -->
[01]: ../../../../../concepts/resources/capabilities.md
[02]: ../../../../../concepts/resources/properties.md#required-resource-properties
[03]: ../../../../../concepts/resources/properties.md#key-resource-properties
[04]: ../../osinfo/index.md
[01]: ../../../../../../concepts/resources/capabilities.md
[02]: ../../../../../../concepts/resources/properties.md#required-resource-properties
[03]: ../../../../../../concepts/resources/properties.md#key-resource-properties
[04]: ../../../../Microsoft/OSInfo/index.md
8 changes: 4 additions & 4 deletions docs/reference/resources/Microsoft/DSC/PowerShell/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,10 @@ The resource uses the following exit codes to report success and errors:

## See also

- [Microsoft.Windows/WindowsPowerShell](../../windows/windowspowershell/resource.md)
- [Microsoft.Windows/WindowsPowerShell](../../../Microsoft/Windows/WindowsPowerShell/index.md)

<!-- Link references -->
[01]: ../../../concepts/resources.md#test-operations
[02]: examples/validate-with-dsc-resource.md
[03]: examples/validate-in-a-configuration.md
[01]: ../../../../schemas/definitions/resourceType.md
[02]: ./examples/invoke-a-resource.md
[03]: ./examples/configure-a-machine.md
[04]: cli/osinfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,8 @@ to the PowerShell scripts or when the input data is in an unexpected format.
- [Microsoft.Windows.WindowsPowerShell][05]

<!-- Link definitions -->
[00]: ../../../../concepts/dsc/resource-capabilities.md
[01]: ./examples/run-simple-powershell-script.md
[00]: ../../../../../../concepts/resources/capabilities.md
[01]: ./examples/run-a-simple-powershell-script.md
[02]: ./examples/powershell-script-with-input-output.md
[03]: ../RunCommandOnSet/index.md
[04]: ../../PowerShell/index.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ changedProperties: []
> If you want to capture the output, you should redirect it to a file.

<!-- Link reference definitions -->
[00]: ../../../../../cli/resource/set.md
[00]: ../../../../../../cli/resource/set.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ winget list --id Microsoft.PowerShell.Preview
```

<!-- Link reference definitions -->
[00]: ../../../../../cli/config/set.md
[00]: ../../../../../../cli/resource/set.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,6 @@ The following snippet contains the JSON Schema that validates an instance of the
- [Microsoft.DSC.PowerShell](../../PowerShell/index.md)
- [Microsoft.Windows.WindowsPowerShell](../../../../Microsoft/Windows/WindowsPowerShell/index.md)

[00]: ../../../../concepts/dsc/resource-capabilities.md
[00]: ../../../../../../concepts/resources/capabilities.md#set
[01]: ./examples/run-a-simple-command.md
[02]: ./examples/run-powershell-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,8 +259,8 @@ to the PowerShell scripts or when the input data is in an unexpected format.
- [Microsoft.Windows.WindowsPowerShell][04]

<!-- Link definitions -->
[00]: ../../../../concepts/dsc/resource-capabilities.md
[01]: ./examples/manage-windows-services-with-powershell.md
[00]: ../../../../../../concepts/resources/capabilities.md
[01]: ./examples/manage-windows-service-state-with-powershell.md
[02]: ../PowerShellScript/index.md
[03]: ../RunCommandOnSet/index.md
[04]: ../../../../Microsoft/Windows/WindowsPowerShell/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The `rebootPending` property indicates whether the system requires a reboot (`tr
> operation against the resource and use it in the `Microsoft.Dsc/Assertion` group resource. This
> resource relies on the synthetic testing provided by DSC. For more information about synthetic
> testing with DSC, see
> [DSC resource capabiltiies](../../../../../concepts/resources/capabilities.md#test).
> [DSC resource capabilities](../../../../../../concepts/resources/capabilities.md#test).
>
> For an example using this resource in an assertion, see
> [Use the RebootPending resource in a configuration](./use-rebootpending-in-configuration.md).
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/resources/Microsoft/Windows/Registry/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ The resource returns the following exit codes from operations:
- [1](#exit-code-1) - Invalid parameter
- [2](#exit-code-2) - Invalid input
- [3](#exit-code-3) - Registry error
- [4](#exit-code-4) - Json serialization failed
- [4](#exit-code-4) - JSON serialization failed

### Exit code 0

Expand Down Expand Up @@ -471,6 +471,6 @@ Indicates the resource operation failed because the result couldn't be serialize
[06]: ../../../../../concepts/resources/properties.md#required-resource-properties
[07]: ../../../../../concepts/resources/properties.md#key-resource-properties
[08]: ../../../../../concepts/resources/properties.md#read-only-resource-properties
[09]: /en-us/windows/win32/sysinfo/registry-value-types
[09]: /windows/win32/sysinfo/registry-value-types
[10]: ../../osinfo/index.md
[11]: /windows/win32/sysinfo/about-the-registry
2 changes: 1 addition & 1 deletion docs/reference/resources/Microsoft/Windows/WMI/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,4 +189,4 @@ When the resource returns this exit code, it also emits an error message with de
<!-- Link definitions -->
[01]: ./examples/query-operating-system-info.md
[02]: ./examples/query-filtered-disk-info.md
[03]: ../../../../schemas/config/type.md
[03]: ../../../../schemas/definitions/resourceType.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,4 @@ When the resource returns this exit code, it also emits an error message with de

<!-- Link definitions -->
[01]: ./examples/manage-a-windows-service.md
[02]: ../../../../schemas/config/type.md
[02]: ../../../../schemas/definitions/resourceType.md
54 changes: 27 additions & 27 deletions docs/reference/resources/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,39 @@ This document lists the available resources and links to the reference documenta

## All built-in resources

- [Microsoft/OSInfo](./microsoft/osinfo/resource.md)
- [Microsoft.DSC/Assertion](./microsoft/dsc/assertion/resource.md)
- [Microsoft.DSC/Group](./microsoft/dsc/group/resource.md)
- [Microsoft.DSC/Include](./microsoft/dsc/include/resource.md)
- [Microsoft.Adapter/PowerShell](./microsoft/adapter/powershell/index.md)
- [Microsoft.Adapter/WindowsPowerShell](./microsoft/adapter/windowspowershell/index.md)
- [Microsoft.DSC/PowerShell](./microsoft/dsc/powershell/resource.md)
- [Microsoft.DSC.Debug/Echo](./microsoft/dsc/debug/echo/resource.md)
- [Microsoft.DSC.Transitional/RunCommandOnSet](./microsoft/dsc/transitional/runcomandonset/resource.md)
- [Microsoft.Windows/RebootPending](./microsoft/windows/rebootpending/resource.md)
- [Microsoft.Windows/Registry](./microsoft/windows/registry/resource.md)
- [Microsoft.Windows/WindowsPowerShell](./microsoft/windows/windowspowershell/resource.md)
- [Microsoft.Windows/WMI](./microsoft/windows/wmi/resource.md)
- [Microsoft/OSInfo](./Microsoft/OSInfo/index.md)
- [Microsoft.DSC/Assertion](./Microsoft/DSC/Assertion/index.md)
- [Microsoft.DSC/Group](./Microsoft/DSC/Group/index.md)
- [Microsoft.DSC/Include](./Microsoft/DSC/Include/index.md)
- [Microsoft.Adapter/PowerShell](./Microsoft/Adapter/PowerShell/index.md)
- [Microsoft.Adapter/WindowsPowerShell](./Microsoft/Adapter/WindowsPowerShell/index.md)
- [Microsoft.DSC/PowerShell](./Microsoft/DSC/PowerShell/index.md)
- [Microsoft.DSC.Debug/Echo](./Microsoft/DSC/Debug/echo/index.md)
- [Microsoft.DSC.Transitional/RunCommandOnSet](./Microsoft/DSC/Transitional/RunCommandOnSet/index.md)
- [Microsoft.Windows/RebootPending](./Microsoft/Windows/RebootPending/index.md)
- [Microsoft.Windows/Registry](./Microsoft/Windows/Registry/index.md)
- [Microsoft.Windows/WindowsPowerShell](./Microsoft/Windows/WindowsPowerShell/index.md)
- [Microsoft.Windows/WMI](./Microsoft/Windows/WMI/index.md)

## Built-in assertion resources

You can use the following built-in resources to query the current state of a machine but not to
change the state of the machine directly:

- [Microsoft/OSInfo](./microsoft/osinfo/resource.md)
- [Microsoft.DSC/Assertion](./microsoft/dsc/assertion/resource.md)
- [Microsoft.Windows/RebootPending](./microsoft/windows/rebootpending/resource.md)
- [Microsoft/OSInfo](./Microsoft/OSInfo/index.md)
- [Microsoft.DSC/Assertion](./Microsoft/DSC/Assertion/index.md)
- [Microsoft.Windows/RebootPending](./Microsoft/Windows/RebootPending/index.md)

## Built-in adapter resources

You can use the following built-in resources to leverage resources that don't define a DSC Resource
Manifest:

- [Microsoft.Adapter/PowerShell](./microsoft/adapter/powershell/index.md)
- [Microsoft.Adapter/WindowsPowerShell](./microsoft/adapter/windowspowershell/index.md)
- [Microsoft.DSC/PowerShell](./microsoft/dsc/powershell/index.md)
- [Microsoft.Windows/WindowsPowerShell](./microsoft/windows/windowspowershell/index.md)
- [Microsoft.Windows/WMI](./microsoft/windows/wmi/resource.md)
- [Microsoft.Adapter/PowerShell](./Microsoft/Adapter/PowerShell/index.md)
- [Microsoft.Adapter/WindowsPowerShell](./Microsoft/Adapter/WindowsPowerShell/index.md)
- [Microsoft.DSC/PowerShell](./Microsoft/DSC/PowerShell/index.md)
- [Microsoft.Windows/WindowsPowerShell](./Microsoft/Windows/WindowsPowerShell/index.md)
- [Microsoft.Windows/WMI](./Microsoft/Windows/WMI/index.md)

> [!WARNING]
> `Microsoft.DSC/PowerShell` and `Microsoft.Windows/WindowsPowerShell` will be deprecated in a
Expand All @@ -48,21 +48,21 @@ Manifest:

The following built-in resources to change the state of a machine directly:

- [Microsoft.DSC.Transitional/RunCommandOnSet](./microsoft/dsc/transitional/runcomandonset/resource.md)
- [Microsoft.Windows/Registry](./microsoft/windows/registry/resource.md)
- [Microsoft.DSC.Transitional/RunCommandOnSet](./Microsoft/DSC/Transitional/RunCommandOnSet/index.md)
- [Microsoft.Windows/Registry](./Microsoft/Windows/Registry/index.md)

## Built-in debugging resources

You can use the following built-in resources when debugging or exploring DSC. They don't affect
the state of the machine.

- [Microsoft.DSC.Debug/Echo](./microsoft/dsc/debug/echo/resource.md)
- [Microsoft.DSC.Debug/Echo](./Microsoft/DSC/Debug/echo/index.md)

## Built-in group resources

You can use the following built-in resources to change how DSC processes a group of nested resource
instances:

- [Microsoft.DSC/Assertion](./microsoft/dsc/assertion/resource.md)
- [Microsoft.DSC/Group](./microsoft/dsc/group/resource.md)
- [Microsoft.DSC/Include](./microsoft/dsc/include/resource.md)
- [Microsoft.DSC/Assertion](./Microsoft/DSC/Assertion/index.md)
- [Microsoft.DSC/Group](./Microsoft/DSC/Group/index.md)
- [Microsoft.DSC/Include](./Microsoft/DSC/Include/index.md)
8 changes: 4 additions & 4 deletions docs/reference/schemas/config/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ semantic version, the latest schema for a minor version, or the latest schema fo
of DSC. For more information about schema URIs and versioning, see
[DSC JSON Schema URIs](../schema-uris.md).

For every version of the schema, there are three valid urls:
For every version of the schema, there are three valid URLs:

- `.../config/document.json`

Expand All @@ -93,7 +93,7 @@ For every version of the schema, there are three valid urls:
it includes additional definitions that provide contextual help and snippets that the others
don't include.

This schema uses keywords that are only recognized by VS Code. While DSC can still validate the
This schema uses keywords that are only recognized by Visual Studio Code. While DSC can still validate the
document when it uses this schema, other tools may error or behave in unexpected ways.

```yaml
Expand Down Expand Up @@ -164,7 +164,7 @@ defined as key-value pair. The key for each pair defines the name of the paramet
each pair must be an object that defines the `type` keyword to indicate how DSC should process the
parameter.

Parameters may be overridden at run-time, enabling re-use of the same configuration document for
Parameters may be overridden at runtime, enabling re-use of the same configuration document for
different contexts.

For more information about defining parameters in a configuration, see
Expand All @@ -187,7 +187,7 @@ the variable by name can access the variable's value.

This can help reduce the amount of copied values and options for resources in the configuration,
which makes the document easier to read and maintain. Unlike parameters, variables can only be
defined in the configuration and can't be overridden at run-time.
defined in the configuration and can't be overridden at runtime.

<!-- For more information about using variables in a configuration, see
[DSC Configuration variables][04]. -->
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/schemas/config/functions/array.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Type: array
## Related functions

- [`createArray()`][00] - Creates a homogeneous array (all elements same type)
- [`createObject()`][01] - Builds an object from key/value pairs
- [`createObject()`][01] - Builds an object from key-value pairs
- [`first()`][02] - Gets the first element from an array
- [`indexOf()`][03] - Finds the index of an item in an array

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/schemas/config/functions/envvar.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ The `envvar()` function returns the value of the environment variable specified
Type: string
```

[01]: ../../../cli/config/command.md#environment-variables
[01]: ../../../cli/config/index.md#environment-variables
5 changes: 1 addition & 4 deletions docs/reference/schemas/config/functions/items.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ The `items()` function converts a dictionary object to an array of key-value pai
property name) and `value` (the property value).

This function is useful for iterating over object properties in DSC configurations,
especially when used with loops. It's the companion function to [`toObject()`][03],
which converts an array back to an object.
especially when used with loops.

## Examples

Expand Down Expand Up @@ -197,10 +196,8 @@ Type: array

- [`createObject()`][00] - Creates an object from key-value pairs
- [`length()`][01] - Returns the number of elements in an array or object
- [`toObject()`][03] - Converts an array of key-value pairs to an object

<!-- Link reference definitions -->
[00]: ./createObject.md
[01]: ./length.md
[02]: ./copyIndex.md
[03]: ./toObject.md
2 changes: 1 addition & 1 deletion docs/reference/schemas/config/functions/join.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The `delimiter` can be any value; it’s converted to a string.

### Example 1 - Produce a list of servers

Create a comma-separated string from a list of host names to pass to tools or
Create a comma-separated string from a list of hostnames to pass to tools or
APIs that accept CSV input. This example uses [`createArray()`][02] to build
the server list and joins with ", ".

Expand Down
Loading