Merge pull request #838 from Gijsreyn/update-docs

Update Test/Echo docs and new format() reference doc

Author: SteveL-MSFT

.github/ISSUE_TEMPLATE/Bug_Report.yml

@@ -38,7 +38,7 @@ body:
          $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
          resources:
          - name: repro
-           type: Test/Echo
+           type: Microsoft.DSC.Debug/Echo
            properties:
              output: expected value
          ```
@@ -59,7 +59,7 @@ body:
       
       results:
       - name: repro
-        type: Test/Echo
+        type: Microsoft.DSC.Debug/Echo
         result:
           actualState:
             output: expected value
@@ -77,7 +77,7 @@ body:
       
       results:
       - name: repro
-        type: Test/Echo
+        type: Microsoft.DSC.Debug/Echo
         result:
           actualState:
             output: other value

.vscode/docs.code-snippets

@@ -45,19 +45,19 @@
 			"\\$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json",
 			"resources:",
 			"- name: ${7:descriptive resource name}",
-			"  type: Test/Echo",
+			"  type: Microsoft.DSC.Debug/Echo",
 			"  properties:",
 			"    output: \"[${1:name}(${8:example input})]\"",
 			"```",
 			"",
 			"```bash",
-			"dsc config get --document ${1:name}.example.1.dsc.config.yaml",
+			"dsc config get --file ${1:name}.example.1.dsc.config.yaml",
 			"```",
 			"",
 			"```yaml",
 			"results:",
 			"- name: ${7:descriptive resource name}",
-			"  type: Test/Echo",
+			"  type: Microsoft.DSC.Debug/Echo",
 			"  result:",
 			"    actualState:",
 			"      output: ${9:example output}",
@@ -104,19 +104,19 @@
 			"\\$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json",
 			"resources:",
 			"- name: ${4:descriptive resource name}",
-			"  type: Test/Echo",
+			"  type: Microsoft.DSC.Debug/Echo",
 			"  properties:",
 			"    output: \"[$TM_FILENAME_BASE(${5:example input})]\"",
 			"```",
 			"",
 			"```bash",
-			"dsc config get --document ${TM_FILENAME_BASE}.example.$1.dsc.config.yaml",
+			"dsc config get --file ${TM_FILENAME_BASE}.example.$1.dsc.config.yaml",
 			"```",
 			"",
 			"```yaml",
 			"results:",
 			"- name: $4",
-			"  type: Test/Echo",
+			"  type: Microsoft.DSC.Debug/Echo",
 			"  result:",
 			"    actualState:",
 			"      output: ${6:example output}",

docs/reference/cli/config/set.md

@@ -80,22 +80,22 @@ cat ./example.dsc.config.yaml | dsc config set --file -
 
 <a id="example-2"></a>
 
-The command uses the **path** option to enforce the configuration defined in the
+The command uses the **file** option to enforce the configuration defined in the
 `example.dsc.config.yaml` file.
 
 ```sh
-dsc config set --path ./example.dsc.config.yaml
+dsc config set --file ./example.dsc.config.yaml
 ```
 
 ### Example 3 - Passing a configuration document as a variable
 
 <a id="example-3"></a>
 
-The command uses the **document** option to enforce the configuration stored in the `$desired`
+The command uses the **input** option to enforce the configuration stored in the `$desired`
 variable.
 
 ```sh
-dsc config set --document $desired
+dsc config set --input $desired
 ```
 
 ## Options

docs/reference/cli/config/test.md

@@ -22,7 +22,7 @@ dsc config test [Options] --file <FILE>
 ### Configuration document from option string
 
 ```sh
-dsc config test [Options] --document <INPUT>
+dsc config test [Options] --input <INPUT>
 ```
 
 ### Configuration document from stdin

docs/reference/schemas/config/functions/add.md

@@ -33,19 +33,19 @@ This example document shows how you can use the `add()` function to return the s
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Sum of 3 and 5
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
   output: "[add(3, 5)]"
 ```
 
 ```bash
-dsc config get --document add.example.1.dsc.config.yaml 
+dsc config get --file add.example.1.dsc.config.yaml 
 ```
 
 ```yaml
 results:
 - name: Sum of 3 and 5
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: 8
@@ -63,19 +63,19 @@ configuration functions that return integer values.
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Add nested function outputs
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
     output: "[add(mul(2,3), div(6,3))]"
 ```
 
 ```bash
-dsc config get --document add.example.2.dsc.config.yaml
+dsc config get --file add.example.2.dsc.config.yaml
 ```
 
 ```yaml
 results:
 - name: Add nested function outputs
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: 8

docs/reference/schemas/config/functions/base64.md

@@ -34,19 +34,19 @@ The configuration converts a basic string value with the `base64()` function.
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
   - name: Echo 'abc' in base64
-    type: Test/Echo
+    type: Microsoft.DSC.Debug/Echo
     properties:
       output: "[base64('abc')]"
 ```
 
 ```bash
-dsc --input-file base64.example.1.dsc.config.yaml config get
+dsc --file base64.example.1.dsc.config.yaml config get
 ```
 
 ```yaml
 results:
 - name: Echo 'abc' in base64
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: YWJj
@@ -64,19 +64,19 @@ strings `a`, `b`, and `c` into `abc` before returning the base64 representation.
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
   - name: Echo concatenated 'a', 'b', 'c' in base64
-    type: Test/Echo
+    type: Microsoft.DSC.Debug/Echo
     properties:
       output: "[base64(concat('a', 'b', 'c'))]"
 ```
 
 ```bash
-dsc --input-file base64.example.2.dsc.config.yaml config get
+dsc --file base64.example.2.dsc.config.yaml config get
 ```
 
 ```yaml
 results:
 - name: Echo concatenated 'a', 'b', 'c' in base64
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: YWJj

docs/reference/schemas/config/functions/concat.md

@@ -38,19 +38,19 @@ The configuration uses the `concat()` function to join the strings `abc` and `de
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
   - name: Echo 'abcdef'
-    type: Test/Echo
+    type: Microsoft.DSC.Debug/Echo
     properties:
       output: "[concat('abc', 'def')]"
 ```
 
 ```bash
-dsc --input-file concat.example.1.dsc.config.yaml config get
+dsc config get --file concat.example.1.dsc.config.yaml
 ```
 
 ```yaml
 results:
 - name: Echo 'abcdef'
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: abcdef
@@ -67,7 +67,7 @@ The configuration uses the `concat()` function to return a combined array of str
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Echo ['a', 'b', 'c', 'd', 'e', 'f']
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
     output: >-
       [concat(
@@ -77,13 +77,13 @@ resources:
 ```
 
 ```bash
-dsc config get --document concat.example.2.dsc.config.yaml
+dsc config get --file concat.example.2.dsc.config.yaml
 ```
 
 ```yaml
 results:
 - name: Echo ['a', 'b', 'c', 'd', 'e', 'f']
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output:

docs/reference/schemas/config/functions/createArray.md

@@ -36,19 +36,19 @@ example synopsis
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Echo array of integers
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
     output: "[createArray(1, 3, 5)]"
 ```
 
 ```bash
-dsc config get --document createArray.example.1.dsc.config.yaml config get
+dsc config get --file createArray.example.1.dsc.config.yaml config get
 ```
 
 ```yaml
 results:
 - name: Echo array of integers
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output:
@@ -69,19 +69,19 @@ sub-array contains only integers. The second sub-array contains only strings.
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Create array of arrays
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
     output: "[createArray(createArray(1,3,5), createArray('a', 'b', 'c'))]"
 ```
 
 ```bash
-dsc config get --document createArray.example.2.dsc.config.yaml
+dsc config get --file createArray.example.2.dsc.config.yaml
 ```
 
 ```yaml
 results:
 - name: Create array of arrays
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output:
@@ -105,7 +105,7 @@ strings. It uses YAML's folded multiline string syntax to make the function more
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Echo flattened array
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
     output: >-
       [concat(
@@ -115,13 +115,13 @@ resources:
 ```
 
 ```bash
-dsc config get --document createArray.example.3.dsc.config.yaml
+dsc config get --file createArray.example.3.dsc.config.yaml
 ```
 
 ```yaml
 results:
 - name: Echo flattened array
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output:

docs/reference/schemas/config/functions/div.md

@@ -35,19 +35,19 @@ integers.
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Dividing integers
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
     output: "[div(6,3)]"
 ```
 
 ```bash
-dsc config get --document div.example.1.dsc.config.yaml config get
+dsc config get --file div.example.1.dsc.config.yaml config get
 ```
 
 ```yaml
 results:
 - name: Dividing integers
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: 2
@@ -66,19 +66,19 @@ full integer value without the remainder. It doesn't round the result up to 3.
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
 - name: Dividing nested functions
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   properties:
     output: "[div(mul(7,2), add(4,1))]"
 ```
 
 ```bash
-dsc config get --document div.example.2.dsc.config.yaml
+dsc config get --file div.example.2.dsc.config.yaml
 ```
 
 ```yaml
 results:
 - name: Dividing nested functions
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: 2

docs/reference/schemas/config/functions/envvar.md

@@ -31,14 +31,14 @@ commands, DSC automatically creates the `DSC_CONFIG_ROOT` environment variable a
 the parent folder of the specified configuration document. For more information, see
 [dsc config command reference][01].
 
-This configuration echoes that folder with the `Test/Echo` resource.
+This configuration echoes that folder with the `Microsoft.DSC.Debug/Echo` resource.
 
 ```yaml
 # ./examples/envvar.example.1.dsc.config.yaml
 $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
 resources:
   - name: Echo 'DSC_CONFIG_ROOT' in envvar
-    type: Test/Echo
+    type: Microsoft.DSC.Debug/Echo
     properties:
       output: "[envvar('DSC_CONFIG_ROOT')]"
 ```
@@ -50,7 +50,7 @@ dsc config get --path ~/dsc/examples/envvar.example.1.dsc.config.yaml
 ```yaml
 results:
 - name: Echo DSC_CONFIG_ROOT
-  type: Test/Echo
+  type: Microsoft.DSC.Debug/Echo
   result:
     actualState:
       output: ~/dsc/examples