readme.md

SP Starter Kit Provisioning Guidance

The following documentation provides guidance related to the the provisioning process of SP Starter Kit.

Minimal path to success

Open PowerShell and run the following commands, changing the tenant url to your primary SharePoint tenant site.

In order to succesfully install the SP Starter Kit you are required to install the latest PnP PowerShell (version 3.2.1810.0 or higher), which is done through

Install-Module -Name SharePointPnPPowerShellOnline

After successfully installing PnP PowerShell you need to connect to your tenant:

Connect-PnPOnline -Url https://[yourtenant].sharepoint.com

Then the easiest way to install the starter it is by entering:

Apply-PnPTenantTemplate -Path starterkit.pnp

Common notes

• By default the starter kit will create 3 site collections, using a common prefix of 'Contoso'. These sites will be called 'contosoportal' (a communications site), 'contosohr' and 'contosomarketing' (both team sites). If you want to provide different urls, use the apply cmdlet as follows:

Apply-PnPTenantTemplate -Path starterkit.pnp -Parameters @{"PORTALURL"="/sites/contosoportal"; "MARKETINGALIAS"="contosomarketing"; "HRALIAS"="contosohr" }

where you replace the values with your own. The PORTALURL parameter is the tenant relative url for your main site collection. The two alias parameters are used to create modern team sites with connected Office 365 unified groups.

• The tenant site you provide is only used to create the initial connection to your tenant. During application of SP Starter Kit 3 demo sites will be created within the tenant. If the site collections are in place it will reuse those site collections.

• The site hierarchy of the sites created by the deployment process will be read from the starterkit.pnp file. If you want to modify this hierarchy you will have to modify and repackage the starterkit.xml into a starterkit.pnp file, which you can do using

$kit = Read-PnPTenantTemplate -Path .\starterkit.xml
Save-PnPTenantTemplate -Hierarchy $kit -Out yourstarterkit.pnp

• Make sure that the credentials you use towards your tenat have tenant-admin rights. We require this to provision the taxonomy parts.

Fixing provisioning errors

• If you run into errors during provisioning, refer to 'Common SP Starter Kit Provisioning results' for additional suggestions and common mistakes

• Refer to the 'Issues List' to see if anyone else has run into a similar issue, and if so posisble paths to success

• 'Submit a new issue' if you are unable to find a solution to your specific error or question

Pre-providing credentials

Credentials may be provided via the command line, or by using the 'Windows credential manager'.

Credentials provided via command line

$creds = Get-Credential
Connect-PnPOnline https://[yourtenant].sharepoint.com -Credentials $creds
Apply-PnPTenantTemplate -Path .\starterkit.pnp

Provisioning Parameters

The deployment process may be configured with the following set of parameters that may be used in tandem with each other.

-Parameters

Optional

You can override certain parameters, being:

Company - defaults to "Contoso Electronics" SiteUrlPrefix - defaults to "Contoso" WeatherCity - defaults to "Seattle" StockSymbol - defaults to "MSFT"

Override one or more settings can be done like this:

Apply-PnPTenantTemplate -Path .\starterkit.pnp -Parameters @{"Company"="Your Company Name";"SiteUrlPrefix"="YourCompany";"WeatherCity"="Stockholm"}