Update documentation for 2.5 release

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

@@ -9,9 +9,9 @@
     catalog for the web application that the site is in. The catalog site needs to
     have been created using the correct template (APPCATALOG#0).
 
-    This resource should be run using the farm account, and not another specific
-    setup account. Running this with the setup account you have used in your
-    configuration may relate to access denied errors.
+    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

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

@@ -21,6 +21,12 @@
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the content database is added to the AAG.
 
+    Note:
+    By design the Add-DatabaseToAvailabilityGroup cmdlet updates the database
+    connection string to the specified availability group. If this is NOT what
+    you want (for example: You are using SQL aliasses which point to the AG
+    listener), you should NOT use this resource.
+
 .PARAMETER DatabaseName
     Key - string
     The name of the database to put in the AlwaysOn group

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

@@ -7,7 +7,8 @@
 
     This resource is used to trust a remote SharePoint farm. This is used when
     federating search results between two different SharePoint farms. The
-    technique is described at
+    technique is described at:
+    https://technet.microsoft.com/en-us/library/dn133749.aspx
 
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the remote farm trust is created.

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

@@ -21,7 +21,7 @@
 
 .PARAMETER InstallAccount
     Write - String
-    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5
+    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
 
 
 .EXAMPLE

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

@@ -66,6 +66,10 @@
     Write - Boolean
     Specify if all databases must get the same config as the general config
 
+.PARAMETER ExcludeDatabases
+    Write - String
+    Specify all databases that must be excluded from AllDatabases
+
 .PARAMETER InstallAccount
     Write - String
     POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
@@ -130,3 +134,30 @@
     }
 
 
+.EXAMPLE
+    This example gives admin access to the specified users for the local farm as
+    well as all content databases in the local farm, with the exception of database
+    WSS_Content_Portal.
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPShellAdmins ShellAdmins
+            {
+                Name             = "Shell Admins"
+                Members          = "CONTOSO\user1", "CONTOSO\user2"
+                AllDatabases     = $true
+                ExcludeDatabases = "WSS_Content_Portal"
+            }
+        }
+    }
+
+

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

@@ -105,3 +105,31 @@
     }
 
 
+.EXAMPLE
+    This example creates a site collection with the provided details
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPSite TeamSite
+            {
+                Url                      = "http://sharepoint.contoso.com"
+                OwnerAlias               = "CONTOSO\ExampleUser"
+                HostHeaderWebApplication = "http://spsites.contoso.com"
+                Name                     = "Team Sites"
+                Template                 = "STS#0"
+                QuotaTemplate            = "Teamsite"
+                PsDscRunAsCredential     = $SetupAccount
+            }
+        }
+    }
+
+

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

@@ -0,0 +1,70 @@
+.NAME
+    SPSiteUrl
+
+# Description
+
+    **Type:** Distributed
+
+    This resource will configure the site url for a host named site collection.
+    There are four available zones to configure: Intranet, Internet, Extranet
+    and Custom.
+
+    It is not possible to change the site url for the Default zone, since this
+    means changing the url that is used as identity. A site collection rename
+    is required for that:
+    $site = Get-SPSite "http://old.contoso.com"
+    $new = "http://new.contoso.com"
+    $site.Rename($new)
+    ((Get-SPSite $new).contentdatabase).RefreshSitesInConfigurationDatabase
+
+.PARAMETER Url
+    Key - string
+    The URL of the site collection
+
+.PARAMETER Intranet
+    Write - string
+    The URL of the Intranet zone
+
+.PARAMETER Internet
+    Write - string
+    The URL of the Internet zone
+
+.PARAMETER Extranet
+    Write - string
+    The URL of the Extranet zone
+
+.PARAMETER Custom
+    Write - string
+    The URL of the Custom zone
+
+.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 site collection urls for the specified
+    Host Named Site Collection
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPSiteUrl TeamSite
+            {
+                Url                  = "http://sharepoint.contoso.intra"
+                Intranet             = "http://sharepoint.contoso.com"
+                Internet             = "https://sharepoint.contoso.com"
+                PsDscRunAsCredential = $SetupAccount
+            }
+        }
+    }
+
+

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

@@ -21,6 +21,11 @@
     The default value for the Ensure parameter is Present. When not specifying this
     parameter, the service application is provisioned.
 
+    The parameter SiteNamingConflictResolution accepts three values: Username_CollisionError,
+    Username_CollisionDomain and Domain_Username. More information on each of these
+    parameters can be found at:
+    https://docs.microsoft.com/en-us/dotnet/api/microsoft.office.server.userprofiles.sitenameformat?view=sharepoint-server
+
     NOTE:
     Due to the fact that SharePoint requires certain User Profile components to be
     provisioned as the Farm account, this resource and SPUserProfileSyncService
@@ -81,6 +86,11 @@
     Write - boolean
     Specifies if the service application should be configured to use AD Import
 
+.PARAMETER SiteNamingConflictResolution
+    Write - string
+    Allowed values: Username_CollisionError, Username_CollisionDomain, Domain_Username
+    Specifies which SiteNamingConflictResolution should be used
+
 .PARAMETER Ensure
     Write - string
     Allowed values: Present, Absent
@@ -162,3 +172,41 @@
     }
 
 
+.EXAMPLE
+    This example adds a new user profile service application to the local farm
+
+
+    Configuration Example
+    {
+        param(
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $SetupAccount,
+
+            [Parameter(Mandatory = $true)]
+            [PSCredential]
+            $FarmAccount
+        )
+        Import-DscResource -ModuleName SharePointDsc
+
+        node localhost {
+            SPUserProfileServiceApp UserProfileServiceApp
+            {
+                Name                         = "User Profile Service Application"
+                ApplicationPool              = "SharePoint Service Applications"
+                MySiteHostLocation           = "http://my.sharepoint.contoso.local"
+                MySiteManagedPath            = "personal"
+                ProfileDBName                = "SP_UserProfiles"
+                ProfileDBServer              = "SQL.contoso.local\SQLINSTANCE"
+                SocialDBName                 = "SP_Social"
+                SocialDBServer               = "SQL.contoso.local\SQLINSTANCE"
+                SyncDBName                   = "SP_ProfileSync"
+                SyncDBServer                 = "SQL.contoso.local\SQLINSTANCE"
+                EnableNetBIOS                = $false
+                SiteNamingConflictResolution = "Domain_Username"
+                PsDscRunAsCredential         = $SetupAccount
+            }
+        }
+    }
+
+