Updated Help content

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

@@ -8,6 +8,12 @@
     application. Alternatively a URL can be removed from a zone to ensure that it
     will remain empty and have no alternate URL.
 
+    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.
 

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

@@ -12,11 +12,10 @@
     to configure all WFE servers in the farm, you have to apply this resource
     to all servers.
 
-    Note:
-
-    - In order to prevent inconsistancy between different web front end servers,
-      make sure you configure this setting on all servers equally.
-    - If the specified folder does not exist, the resource will create the folder.
+    NOTE:
+    In order to prevent inconsistancy between different web front end servers,
+    make sure you configure this setting on all servers equally.
+    If the specified folder does not exist, the resource will create the folder.
 
     Best practice:
     Specify a directory that is not on the same drive as where either the server

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

@@ -4,10 +4,12 @@
 # Description
 
     This resource is used to add and remove Content Databases to web applications
-    and configure these databases. Note: The resource cannot be used to move the
-    database to a different SQL instance. It will throw an error when it detects
-    that the specified SQL instance is a different instance that is currently in
-    use.
+    and configure these databases.
+
+    NOTE:
+    The resource cannot be used to move the database to a different SQL instance.
+    It will throw an error when it detects that the specified SQL instance is a
+    different instance that is currently in use.
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the content database is provisioned.

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

@@ -0,0 +1,62 @@
+.NAME
+    SPDiagnosticsProvider
+
+# Description
+
+    This resource is responsible for configuring the Diagnostics Provider within
+    the local SharePoint farm. Using Ensure equals to Absent is not supported.
+    This resource can only apply configuration, not ensure they don't exist.
+
+.PARAMETER Name
+    Key - string
+    Name of the Diagnostics Provider to configure
+
+.PARAMETER Retention
+    Write - Uint16
+    Sets the retention period in days
+
+.PARAMETER MaxTotalSizeInBytes
+    Write - Uint64
+    Sets the maximum retention size in bytes
+
+.PARAMETER Enabled
+    Write - Boolean
+    True enables the Diagnostics Provider
+
+.PARAMETER Ensure
+    Write - string
+    Allowed values: Present, Absent
+    Present to configure the diagnostics provider
+
+.PARAMETER InstallAccount
+    Write - String
+    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
+
+
+.EXAMPLE
+    This example shows how to configure the retention period for a Diagnostics Provider.
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPDiagnosticsProvider BlockingQueryProvider
+            {
+                Ensure               = "Present"
+                Name                 = "job-diagnostics-blocking-query-provider"
+                MaxTotalSizeInBytes  = 10000000000000
+                Retention            = 14
+                Enabled              = $true
+                PSDscRunAsCredential = $SetupAccount
+            }
+        }
+    }
+
+

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

@@ -0,0 +1,107 @@
+.NAME
+    SPInfoPathFormsServiceConfig
+
+# Description
+
+    This resource is responsible for configuring the InfoPath Forms service within
+    the local SharePoint farm. Using Ensure equals to Absent is not supported.
+    This resource can only apply configuration, not ensure they don't exist.
+
+.PARAMETER Ensure
+    Key - string
+    Allowed values: Present, Absent
+    Present ensures the settings are applied
+
+.PARAMETER AllowUserFormBrowserEnabling
+    Write - Boolean
+    True sets the InfoPath Forms Service to allow users to browse forms
+
+.PARAMETER AllowUserFormBrowserRendering
+    Write - Boolean
+    True sets the InfoPath Forms Service to render forms in the browser
+
+.PARAMETER MaxDataConnectionTimeout
+    Write - Uint32
+    Sets the maximum connection timeout in milliseconds
+
+.PARAMETER DefaultDataConnectionTimeout
+    Write - Uint32
+    Sets the default connection timeout in milliseconds
+
+.PARAMETER MaxDataConnectionResponseSize
+    Write - Uint32
+    Sets the maximum response size in kb for the user response
+
+.PARAMETER RequireSslForDataConnections
+    Write - Boolean
+    True sets the InfoPath Forms Service to require SSL for its connections
+
+.PARAMETER AllowEmbeddedSqlForDataConnections
+    Write - Boolean
+    True sets the InfoPath Forms Service to allow embedded SQL sonnections in Forms
+
+.PARAMETER AllowUdcAuthenticationForDataConnections
+    Write - Boolean
+    True sets the InfoPath Forms Service to allow User Defined connections
+
+.PARAMETER AllowUserFormCrossDomainDataConnections
+    Write - Boolean
+    True sets the InfoPath Forms Service to allow Cross-Domain connections
+
+.PARAMETER MaxPostbacksPerSession
+    Write - Uint16
+    Maximum number of postback allowed per session
+
+.PARAMETER MaxUserActionsPerPostback
+    Write - Uint16
+    Maximum number of actions that can be triggered per postback
+
+.PARAMETER ActiveSessionsTimeout
+    Write - Uint16
+    Timeout in minutes for active sessions
+
+.PARAMETER MaxSizeOfUserFormState
+    Write - Uint16
+    Maximum size of user session data
+
+.PARAMETER InstallAccount
+    Write - String
+    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
+
+
+.EXAMPLE
+    This example shows how to configure the InfoPath Forms Service
+    in the local SharePoint farm.
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPInfoPathFormsServiceConfig InfoPathFormsServiceConfig
+            {
+                Ensure                                   = "Present"
+                AllowUserFormBrowserEnabling             = $true
+                AllowUserFormBrowserRendering            = $true
+                MaxDataConnectionTimeout                 = 20000
+                DefaultDataConnectionTimeout             = 10000
+                MaxDataConnectionResponseSize            = 1500
+                RequireSslForDataConnections             = $true
+                AllowEmbeddedSqlForDataConnections       = $false
+                AllowUdcAuthenticationForDataConnections = $false
+                AllowUserFormCrossDomainDataConnections  = $false
+                MaxPostbacksPerSession                   = 75
+                MaxUserActionsPerPostback                = 200
+                ActiveSessionsTimeout                    = 1440
+                MaxSizeOfUserFormState                   = 4096
+            }
+        }
+    }
+
+

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

@@ -9,7 +9,8 @@
     file and validate the license key during the installation process. This module
     depends on the prerequisites already being installed, which can be done
 
-    NOTE: This resource only supports SharePoint Server. SharePoint Foundation
+    NOTE:
+    This resource only supports SharePoint Server. SharePoint Foundation
     is not supported. For examples to install SharePoint Foundation using DSC, see:
     https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3)
 

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

@@ -7,7 +7,8 @@
     as Office Web Apps). The DnsName property can be a single server name, or a
     FQDN of a load balanced end point that will direct traffic to a farm.
 
-    NOTE: This resource is designed to be used where all WOPI bindings will be
+    NOTE:
+    This resource is designed to be used where all WOPI bindings will be
     targeted to the same Office Online Server farm. If used on a clean
     environment, the new bindings will all point to the one DNS Name. If used on
     an existing configuration that does not follow this rule, it will match only

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

@@ -8,7 +8,8 @@
     You can control which AD groups should be imported from and control
     settings about reactivitating users.
 
-    Note: The schedule for this import is controlled via a standard
+    NOTE:
+    The schedule for this import is controlled via a standard
     SharePoint server timer job, and as such it can be controlled with
     the SPTimerJobState resource. Below is an example of how to set
     this resource to run the AD import job daily. The name of the job

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

@@ -6,7 +6,8 @@
     This resource is used to control settings that relate to the SharePoint sites
     that are linked to projects in Project Server.
 
-    NOTE: The account you use to run this resource (through either the InstallAccount
+    NOTE:
+    The account you use to run this resource (through either the InstallAccount
     or PsDscRunAsCredential properties) needs to have elevated rights to execute
     this resource. It is recommended to use the SharePoint Farm Account for this
     purpose to avoid receiving a "GeneralSecurityAccessDenied" error.

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

@@ -0,0 +1,92 @@
+.NAME
+    SPSearchAuthoritativePage
+
+# Description
+
+    This resource is responsible for managing the search authoritative pages in the
+    search service application. You can create new pages, change existing pages and
+    remove existing pages.
+
+    The default value for the Ensure parameter is Present. When you omit this
+    parameter the crawl rule is created.
+
+.PARAMETER ServiceAppName
+    Key - String
+    Search Service Application Name
+
+.PARAMETER Path
+    Key - String
+    Source URI for the authoritative page
+
+.PARAMETER Level
+    Write - Real32
+    Level of Authoratitive Page, values between 0.0 and 2.0
+
+.PARAMETER Action
+    Write - String
+    Allowed values: Authoratative, Demoted
+    The resource will either make the page authoritative or demoted based on this value
+
+.PARAMETER Ensure
+    Write - String
+    Allowed values: Present, Absent
+    Ensure the Authoritative is Present or Absent
+
+.PARAMETER InstallAccount
+    Write - String
+    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
+
+
+.EXAMPLE
+    This example shows how to create a Search Authoritative Page
+
+
+    Configuration Example 
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPSearchAuthoritativePage AuthoratativePage
+            {
+                ServiceAppName       = "Search Service Application"
+                Path                 = "http://site.sharepoint.com/Pages/authoritative.aspx"
+                Action               = "Authoratative"
+                Level                = 0.0
+                Ensure               = "Present"
+                PsDscRunAsCredential = $SetupAccount
+            }
+        }
+    }
+
+
+.EXAMPLE
+    This example shows how to create a Search Demoted Page
+
+
+    Configuration Example 
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPSearchAuthoritativePage AuthoratativePage
+            {
+                ServiceAppName       = "Search Service Application"
+                Path                 = "http://site.sharepoint.com/Pages/demoted.aspx"
+                Action               = "Demoted"
+                Ensure               = "Present"
+                PsDscRunAsCredential = $SetupAccount
+            }
+        }
+    }
+
+