Adding documentation to release

Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt

@@ -8,14 +8,28 @@
     application. Alternatively a URL can be removed from a zone to ensure that it
     will remain empty and have no alternate URL.
 
+    The default value for the Ensure parameter is Present. When not specifying this
+    parameter, the setting is configured.
+
+    ## Central Administration
+
     To select the Central Administration site, use the following command to retrieve
     the correct web application name:
     (Get-SPWebApplication -IncludeCentralAdministration | Where-Object {
          $_.IsAdministrationWebApplication
      }).DisplayName
 
-    The default value for the Ensure parameter is Present. When not specifying this
-    parameter, the setting is configured.
+    To update the existing Default Zone AAM for Central Administration (e.g. to
+    implement HTTPS), use the above command to retrieve the web application name
+    (by default, it will be "SharePoint Central Administration v4") and specify
+    "Default" as the Zone. If you wish to add AAM's instead, you may use the other
+    zones to do so.
+
+    Using SPAlternateUrl to update the Default Zone AAM for Central Administration
+    will update the AAM in SharePoint as well as the CentralAdministrationUrl value
+    in the registry. It will not, however, update bindings in IIS. It is recommended
+    to use the xWebsite resource from the xWebAdministration module to configure the
+    appropriate bindings in IIS.
 
 .PARAMETER WebAppName
     Key - String

Modules/SharePointDsc/en-US/about_SPDistributedCacheClientSettings.help.txt

@@ -0,0 +1,196 @@
+.NAME
+    SPDistributedCacheClientSettings
+
+# Description
+
+    This resource is responsible for configuring the distributed cache client
+    settings. It only accepts Ensure='Present' as a key. The resource can
+    configure the following cache components: DistributedLogonTokenCache,
+    DistributedViewStateCache, DistributedAccessCache,
+    DistributedActivityFeedCache, DistributedActivityFeedLMTCache,
+    DistributedBouncerCache, DistributedDefaultCache, DistributedSearchCache,
+    DistributedSecurityTrimmingCache, and DistributedServerToAppServerAccessTokenCache.
+
+.PARAMETER IsSingleInstance
+    Key - String
+    Allowed values: Yes
+    Unique key for the resource. Set to 'Yes' to apply configuration.
+
+.PARAMETER DLTCMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Logon Token Cache
+
+.PARAMETER DLTCRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Logon Token Cache
+
+.PARAMETER DLTCChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Logon Token Cache
+
+.PARAMETER DVSCMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed View State Cache
+
+.PARAMETER DVSCRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed View State Cache
+
+.PARAMETER DVSCChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed View State Cache
+
+.PARAMETER DACMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Access Cache
+
+.PARAMETER DACRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Access Cache
+
+.PARAMETER DACChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Access Cache
+
+.PARAMETER DAFMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Activity Feed Cache
+
+.PARAMETER DAFRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Activity Feed Cache
+
+.PARAMETER DAFChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Activity Feed Cache
+
+.PARAMETER DAFCMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Activity Feed LMT Cache
+
+.PARAMETER DAFCRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Activity Feed LMT Cache
+
+.PARAMETER DAFCChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Activity Feed LMT Cache
+
+.PARAMETER DBCMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Bouncer Cache
+
+.PARAMETER DBCRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Bouncer Cache
+
+.PARAMETER DBCChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Bouncer Cache
+
+.PARAMETER DDCMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Default Cache
+
+.PARAMETER DDCRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Default Cache
+
+.PARAMETER DDCChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Default Cache
+
+.PARAMETER DSCMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Search Cache
+
+.PARAMETER DSCRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Search Cache
+
+.PARAMETER DSCChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Search Cache
+
+.PARAMETER DTCMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Security Trimming Cache
+
+.PARAMETER DTCRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Security Trimming Cache
+
+.PARAMETER DTCChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Security Trimming Cache
+
+.PARAMETER DSTACMaxConnectionsToServer
+    Write - UInt32
+    Maximum number of connections to the Distributed Server to Application Server Cache
+
+.PARAMETER DSTACRequestTimeout
+    Write - UInt32
+    Request timeout for the Distributed Server to Application Server Cache
+
+.PARAMETER DSTACChannelOpenTimeOut
+    Write - UInt32
+    Channel timeout for the Distributed Server to Application Server Cache
+
+.PARAMETER InstallAccount
+    Write - String
+    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
+
+
+.EXAMPLE
+    This example configures the distributed cache client settings.
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPDistributedCacheClientSettings Settings
+            {
+                IsSingleInstance            = "Yes"
+                DLTCMaxConnectionsToServer  = 3
+                DLTCRequestTimeout          = 1000
+                DLTCChannelOpenTimeOut      = 1000
+                DVSCMaxConnectionsToServer  = 3
+                DVSCRequestTimeout          = 1000
+                DVSCChannelOpenTimeOut      = 1000
+                DACMaxConnectionsToServer   = 3
+                DACRequestTimeout           = 1000
+                DACChannelOpenTimeOut       = 1000
+                DAFMaxConnectionsToServer   = 3
+                DAFRequestTimeout           = 1000
+                DAFChannelOpenTimeOut       = 1000
+                DAFCMaxConnectionsToServer  = 3
+                DAFCRequestTimeout          = 1000
+                DAFCChannelOpenTimeOut      = 1000
+                DBCMaxConnectionsToServer   = 3
+                DBCRequestTimeout           = 1000
+                DBCChannelOpenTimeOut       = 1000
+                DDCMaxConnectionsToServer   = 3
+                DDCRequestTimeout           = 1000
+                DDCChannelOpenTimeOut       = 1000
+                DSCMaxConnectionsToServer   = 3
+                DSCRequestTimeout           = 1000
+                DSCChannelOpenTimeOut       = 1000
+                DTCMaxConnectionsToServer   = 3
+                DTCRequestTimeout           = 1000
+                DTCChannelOpenTimeOut       = 1000
+                DSTACMaxConnectionsToServer = 3
+                DSTACRequestTimeout         = 1000
+                DSTACChannelOpenTimeOut     = 1000
+                PsDscRunAscredential        = $SetupAccount
+            }
+        }
+    }
+
+

Modules/SharePointDsc/en-US/about_SPTimerJobState.help.txt

@@ -33,7 +33,7 @@
 
 .PARAMETER WebAppUrl
     Key - String
-    The URL of the web application that the timer job belongs to, N/A if no web application is applicable
+    The URL of the web application that the timer job belongs to. Use the value 'N/A' if no web application is applicable
 
 .PARAMETER Enabled
     Write - Boolean

Modules/SharePointDsc/en-US/about_SPUserProfileServiceApp.help.txt

@@ -7,13 +7,26 @@
     farm. It creates the required databases using the parameters that are passed
     in to it (although these are only used during the initial provisioning).
 
-    The specified InstallAccount or PSDSCRunAsCredential has to be the Farm Account.
-    This is done to ensure that the databases are created with the correct schema
-    owners and allow the user profile sync service to operate correctly.
+    The specified InstallAccount or PSDSCRunAsCredential cannot be the Farm Account.
+    The resource will throw an error when it is.
+
+    To allow successful provisioning, the farm account must be in the local
+    administrators group, however it is not best practice to leave this account in
+    the Administrators group. Therefore this resource will add the Farm Account
+    credential to the local administrators group at the beginning of the set method
+    and remove it again later on.
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the service application is provisioned.
 
+    NOTE:
+    Due to the fact that SharePoint requires certain User Profile components to be
+    provisioned as the Farm account, this resource and SPUserProfileSyncService
+    retrieve the Farm account from the Managed Accounts.
+    This does however mean that CredSSP is required, which has some security
+    implications. More information about these risks can be found at:
+    http://www.powershellmagazine.com/2014/03/06/accidental-sabotage-beware-of-credssp/
+
 .PARAMETER Name
     Key - string
     The name of the user profile service

Modules/SharePointDsc/en-US/about_SPUserProfileSyncService.help.txt

@@ -7,19 +7,26 @@
     has been provisioned (Ensure = "Present") or is not running (Ensure =
     "Absent") on the current server.
 
-    This resource requires that the FarmAccount is specified as the InstallAccount
-    or PsDscRunAsCredential parameter. It will throw an exception if this is not
-    the case.
+    The specified InstallAccount or PSDSCRunAsCredential cannot be the Farm Account.
+    The resource will throw an error when it is.
 
-    To allow successful provisioning the farm account must be in the local
+    To allow successful provisioning, the farm account must be in the local
     administrators group, however it is not best practice to leave this account in
-    the Administrators group. Therefore this resource will add the FarmAccount
+    the Administrators group. Therefore this resource will add the Farm Account
     credential to the local administrators group at the beginning of the set method
     and remove it again later on.
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the user profile sync service is provisioned.
 
+    NOTE:
+    Due to the fact that SharePoint requires certain User Profile components to be
+    provisioned as the Farm account, this resource and SPUserProfileServiceApp
+    retrieve the Farm account from the Managed Accounts.
+    This does however mean that CredSSP is required, which has some security
+    implications. More information about these risks can be found at:
+    http://www.powershellmagazine.com/2014/03/06/accidental-sabotage-beware-of-credssp/
+
 .PARAMETER UserProfileServiceAppName
     Key - string
     The name of the user profile service for this sync instance
@@ -30,8 +37,8 @@
     Present to ensure the service is running, absent to ensure it is not
 
 .PARAMETER FarmAccount
-    Required - String
-    The farm account, which is needed to provision the service app
+    Write - String
+    PARAMETER IS NOT USED ANYMORE, WILL BE REMOVED IN V3.0
 
 .PARAMETER RunOnlyWhenWriteable
     Write - Boolean