Merging this project with the latest changes done in CommonTasks

raandree · Dec 8, 2022 · f48c849 · f48c849
1 parent ef12a91
commit f48c849
Show file tree

Hide file tree

Showing 30 changed files with 380 additions and 183 deletions.
diff --git a/doc/ComputerSettings.adoc b/doc/ComputerSettings.adoc
@@ -8,9 +8,10 @@
 = DSC Resource 'ComputerSettings'
 // didn't work in production: = Catego ry '{YmlCategory}'
 
+:abstract:  {YmlCategory} configures a computer by changing its name and description and modifying its Active Directory domain or workgroup membership.
 
-[[dscyml_computersettings_abstract]]
-.{YmlCategory} configures a computer by changing its name and description and modifying its Active Directory domain or workgroup membership.
+[[dscyml_computersettings_abstract, {abstract}]]
+{abstract}
 
 
 [cols="1,3a" options="autowidth" caption=]
@@ -77,14 +78,15 @@
 | AllowRemoteDesktop
 |
 | Bool
-| Enables or disabled remote desktop. +
+| Enables or disabled remote desktop.
 |
 
 | RemoteDesktopUserAuthentication
 |
 | String
-| Configures the authentication for remote desktop. +
-|  Secure, Unsecure
+| Configures the authentication for remote desktop.
+| - Secure
+  - Unsecure
 
 |===
 

diff --git a/doc/DscLcmController.adoc b/doc/DscLcmController.adoc
@@ -1,4 +1,4 @@
-// DscConfig.Demo YAML Reference: DscLcmController
+// CommonTasks YAML Reference: DscLcmController
 // ========================================
 
 :YmlCategory: DscLcmController
@@ -13,14 +13,14 @@
 .{YmlCategory} replaces most of the default settings controlling the LCM that you usually set with `Set-DscLocalConfigurationManager`.
 
 These new settings are controlling the external trigger of the LCM.
-There is no `ConfigurationModeFrequencyMins` anymore.
+There is no `ConfigurationModeFrequencyMins` anymore. 
 Instead there are two new values, `AutoCorrectInterval` and `MonitorInterval`.
 
 
 [cols="1,3a" options="autowidth" caption=]
 |===
-| Source         | https://github.com/dsccommunity/DscConfig.Demo/tree/main/source/DSCResources/DscLcmController
-| DSC Resource   | https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/?view=powershell-5.1[PSDesiredStateConfiguration],
+| Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DscLcmController
+| DSC Resource   | https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/?view=powershell-5.1[PSDesiredStateConfiguration], 
                    https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration],
                    https://github.com/dsccommunity/ComputerManagementDsc[ComputerManagementDsc]
 | Documentation  | https://dsccommunity.org/blog/dsc-maintenance-windows/[Realizing maintenance windows with DSC]
@@ -142,4 +142,4 @@ DscLcmController:
   RefreshIntervalOverride: false
   ControllerInterval: 00:15:00
   MaintenanceWindowOverride: false
-----
+----
diff --git a/doc/DscLcmMaintenanceWindows.adoc b/doc/DscLcmMaintenanceWindows.adoc
@@ -1,4 +1,4 @@
-// DscConfig.Demo YAML Reference: DscLcmMaintenanceWindows
+// CommonTasks YAML Reference: DscLcmMaintenanceWindows
 // ========================================
 
 :YmlCategory: DscLcmMaintenanceWindows
@@ -15,7 +15,7 @@
 
 [cols="1,3a" options="autowidth" caption=]
 |===
-| Source         | https://github.com/dsccommunity/DscConfig.Demo/tree/main/source/DSCResources/DscLcmMaintenanceWindows
+| Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DscLcmMaintenanceWindows
 | DSC Resource   | https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration[PSDesiredStateConfiguration],
                    https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration]
 | Documentation  | https://dsccommunity.org/blog/dsc-maintenance-windows/[Realizing maintenance windows with DSC]
@@ -108,4 +108,4 @@ DscLcmMaintenanceWindows:
       On:        last
       StartTime: 04:00:00
       Timespan:  01:00:00
-----
+----
diff --git a/doc/DscTagging.adoc b/doc/DscTagging.adoc
@@ -1,4 +1,4 @@
-// DscConfig.Demo YAML Reference: DscTagging
+// CommonTasks YAML Reference: DscTagging
 // ========================================
 
 :YmlCategory: DscTagging
@@ -15,8 +15,8 @@
 
 [cols="1,3a" options="autowidth" caption=]
 |===
-| Source         | https://github.com/dsccommunity/DscConfig.Demo/tree/main/source/DSCResources/DscTagging
-| DSC Resource   | https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration],
+| Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/DscTagging
+| DSC Resource   | https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration], 
                    https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/?view=powershell-7[PSDesiredStateConfiguration]
 | Documentation  | https://github.com/dsccommunity/xPSDesiredStateConfiguration#xregistry[xRegistry]
 |===
@@ -43,26 +43,26 @@
 |
 
 | NodeVersion
-|
+| 
 | System.Version
 | Optional node specific DSC configuration version
 |
 
 | NodeRole
-|
+| 
 | String
 | Role of the node
 |
 
 | DisableGitCommitId
-|
+| 
 | Boolean
 | Disable export of git commit id
 | - True
   - *False* (default)
 
 | Layers
-|
+| 
 | String[]
 | List of used layers (YAML files) for each node
 |
@@ -133,7 +133,7 @@ DscTagging:
 ----
 Configurations:
   - DscTagging
-
+  
 DscTagging:
   Version: 0.3.0
   Layers:
@@ -146,7 +146,7 @@ DscTagging:
 ----
 Configurations:
   - DscTagging
-
+  
 DscTagging:
   Version:     0.3.0
   Environment: Dev
@@ -156,4 +156,4 @@ DscTagging:
     - Environment\Dev
     - Roles\FileServer
     - Roles\ServerBaseline
-----
+----
diff --git a/doc/FilesAndFolders.adoc b/doc/FilesAndFolders.adoc
@@ -1,4 +1,4 @@
-// DscConfig.Demo YAML Reference: FilesAndFolders
+// CommonTasks YAML Reference: FilesAndFolders
 // ===========================================
 
 :YmlCategory: FilesAndFolders
@@ -8,16 +8,16 @@
 = DSC Resource 'FilesAndFolders'
 // didn't work in production: = DSC Resource '{YmlCategory}'
 
+:abstract:   {YmlCategory} provides a mechanism to manage files and folders on the target node.
 
-[[dscyml_filesandfolders_abstract]]
-.{YmlCategory} provides a mechanism to manage files and folders on the target node.
-
-DestinationPath and SourcePath must both be accessible by the target Node.
+[[dscyml_filesandfolders_abstract, {abstract}]]
+{abstract}
 
+NOTE: `DestinationPath` and `SourcePath` must both be accessible by the target Node.
 
 [cols="1,3a" options="autowidth" caption=]
 |===
-| Source         | https://github.com/dsccommunity/DscConfig.Demo/tree/main/source/DSCResources/FilesAndFolders
+| Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/FilesAndFolders
 | DSC Resource   | https://docs.microsoft.com/en-us/powershell/module/psdesiredstateconfiguration/?view=powershell-5.1[PSDesiredStateConfiguration]
 | Documentation  | https://docs.microsoft.com/en-us/powershell/scripting/dsc/reference/resources/windows/fileresource?view=powershell-5.1[File]
 |===
@@ -53,7 +53,9 @@ DestinationPath and SourcePath must both be accessible by the target Node.
 |
 | String
 | The location on the target node
-|
+
+NOTE: The specified path must be accessible by the target node.
+| 
 
 | Attributes
 |
@@ -79,15 +81,17 @@ DestinationPath and SourcePath must both be accessible by the target Node.
 | String
 | Indicates the contents to Ensure are `Present` or `Absent` from the targeted file.
 
-Only valid when used with Type File.
+NOTE: Only valid when used with Type `File`.
 |
 
 | ContentFromFile
 |
 | String
 | Loading contents from the specified file during DSC configuration build and append the loaded content to the `Contents` attribute
 
-Only valid when used with Type File.
+NOTE: Only valid when used with type `File` and mandatory with type `BinaryFile`.
+
+IMPORTANT: The specified path must be accessible at compile time.
 |
 
 | Credential
@@ -115,21 +119,28 @@ Only valid when used with Type File.
 |
 | String
 | The path from which to copy the file or folder resource.
+
+NOTE: The specified path must be accessible by the target node.
 |
 
 | Type
 |
 | String
 | The type of resource being configured.
+
+IMPORTANT: The type `BinaryFile` embeds a bas64 encoded file stream in the compiled MOF file and can exceed the default `MaxEnvelopeSizeKb` of 500KB.
+
+NOTE: The type `BinaryFile` supports only the attributes `ContentFromFile`, `DestinationPath`, `Ensure`. A SHA256 checksum is used to identify file content changes.
 | - Directory
   - *File* (default)
+  - BinaryFile
 
 | MatchSource
 |
 | Boolean
 | Determines if the resource should monitor for new files added to the source directory after the initial copy.
 
-A value of `True` indicates that, after the initial copy, any new source files should be copied to the destination.
+A value of `True` indicates that, after the initial copy, any new source files should be copied to the destination. 
 If set to `False`, the resource caches the contents of the source directory and ignores any files added after the initial copy.
 | - *False* (default)
   - True
@@ -166,13 +177,13 @@ If set to `False`, the resource caches the contents of the source directory and
 | Identity
 | Key
 | String
-| The identity to set permissions for.
+| The identity to set permissions for. 
 |
 
 | Rights
 |
 | String[]
-| The permissions to include in this rule.
+| The permissions to include in this rule. 
 
   Optional if `Ensure` is set to value `Absent`.
 | - ListDirectory
@@ -258,4 +269,4 @@ FilesAndFolders:
             - Read
             - Write
             - ExecuteFile
-----
+----
diff --git a/doc/LocalGroups.adoc b/doc/LocalGroups.adoc
@@ -1,4 +1,4 @@
-// DscConfig.Demo YAML Reference: LocalGroups
+// CommonTasks YAML Reference: LocalGroups
 // =======================================
 
 :YmlCategory: LocalGroups
@@ -15,7 +15,7 @@
 
 [cols="1,3a" options="autowidth" caption=]
 |===
-| Source         | https://github.com/dsccommunity/DscConfig.Demo/tree/main/source/DSCResources/LocalGroups
+| Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/LocalGroups
 | DSC Resource   | https://github.com/dsccommunity/xPSDesiredStateConfiguration[xPSDesiredStateConfiguration]
 | Documentation  | https://github.com/dsccommunity/xPSDesiredStateConfiguration/tree/main/source/DSCResources/DSC_xGroupResource[xGroup]
 |===
@@ -56,7 +56,7 @@
 |
 
 | Ensure
-|
+| 
 | String
 | Indicates if the group should exist or not.
 | - Absent
@@ -123,4 +123,4 @@ lookup_options:
     merge_options:
       tuple_keys:
         - GroupName
-----
+----