Updated help files

dsccommunity · Aug 7, 2019 · b313dc6 · b313dc6
1 parent 881ea36
commit b313dc6
Show file tree

Hide file tree

Showing 120 changed files with 934 additions and 985 deletions.
diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServiceApp.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAccessServiceApp
 
 # Description
@@ -12,7 +12,7 @@
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the service application is provisioned.
-    
+
 .PARAMETER Name
     Key - string
     The name of the service application
@@ -34,10 +34,9 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to deploy Access Services 2013 to the local SharePoint farm.
-
+This example shows how to deploy Access Services 2013 to the local SharePoint farm.
 
     Configuration Example 
     {
@@ -59,14 +58,13 @@
         }
     }
 
+.EXAMPLE 2
 
-.EXAMPLE
-
-    This example shows how to remove a specific Access Services 2013 from the local 
-    SharePoint farm. Because Application pool and database server are both required
-    parameters, but are not acutally needed to remove the app, any text value can 
-    be supplied for these as they will be ignored. 
 
+This example shows how to remove a specific Access Services 2013 from the local 
+SharePoint farm. Because Application pool and database server are both required
+parameters, but are not acutally needed to remove the app, any text value can 
+be supplied for these as they will be ignored. 
 
     Configuration Example 
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt b/Modules/SharePointDsc/en-US/about_SPAccessServices2010.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAccessServices2010
 
 # Description
@@ -12,7 +12,7 @@
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the service application is provisioned.
-    
+
 .PARAMETER Name
     Key - String
     The name of the service application

diff --git a/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt b/Modules/SharePointDsc/en-US/about_SPAlternateUrl.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAlternateUrl
 
 # Description
@@ -33,7 +33,7 @@
     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
     The name of the web application to apply the alternate URL to
@@ -60,10 +60,9 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to add a new alternate URL to a specific web application
-
+This example shows how to add a new alternate URL to a specific web application
 
     Configuration Example 
     {
@@ -87,11 +86,10 @@
         }
     }
 
+.EXAMPLE 2
 
-.EXAMPLE
-    This example shows how to remove an alternate URL from a specified zone for a specific
-    web application.
-
+This example shows how to remove an alternate URL from a specified zone for a specific
+web application.
 
     Configuration Example 
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAntivirusSettings.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAntivirusSettings
 
 # Description
@@ -11,7 +11,7 @@
     scanning tool that is able to integrate with SharePoint. Note that this will
     not scan documents for viruses on it's own, an external tool still needs to be
     installed on the servers that integrates with SharePoint.
-    
+
 .PARAMETER IsSingleInstance
     Key - String
     Allowed values: Yes
@@ -45,10 +45,9 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to apply specific anti-virus configuration to the farm
-
+This example shows how to apply specific anti-virus configuration to the farm
 
     Configuration Example
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt b/Modules/SharePointDsc/en-US/about_SPAppCatalog.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAppCatalog
 
 # Description
@@ -13,7 +13,7 @@
     This resource should NOT be run using the farm account. The resource will
     retrieve the farm credentials from SharePoint and use that to update the
     AppCatalog. This does mean it requires CredSSP to be setup!
-    
+
 .PARAMETER SiteUrl
     Key - string
     The URL of the site collection that will be the app catalog for the web app that it is in
@@ -22,10 +22,9 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to configure the AppCatalog in the farm
-
+This example shows how to configure the AppCatalog in the farm
 
     Configuration Example 
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt b/Modules/SharePointDsc/en-US/about_SPAppDomain.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAppDomain
 
 # Description
@@ -8,7 +8,7 @@
 
     This resource will set the value for the app domain settings at the farm level.
     You can set the domain name and the prefix that is to be used for app URLs.
-    
+
 .PARAMETER AppDomain
     Key - string
     The domain name for apps to use in this farm
@@ -21,10 +21,9 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to apply app URLs to the current farm. 
-
+This example shows how to apply app URLs to the current farm. 
 
     Configuration Example 
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPAppManagementServiceApp.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAppManagementServiceApp
 
 # Description
@@ -17,7 +17,7 @@
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the service application is provisioned.
-    
+
 .PARAMETER Name
     Key - string
     The name of the app management service application
@@ -47,11 +47,10 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to create a new app management service application in the 
-    local SharePoint farm.
-
+This example shows how to create a new app management service application in the 
+local SharePoint farm.
 
     Configuration Example 
     {
@@ -74,12 +73,11 @@
         }
     }
 
+.EXAMPLE 2
 
-.EXAMPLE
-    This example shows how to remove a specific app management service application in the 
-    local SharePoint farm. The application pool property is still mandatory but it is not
-    used so therefore the value is not important. 
-
+This example shows how to remove a specific app management service application in the 
+local SharePoint farm. The application pool property is still mandatory but it is not
+used so therefore the value is not important. 
 
     Configuration Example 
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPAppStoreSettings.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAppStoreSettings
 
 # Description
@@ -8,7 +8,7 @@
 
     This resource will configure the ability to purchase apps for both SharePoint
     and Office apps.
-    
+
 .PARAMETER WebAppUrl
     Key - string
     The URL of the web application
@@ -25,10 +25,9 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to configure the AppCatalog in the farm
-
+This example shows how to configure the AppCatalog in the farm
 
     Configuration Example 
     {
@@ -49,10 +48,9 @@
         }
     }
 
+.EXAMPLE 2
 
-.EXAMPLE
-    This example shows how to configure the AppCatalog in the farm
-
+This example shows how to configure the AppCatalog in the farm
 
     Configuration Example 
     {
@@ -74,10 +72,9 @@
         }
     }
 
+.EXAMPLE 3
 
-.EXAMPLE
-    This example shows how to configure the AppCatalog in the farm
-
+This example shows how to configure the AppCatalog in the farm
 
     Configuration Example 
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPAuthenticationRealm.help.txt b/Modules/SharePointDsc/en-US/about_SPAuthenticationRealm.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPAuthenticationRealm
 
 # Description
@@ -15,7 +15,7 @@
     SharePoint automatically converts the realm to lower case ASCII printable characters.
     The specified authentication realm must therefore conform to this for the test
     method to be able to detect a correct configuration.
-    
+
 .PARAMETER IsSingleInstance
     Key - String
     Allowed values: Yes
@@ -29,10 +29,9 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example sets the farm atuhentication realm.
-
+This example sets the farm atuhentication realm.
 
     Configuration Example
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt b/Modules/SharePointDsc/en-US/about_SPBCSServiceApp.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPBCSServiceApp
 
 # Description
@@ -17,7 +17,7 @@
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the service application is provisioned.
-    
+
 .PARAMETER Name
     Key - string
     The name of the BCS service app
@@ -47,11 +47,10 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to deploy a Business Connectivity Services application to the
-    local SharePoint farm.
-
+This example shows how to deploy a Business Connectivity Services application to the
+local SharePoint farm.
 
     Configuration Example
     {
@@ -74,12 +73,11 @@
         }
     }
 
+.EXAMPLE 2
 
-.EXAMPLE
-    This example shows how to deploy a Business Connectivity Services application to the
-    local SharePoint farm. The application pool account is mandatory but the value is 
-    ignored when removing a service app, so the value entered here does not matter. 
-
+This example shows how to deploy a Business Connectivity Services application to the
+local SharePoint farm. The application pool account is mandatory but the value is 
+ignored when removing a service app, so the value entered here does not matter. 
 
     Configuration Example 
     {

diff --git a/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt b/Modules/SharePointDsc/en-US/about_SPBlobCacheSettings.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     SPBlobCacheSettings
 
 # Description
@@ -23,7 +23,7 @@
     Best practice:
     Specify a directory that is not on the same drive as where either the server
     operating system swap files or server log files are stored.
-    
+
 .PARAMETER WebAppUrl
     Key - string
     The URL of the web application
@@ -57,11 +57,10 @@
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
+.EXAMPLE 1
 
-.EXAMPLE
-    This example shows how to configure the blob cache settings on the local server for the
-    specified web application and zone 
-
+This example shows how to configure the blob cache settings on the local server for the
+specified web application and zone 
 
     Configuration Example 
     {