Skip to content

Commit ab8d66a

Browse files
Docupdate opensource pnp (SharePoint#5837)
* update open source PNP includes to include URLs to project home * add includes for open source pnp projects - added include for PnP Provisioning Engine - added include for PnP Sites Core * add open source support disclaimer for PnP PowerShell * add open source support disclaimer for O365 CLI * add open source disclaimer for PnP Provisioning Framework, Schema & Engine * add open source disclaimer for PnPJS * Address build report errors * add open source disclaimer - add disclaimer to ALM APIs for PnP CSOM * add includes for open source pnp projects - added include for PnP Provisioning Engine - added include for PnP Sites Core * add open source support disclaimer for PnP PowerShell * add open source support disclaimer for O365 CLI * update ALM API - fix broken submission Co-authored-by: Vesa Juvonen <[email protected]>
1 parent ea80ad0 commit ab8d66a

File tree

50 files changed

+538
-479
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+538
-479
lines changed

docs/apis/alm-api-for-spfx-add-ins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -627,4 +627,4 @@ Sync-PnPAppToTeams -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx
627627

628628
- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)
629629
- [PnP PowerShell](https://aka.ms/sppnp-powershell)
630-
- [Office 365 CLI](https://pnp.github.io/office365-cli?utm_source=msft_docs&utm_medium=page&utm_campaign=Use+SharePoint+Online+tenant+properties)
630+
- [Office 365 CLI](https://pnp.github.io/office365-cli?utm_source=msft_docs&utm_medium=page&utm_campaign=Use+SharePoint+Online+tenant+properties)

docs/apis/site-creation-rest.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Create Modern SharePoint Sites using REST
33
description: Create and get the status of a new modern SharePoint site by using the REST interface.
4-
ms.date: 4/19/2018
4+
ms.date: 06/05/2020
55
ms.prod: sharepoint
66
localization_priority: Priority
77
---
88

99
# Manage modern SharePoint sites using REST
1010

11-
This topic assumes that you are already familiar with the following topics:
11+
This topic assumes that you are already familiar with the following topics:
1212

1313
- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)
1414
- [Complete basic operations using SharePoint REST endpoints](../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md)
@@ -29,8 +29,8 @@ Using the following REST api you can create both Communication sites and non-gro
2929

3030
To specify which type of site to create you use the WebTemplate attribute. Use one of the following templates to select which type of site to create:
3131

32-
* Communication Site: `SITEPAGEPUBLISHING#0`
33-
* non-group associated Team Site: `STS#3`
32+
- Communication Site: `SITEPAGEPUBLISHING#0`
33+
- non-group associated Team Site: `STS#3`
3434

3535
```json
3636
url: /_api/SPSiteManager/create
@@ -63,6 +63,8 @@ The site design id can be retrieved by using the [Get-SPOSiteDesign](/powershell
6363
- Showcase: `6142d2a0-63a5-4ba0-aede-d9fefca2c767`
6464
- Blank: `f6cc5403-0d63-442e-96c0-285923709ffc`
6565

66+
[!INCLUDE [pnp-powershell](../../includes/snippets/open-source/pnp-powershell.md)]
67+
6668
### Response
6769

6870
If successful, this method returns a `200, OK` response code and simple JSON object in the response body with the following details.
@@ -108,7 +110,7 @@ body: none
108110
### Response
109111

110112
If successful, this method returns a `200, OK` response code and simple JSON object in the response body with the following details.
111-
113+
112114
If the site exists, the response returns the site status and site URL:
113115

114116
```json
@@ -123,7 +125,7 @@ If the site exists, the response returns the site status and site URL:
123125
If the site does not exist, the response returns a site status of 0 with no URL and no site id.
124126

125127
```json
126-
{
128+
{
127129
"SiteId":,
128130
"SiteStatus":0,
129131
"SiteUrl":

docs/declarative-customization/site-design-o365cli.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: SharePoint site design - Office 365 CLI commands
33
description: Use the Office 365 CLI to create, retrieve, and remove site designs and site scripts.
4-
ms.date: 10/23/2018
4+
ms.date: 06/05/2020
55
localization_priority: Priority
66
---
77

88
# SharePoint site design: Office 365 CLI commands
99

1010
Use the Office 365 CLI to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections from any platform.
1111

12-
> [!NOTE]
13-
> Office 365 CLI is an open-source tool with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
12+
[!INCLUDE [pnp-o365cli](../../includes/snippets/open-source/pnp-o365cli.md)]
1413

1514
## Getting started
1615

docs/declarative-customization/site-design-pnp-provisioning.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Calling the PnP provisioning engine from a site script
33
description: Build a complete SharePoint site design using the PnP provisioning engine
4-
ms.date: 03/24/2020
4+
ms.date: 06/05/2020
55
localization_priority: Priority
66
---
77

88
# Calling the PnP provisioning engine from a site script
99

10-
Site designs offer a great way to standardize the look and feel of your site collections. However, you can't do some things with site designs, like add a footer to every page. You can use the PnP provisioning engine to create a template that you can use to provision an Application Customizer to a site. This Application Customizer can then update your page design, for example to register a footer on every page.
10+
Site designs offer a great way to standardize the look and feel of your site collections. However, you can't do some things with site designs, like add a footer to every page. You can use the PnP provisioning engine to create a template that you can use to provision an Application Customizer to a site. This Application Customizer can then update your page design, for example to register a footer on every page.
1111

1212
This article describes how to create a site design that applies a PnP provisioning template to a site. The template will add an Application Customizer to render a footer.
1313

@@ -24,28 +24,27 @@ The steps in this article use the following components:
2424

2525
You'll use these components to trigger the PnP provisioning code after you create the site and apply the site design.
2626

27-
> [!NOTE]
28-
> PnP Provisioning Engine is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
27+
[!INCLUDE [pnp-provisioning-engine](../../includes/snippets/open-source/pnp-provisioning-engine.md)]
2928

3029
## Set up app-only access to your tenant
3130

3231
To set up app-only access, you need to have two different pages on your tenant&mdash;one on the regular site, and the other on your SharePoint administration site.
3332

34-
1. Go to following URL in your tenant: `https://[yourtenant].sharepoint.com/_layouts/15/appregnew.aspx` (you can go to any site, but for now pick the root site).
33+
1. Go to following URL in your tenant: `https://[yourtenant].sharepoint.com/_layouts/15/appregnew.aspx` (you can go to any site, but for now pick the root site).
3534

36-
2. Next to the **Client Id** and **Client Secret** fields, choose the **Generate** button.
35+
2. Next to the **Client Id** and **Client Secret** fields, choose the **Generate** button.
3736

38-
3. Enter a title for your app, such as **Site Provisioning**.
37+
3. Enter a title for your app, such as **Site Provisioning**.
3938

40-
4. In the **App Domain** box, enter **localhost**.
39+
4. In the **App Domain** box, enter **localhost**.
4140

42-
5. In the **Redirect URI** box, enter **https://localhost**.
41+
5. In the **Redirect URI** box, enter **https://localhost**.
4342

4443
![Create app page, showing the Client Id, Client Secret, Title, App Domain, and Redirect URI fields](images/pnpprovisioning-createapponly.png)
4544

46-
6. Choose **Create**.
45+
6. Choose **Create**.
4746

48-
7. Copy the values for **Client Id** and **Client Secret** because you will need them later.
47+
7. Copy the values for **Client Id** and **Client Secret** because you will need them later.
4948

5049
<br/>
5150

@@ -67,7 +66,7 @@ Next, trust the app, so that it has the appropriate access to your tenant:
6766

6867
## Create the Azure Queue storage
6968

70-
In this section, you will use Azure Queue storage to receive messages from Power Automate. Every time a message shows up in the Queue storage, an Azure function is triggered to run a PowerShell script.
69+
In this section, you will use Azure Queue storage to receive messages from Power Automate. Every time a message shows up in the Queue storage, an Azure function is triggered to run a PowerShell script.
7170

7271
To set up the Azure Queue storage:
7372

@@ -83,7 +82,7 @@ To set up the Azure Queue storage:
8382

8483
## Create the flow
8584

86-
To put a message in the queue, you need to create a flow.
85+
To put a message in the queue, you need to create a flow.
8786

8887
1. Go to the [Power Automate](https://flow.microsoft.com) site, sign in, and choose **Create from Blank** at the top of the page.
8988
1. Choose **Search hundreds of connectors and triggers** to select your trigger.
@@ -110,7 +109,7 @@ To put a message in the queue, you need to create a flow.
110109
}
111110
}
112111
}
113-
```
112+
```
114113

115114
1. Select **+ New Step** and choose **Add an action**.
116115
1. Search for **Azure Queues** and select **Azure Queues - Put a message on a queue**.
@@ -186,14 +185,14 @@ Copy the following provisioning template XML to a new file and save the file as
186185

187186
![Screenshot of the Azure portal with the new Queue Triggered function highlighted](images/pnpprovisioning-create-function-queue.png)
188187

189-
1. Name the function **ApplyPnPProvisioningTemplate**.
188+
1. Name the function **ApplyPnPProvisioningTemplate**.
190189
1. Enter the name of the queue you created earlier.
191-
1. Choose **Create**. An editor where you can enter PowerShell cmdlets will open.
190+
1. Choose **Create**. An editor where you can enter PowerShell cmdlets will open.
192191

193192
Next, you'll upload the PnP PowerShell module so that you can use it in the Azure Function.
194193

195194
> [!NOTE]
196-
> The Storage account must be in the same region as of Azure Function App, because the resources that talk to one another should be co-located in the same region. This is a requirement for Azure Functions.
195+
> The Storage account must be in the same region as of Azure Function App, because the resources that talk to one another should be co-located in the same region. This is a requirement for Azure Functions.
197196
198197
## Upload the PnP PowerShell module for your Azure Function
199198

@@ -205,7 +204,7 @@ You'll need to download the PnP PowerShell module so that you can upload it for
205204
Save-Module -Name SharePointPnPPowerShellOnline -Path [pathtoyourfolder]
206205
```
207206
208-
The PowerShell module files will download to a folder within the folder that you created.
207+
The PowerShell module files will download to a folder within the folder that you created.
209208
210209
Next, upload the files so that your Azure Function can use the module.
211210
@@ -220,11 +219,11 @@ Next, upload the files so that your Azure Function can use the module.
220219
1. On the main Kudu page, select **Debug Console** and pick either **CMD** or **PowerShell**.
221220
1. Choose the file explorer on the upper part of the page, and go to **site\wwwroot\\[nameofyourazurefunction]**.
222221
1. Create a new folder named **modules**.
223-
222+
224223
![Screenshot with the new folder option highlighted](images/pnpprovisioning-kudu-create-folder.png)
225224
226225
1. In the modules folder, create another folder called **SharePointPnPPowerShellOnline** and go to that folder.
227-
1. In File Explorer on your computer, go to the folder where you downloaded the PnP PowerShell module files. Open the
226+
1. In File Explorer on your computer, go to the folder where you downloaded the PnP PowerShell module files. Open the
228227
**SharePointPnPPowerShellOnline\2.20.1711.0** folder (notice that the version number might be different).
229228
1. Drag and drop all the files from this folder into the folder in Kudu to upload them.
230229
@@ -262,7 +261,7 @@ Connect to your tenant using **Connect-SPOService**.
262261
Connect-SPOService -Url https://[yourtenant]-admin.sharepoint.com
263262
```
264263

265-
Now you can get the existing site designs.
264+
Now you can get the existing site designs.
266265

267266
```powershell
268267
Get-SPOSiteDesign
@@ -313,7 +312,7 @@ The **Add-SPOSiteDesign** cmdlet associates the site design with the team site.
313312

314313
## Verify the results
315314

316-
After you created your Azure Queue storage, you created the app ID for app-only access, the Azure Function, and the site design. You then triggered the Power Automate flow from the site design.
315+
After you created your Azure Queue storage, you created the app ID for app-only access, the Azure Function, and the site design. You then triggered the Power Automate flow from the site design.
317316

318317
To test the results, create a new site. In your SharePoint tenant, select **SharePoint** > **Create Site** > **Team Site**. Your new site design should show up as a design option. Notice that the site design is applied after the site is created. If you configured it correctly, your flow will be triggered. You can check the run history of the flow to verify that it ran correctly. Note that the footer might not show up immediately; if you don't see it, wait a minute and reload your site to check again.
319318

docs/declarative-customization/site-design-pnppowershell.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: SharePoint site design - PnP PowerShell cmdlets
33
description: Use PnP PowerShell cmdlets to create, retrieve, and remove site designs and site scripts.
4-
ms.date: 01/18/2019
4+
ms.date: 06/05/2020
55
localization_priority: Priority
66
---
77

88
# SharePoint site design: PnP PowerShell cmdlets
99

1010
Use PnP PowerShell cmdlets to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections.
1111

12-
> [!NOTE]
13-
> PnP PowerShell is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
12+
[!INCLUDE [pnp-powershell](../../includes/snippets/open-source/pnp-powershell.md)]
1413

1514
## Getting started
1615

docs/declarative-customization/site-design-powershell.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
---
22
title: SharePoint site design - PowerShell cmdlets
33
description: Use PowerShell cmdlets to create, retrieve, and remove site designs and site scripts.
4-
ms.date: 10/23/2018
4+
ms.date: 06/05/2020
55
localization_priority: Priority
66
---
77

88
# SharePoint site design: PowerShell cmdlets
99

10-
> [!NOTE]
11-
> Site designs and site scripts have been released to production and are available for general use.
12-
1310
Use PowerShell cmdlets to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections.
1411

1512
## Getting started
@@ -46,6 +43,7 @@ The following cmdlets are available for managing site designs and site scripts f
4643
- [Set-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOSiteDesign?view=sharepoint-ps)
4744
- [Set-SPOSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOSiteScript?view=sharepoint-ps)
4845

46+
[!INCLUDE [pnp-powershell](../../includes/snippets/open-source/pnp-powershell.md)]
4947

5048
## See also
5149

docs/declarative-customization/site-theming/sharepoint-site-theming-overview.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: SharePoint site theming
33
description: New options for applying custom styles and colors to sites that make it easier to define and manage themes across site collections.
4-
ms.date: 04/19/2018
4+
ms.date: 06/05/2020
55
localization_priority: Priority
66
---
77

@@ -75,6 +75,8 @@ To do this, you must use a Windows PowerShell script with a CSOM (client-side ob
7575

7676
2. Download the latest PnP PowerShell from https://github.com/SharePoint/PnP-PowerShell/releases.
7777

78+
[!INCLUDE [pnp-powershell](../../../includes/snippets/open-source/pnp-powershell.md)]
79+
7880
3. Enter `Connect-PnPOnline -Url <SiteUrl> -UseWebLogin` (replacing `<SiteUrl>` with the url of the site you wish to opt out of).
7981

8082
4. Enter your credentials when prompted.

docs/features/hub-site/create-hub-site-with-powershell.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create SharePoint hub sites using PowerShell
33
description: Example code for creating a SharePoint hub site by using PowerShell.
4-
ms.date: 6/20/2019
4+
ms.date: 06/05/2020
55
localization_priority: Priority
66
---
77

@@ -22,6 +22,8 @@ The samples below can be performed using [PnP PowerShell](https://www.powershell
2222
> [!NOTE]
2323
> In the remainder of this exercise, **contoso** will be used as the tenant name. Continue to use your own tenant name in place of **contoso**.
2424
25+
[!INCLUDE [pnp-powershell](../../../includes/snippets/open-source/pnp-powershell.md)]
26+
2527
## Create a new hub site
2628

2729
First, we will create the marketing site that will serve as a hub site that other sites can associate with. The intent is that any sites that are marketing-oriented will be part of the hub site. This applies common navigation and branding across the associated sites, enables team members to search across all the sites associated with the single hub site, and takes advantage of other hub site features.

docs/features/hub-site/hub-site-o365cli.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: Office 365 CLI commands for SharePoint hub sites
33
description: Use Office 365 CLI to create and manage SharePoint hub sites.
4-
ms.date: 6/18/2019
4+
ms.date: 06/05/2020
55
localization_priority: Priority
66
---
77

88
# Office 365 CLI commands for SharePoint hub sites
99

1010
Use the Office 365 CLI commands to create and manage SharePoint hub sites.
1111

12-
> [!NOTE]
13-
> Office 365 CLI is an open-source tool with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
12+
[!INCLUDE [pnp-o365cli](../../../includes/snippets/open-source/pnp-o365cli.md)]
1413

1514
## Get started
1615

docs/features/site-footer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Set-PnPFooter -Enabled:$false
3434
> [!NOTE]
3535
> Above PowerShell scripts assumes that you have already installed PnP PowerShell cmdlets for your environment and you are not using multi-factor authentication. You can install PnP PowerShell cmdlets to your computer by opening PowerShell console in administrative mode and executing following command: `Install-Module SharePointPnPPowerShellOnline`. If you are using multi-factor authentication, you can enable MFA login by updating the `Connect-PnPOnline` line as follows: `Connect-PnPOnline -Url "<SiteURL>" -UseWebLogin`.
3636
37+
[!INCLUDE [pnp-powershell](../../includes/snippets/open-source/pnp-powershell.md)]
38+
3739
## Controlling footer using the user interface
3840

3941
Site owner can control the footer visibility using the **Change the look** functionality of the site, which exposes the different user interface configuration options.

0 commit comments

Comments
 (0)