Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(MAINT) Sync reference docs #147

Merged
Merged
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
9 changes: 8 additions & 1 deletion docs/reference/cli/config/command.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc config' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc config
---

# dsc config

## Synopsis
Expand Down Expand Up @@ -45,7 +52,7 @@ dsc config help [<SUBCOMMAND>]
For example, `dsc config help` gets the help for this command. `dsc config help set` gets the help
for the `set` subcommand.

You can also use the [--help](#h---help) option on the command or subcommand to display the help
You can also use the [--help](#-h---help) option on the command or subcommand to display the help
information. For example, `dsc config --help` or `dsc config set --help`.

## Options
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/cli/config/get.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc config get' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc config get
---

# dsc config get

## Synopsis
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/cli/config/set.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc config set' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc config set
---

# dsc config set

## Synopsis
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/cli/config/test.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc config test' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc config test
---

# dsc config test

## Synopsis
Expand Down
13 changes: 10 additions & 3 deletions docs/reference/cli/dsc.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc
---

# dsc

## Synopsis
Expand Down Expand Up @@ -52,7 +59,7 @@ dsc help <COMMAND> [<SUBCOMMAND>]
For example, `dsc help config` gets the help for the `config` subcommand. `dsc help config set`
gets the help for the `config set` subcommand.

You can also use the [--help](#h---help) option on a command to display the help information. For
You can also use the [--help](#-h---help) option on a command to display the help information. For
example, `dsc config --help` or `dsc config set --help`.

## Options
Expand Down Expand Up @@ -95,6 +102,6 @@ Type: Boolean
Mandatory: false
```

[01]: config.md
[01]: config/command.md
[02]: resource/command.md
[03]: schema.md
[03]: schema/command.md
9 changes: 8 additions & 1 deletion docs/reference/cli/resource/command.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc resource' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc resource
---

# dsc resource

## Synopsis
Expand Down Expand Up @@ -57,7 +64,7 @@ dsc resource help [<SUBCOMMAND>]
For example, `dsc resource help` gets the help for this command. `dsc resource help list`
gets the help for the `list` subcommand.

You can also use the [--help](#h---help) option on the command or subcommand to display the help
You can also use the [--help](#-h---help) option on the command or subcommand to display the help
information. For example, `dsc resource --help` or `dsc resource set --help`.

## Options
Expand Down
9 changes: 8 additions & 1 deletion docs/reference/cli/resource/get.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc resource get' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc resource get
---

# dsc resource get

## Synopsis
Expand Down Expand Up @@ -130,4 +137,4 @@ This command returns JSON output that includes the actual state of the instance.
information, see [dsc resource get result schema][02].

[01]: ../config/get.md
[02]: ../../schemas/outputs/resource/
[02]: ../../schemas/outputs/resource/get.md
9 changes: 8 additions & 1 deletion docs/reference/cli/resource/list.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc resource list' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc resource list
---

# dsc resource list

## Synopsis
Expand Down Expand Up @@ -173,4 +180,4 @@ This command returns a JSON object for each resource that includes the resource'
manifest settings, and other metadata. For more information, see
[dsc resource list result schema][01].

[01]: ../../schemas/output/resource/list.md
[01]: ../../schemas/outputs/resource/list.md
7 changes: 7 additions & 0 deletions docs/reference/cli/resource/schema.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc resource schema' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc resource schema
---

# dsc resource schema

## Synopsis
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/cli/resource/set.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc resource set' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc resource set
---

# dsc resource set

## Synopsis
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/cli/resource/test.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc resource test' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc resource test
---

# dsc resource test

## Synopsis
Expand Down
27 changes: 17 additions & 10 deletions docs/reference/cli/schema/command.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: Command line reference for the 'dsc schema' command
ms.date: 08/04/2023
ms.topic: reference
title: dsc schema
---

# dsc schema

## Synopsis
Expand All @@ -7,7 +14,7 @@ Gets the JSON schema for a DSC type.
## Syntax

```sh
dsc [Options] --type <TYPE>
dsc schema [Options] --type <TYPE>
```

## Description
Expand Down Expand Up @@ -90,12 +97,12 @@ Type: Boolean
Mandatory: false
```

[01]: ../schemas/outputs/resource/list.md
[02]: ../schemas/resource/manifest.md
[03]: ../schemas/outputs/resource/get.md
[04]: ../schemas/outputs/resource/set.md
[05]: ../schemas/outputs/resource/test.md
[06]: ../schemas/configuration/document.md
[07]: ../schemas/outputs/config/get.md
[08]: ../schemas/outputs/config/set.md
[09]: ../schemas/outputs/config/test.md
[01]: ../../schemas/outputs/resource/list.md
[02]: ../../schemas/resource/manifest/root.md
[03]: ../../schemas/outputs/resource/get.md
[04]: ../../schemas/outputs/resource/set.md
[05]: ../../schemas/outputs/resource/test.md
[06]: ../../schemas/config/document.md
[07]: ../../schemas/outputs/config/get.md
[08]: ../../schemas/outputs/config/set.md
[09]: ../../schemas/outputs/config/test.md
36 changes: 23 additions & 13 deletions docs/reference/schemas/config/document.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: JSON schema reference for a Desired State Configuration document.
ms.date: 08/04/2023
ms.topic: reference
title: DSC Configuration document schema reference
---

# DSC Configuration document schema reference

## Synopsis
Expand All @@ -24,7 +31,7 @@ recommends drafting configuration documents in YAML.
For DSC's authoring tools to recognize a file as a DSC Configuration document, the filename must
end with `.dsc.config.json` or `.dsc.config.yaml`.

For more information, see [DSC Configurations overview][01]
<!-- For more information, see [DSC Configurations overview][01]. -->

The rest of this document describes the schema DSC uses to validation configuration documents.

Expand Down Expand Up @@ -77,8 +84,10 @@ Parameters may be overridden at run-time, enabling re-use of the same configurat
different contexts.

For more information about defining parameters in a configuration, see
[DSC Configuration document parameter schema][02]. For more information about using parameters in a
configuration, see [DSC Configuration parameters][03]
[DSC Configuration document parameter schema][02].

<!-- For more information about using parameters in a configuration, see
[DSC Configuration parameters][03] -->

```yaml
Type: object
Expand All @@ -96,8 +105,8 @@ This can help reduce the amount of copied values and options for resources in th
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.

For more information about using variables in a configuration, see
[DSC Configuration variables][04].
<!-- For more information about using variables in a configuration, see
[DSC Configuration variables][04]. -->

```yaml
Type: object
Expand All @@ -110,9 +119,10 @@ The `resources` property defines a list of DSC Resource instances that the confi
Every instance in the list must be unique, but instances may share the same DSC Resource type.

For more information about defining a valid resource instance in a configuration, see
[DSC Configuration document resource schema][05]. For more information about how DSC uses resources
in a configuration, see [DSC Configuration resources][06] and
[DSC Configuration resource groups][07].
[DSC Configuration document resource schema][05].

<!-- For more information about how DSC uses resources in a configuration, see
[DSC Configuration resources][06] and [DSC Configuration resource groups][07]. -->

```yaml
Type: array
Expand All @@ -121,10 +131,10 @@ Minimum Item Count: 1
Valid Item Schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.resource.json
```

[01]: ../../../configurations/overview.md
<!-- [01]: ../../../configurations/overview.md -->
[02]: parameter.md
[03]: ../../../configurations/parameters.md
[04]: ../../../configurations/variables.md
<!-- [03]: ../../../configurations/parameters.md -->
<!-- [04]: ../../../configurations/variables.md -->
[05]: resource.md
[06]: ../../../configurations/resources.md
[07]: ../../../configurations/resource-groups.md
<!-- [06]: ../../../configurations/resources.md -->
<!-- [07]: ../../../configurations/resource-groups.md -->
9 changes: 8 additions & 1 deletion docs/reference/schemas/config/parameter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: JSON schema reference for a parameter in a Desired State Configuration document.
ms.date: 08/04/2023
ms.topic: reference
title: DSC Configuration document parameter schema
---

# DSC Configuration document parameter schema

## Synopsis
Expand Down Expand Up @@ -181,5 +188,5 @@ Type: int
Required: false
```

[01]: resources.md
[01]: resource.md
[02]: ../definitions/parameters/dataTypes.md
19 changes: 13 additions & 6 deletions docs/reference/schemas/config/resource.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: JSON schema reference for a resource instance in a Desired State Configuration document.
ms.date: 08/04/2023
ms.topic: reference
title: DSC Configuration document resource instance schema
---

# DSC Configuration document resource instance schema

## Synopsis
Expand Down Expand Up @@ -58,10 +65,10 @@ Pattern: ^\w+(\.\w+){0,2}\/\w+$
### properties

The `properties` of a resource instance define its desired state. The value of this property must
be an object. For [assertion resources][02], the value may be an empty object (`{}`). DSC uses the
be an object. For assertion resources, the value may be an empty object (`{}`). DSC uses the
DSC Resource's instance schema to validate the defined properties.

For more information about instance schemas in DSC, see [DSC Resource instance schemas][03].
<!-- For more information about instance schemas in DSC, see [DSC Resource instance schemas][03]. -->

```yaml
Type: object
Expand All @@ -86,7 +93,7 @@ and `<instance-name>` is the dependency's `name` property.
Multiple instances can depend on the same instance, but every dependency for an instance must be
unique in that instance's `dependsOn` property.

For more information, see [Configuration resource dependencies][04].
<!-- For more information, see [Configuration resource dependencies][04]. -->

```yaml
Type: array
Expand All @@ -97,6 +104,6 @@ Valid Items Pattern: ^\[\w+(\.\w+){0,2}\/\w+\].+$
```

[01]: ../definitions/resourceType.md
[02]: ../../../resources/concepts/assertion-resources.md
[03]: ../../../resources/concepts/schemas.md
[04]: ../../../configurations/concepts/dependencies.md
<!-- [02]: ../../../resources/concepts/assertion-resources.md -->
<!-- [03]: ../../../resources/concepts/schemas.md -->
<!-- [04]: ../../../configurations/concepts/dependencies.md -->
7 changes: 7 additions & 0 deletions docs/reference/schemas/definitions/message.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: JSON schema reference for a structured message returned from a 'dsc config' command.
ms.date: 08/04/2023
ms.topic: reference
title: Structured message schema reference
---

# Structured message schema reference

## Synopsis
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/schemas/definitions/parameters/dataTypes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: JSON schema reference for valid parameter data types in a configuration document.
ms.date: 08/04/2023
ms.topic: reference
title: DSC configuration parameter data type schema reference
---

# DSC configuration parameter data type schema reference

## Synopsis
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/schemas/definitions/resourceType.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: JSON schema reference for a resource instance type name
ms.date: 08/04/2023
ms.topic: reference
title: DSC Resource fully qualified type name schema reference
---

# DSC Resource fully qualified type name schema reference

## Synopsis
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/schemas/outputs/config/get.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description: JSON schema reference for the data returned by the 'dsc config get' command.
ms.date: 08/04/2023
ms.topic: reference
title: dsc config get result schema reference
---

# dsc config get result schema reference

## Synopsis
Expand Down
Loading