Update Documentation (#198)

Co-authored-by: Jan-Hendrik Peters [MSFT] <[email protected]>

.build/FixEncoding.ps1

@@ -22,6 +22,7 @@ task FixEncoding {
     Get-ChildItem -Path $BuildModuleOutput -Filter *.psd1 -Recurse -File | ForEach-Object {
 
         Write-Build DarkGray "`t'$($_.FullName)'."
+        Set-ItemProperty -Path $_.FullName -Name IsReadOnly -Value $false
         $c = [System.IO.File]::ReadAllLines($_.FullName)
         [System.IO.File]::WriteAllLines($_.FullName, $c, $utf8NoBomEncoding)
     }

CHANGELOG.md

@@ -102,5 +102,6 @@ set to true when the LCM is already in ApplyAndAutoCorrect mode.
 - WindowsFeatures: Include support for more elaborate lists of features, giving
   more control.
 - Added task `FixEncoding` for being able to run the build on Windows PowerShell
-  due to an encoding issue with the psd1 file.
+  due to an encoding issue with the psd1 file
+- Add missing documentation
 - Added Read-Only Domaincontroller Variable to AddsDomainController

doc/HostsFileEntries.adoc

@@ -83,3 +83,18 @@ HostsFileEntries:
     - HostName:  server03
       Ensure:    Absent
 ----
+
+
+.Recommended Lookup Options in `Datum.yml` (Excerpt)
+[source, yaml]
+----
+lookup_options:
+
+  HostsFileEntries:
+    merge_hash: deep
+  HostsFileEntries\Entries:
+    merge_hash_array: UniqueKeyValTuples
+    merge_options:
+      tuple_keys:
+        - HostName
+----

doc/README.adoc

@@ -149,6 +149,7 @@ ifdef::env-github[]
 - <<RemoteDesktopCertificates.adoc#, RemoteDesktopCertificates>>
 - <<RemoteDesktopCollections.adoc#, RemoteDesktopCollections>>
 - <<RemoteDesktopDeployment.adoc#, RemoteDesktopDeployment>>
+- <<RemoteDesktopHAMode.adoc#, RemoteDesktopHAMode>>
 - <<RemoteDesktopLicensing.adoc#, RemoteDesktopLicensing>>
 - <<RestartSystem.adoc#, RestartSystem>>
 - <<Robocopies.adoc#, Robocopies>>
@@ -311,6 +312,7 @@ ifndef::env-github[]
 | <<dscyml_remotedesktopcertificates>>              | <<dscyml_remotedesktopcertificates_abstract>>
 | <<dscyml_remotedesktopcollections>>               | <<dscyml_remotedesktopcollections_abstract>>
 | <<dscyml_remotedesktopdeployment>>                | <<dscyml_remotedesktopdeployment_abstract>>
+| <<dscyml_remotedesktophamode>>                    | <<dscyml_remotedesktophamode_abstract>>
 | <<dscyml_remotedesktoplicensing>>                 | <<dscyml_remotedesktoplicensing_abstract>>
 | <<dscyml_restartsystem>>                          | <<dscyml_restartsystem_abstract>>
 | <<dscyml_robocopies>>                             | <<dscyml_robocopies_abstract>>
@@ -553,6 +555,8 @@ include::RemoteDesktopCollections.adoc[leveloffset=+1]
 <<<<
 include::RemoteDesktopDeployment.adoc[leveloffset=+1]
 <<<<
+include::RemoteDesktopHAMode.adoc[leveloffset=+1]
+<<<<
 include::RemoteDesktopLicensing.adoc[leveloffset=+1]
 <<<<
 include::RestartSystem.adoc[leveloffset=+1]

doc/RemoteDesktopHAMode.adoc

@@ -0,0 +1,78 @@
+// CommonTasks YAML Reference: RemoteDesktopHAMode
+// ===============================================
+
+:YmlCategory: RemoteDesktopHAMode
+
+:abstract:    {YmlCategory} is used to ###TBD###
+
+[#dscyml_remotedesktophamode]
+= DSC Resource '{YmlCategory}'
+
+[[dscyml_remotedesktophamode_abstract, {abstract}]]
+{abstract}
+
+
+[cols="1,3a" options="autowidth" caption=]
+|===
+| Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/RemoteDesktopHAMode
+| DSC Resource   | https://github.com/dsccommunity/xRemoteDesktopSessionHost[xRemoteDesktopSessionHost]
+| Documentation  | https://github.com/dsccommunity/xRemoteDesktopSessionHost#xrdconnectionbrokerhamode[xRDConnectionBrokerHAMode]
+|===
+
+
+.Attributes of category '{YmlCategory}'
+[cols="1,1,1,2a,1a" options="header"]
+|===
+| Parameter
+| Attribute
+| DataType
+| Description
+| Allowed Values
+
+| ConnectionBroker
+|
+| string
+| Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment.
+|
+
+| ClientAccessName
+| Mandatory
+| string
+| Specifies the FQDN of client access name.
+|
+
+| DatabaseConnectionString
+| Mandatory
+| string
+| Specifies the primary connection string to the database.
+|
+
+| DatabaseSecondaryConnectionString
+|
+| string
+| Specifies the secondary connection string to the database.
+|
+
+| DatabaseFilePath
+|
+| string
+| Specifies the database file path of SQL Server.
+|
+
+| Config
+|
+| hashtable
+|
+|
+
+|===
+
+
+.Example
+[source, yaml]
+----
+RemoteDesktopHAMode:
+  ConnectionBroker: RDCB01
+  ClientAccessName: CONTOSOFARM
+  DatabaseConnectionString: "DRIVER=ODBC Driver 17 for SQL Server;Server=DB01;Trusted_Connection=Yes;APP=Remote Desktop Services Connection Broker;DATABASE=RDS"
+----

doc/ScomComponents.adoc

@@ -16,7 +16,7 @@
 |===
 | Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ScomComponents
 | DSC Resource   | https://github.com/nyanhp/cScom[cScom]
-| Documentation  | https://github.com/nyanhp/cScom/blob/main/cScom/DscResources/JHP_ScomComponent.psm1[ScomComponent]
+| Documentation  | https://github.com/nyanhp/cScom/blob/main/cScom/resources/JHP_ScomComponent.ps1[ScomComponent]
 
 |===
 

doc/ScomManagementPacks.adoc

@@ -16,7 +16,7 @@
 |===
 | Source         | https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/ScomManagementPacks
 | DSC Resource   | https://github.com/nyanhp/cScom[cScom]
-| Documentation  | https://github.com/nyanhp/cScom/blob/main/cScom/DscResources/JHP_ScomManagementPack.psm1[ScomManagementPack]
+| Documentation  | https://github.com/nyanhp/cScom/blob/main/cScom/resources/JHP_ScomManagementPack.ps1[ScomManagementPack]
 
 |===