Skip to content

Commit 2a785c2

Browse files
committed
Provisioning documentation polishing and adding two new articles to TOC
1 parent 7728f8a commit 2a785c2

9 files changed

+33
-5
lines changed

docs/solution-guidance/Introducing-the-PnP-Provisioning-Engine.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ localization_priority: Priority
99

1010
This article introduces the PnP provisioning engine, which was originally released in April 2015 within the [OfficeDev PnP](../community/community.md) project, and which is updated on a monthly basis in alignment with the release schedule of the Office Dev PnP Core Library.
1111

12+
> [!NOTE]
13+
> PnP remote provisioning is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
1215
<a name="thegoal"> </a>
1316

1417
## The goal

docs/solution-guidance/pnp-provisioning-engine-and-the-core-library.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ localization_priority: Priority
77

88
# PnP provisioning engine and the Core library
99

10-
The PnP provisioning engine is the heart of the provisioning framework, and at its foundation is the OfficeDevPnP.Core library. The provisioning engine is part of the Core library and it leverages the Core library extensions in the implementation of provisioning tasks.
10+
The PnP provisioning engine is the heart of the provisioning framework, and at its foundation is the OfficeDevPnP.Core library. The provisioning engine is part of the Core library and it leverages the Core library extensions in the implementation of provisioning tasks.
11+
12+
> [!NOTE]
13+
> PnP remote provisioning is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
1115

1216
Comprised of extension methods on the SharePoint CSOM/REST object model, the Core library enables provisioning tasks such as enumerating and getting provisioning templates as well as storing and then applying templates to new and existing sites. It also allows you to automate provisioning tasks and to introduce coded logic into your provisioning routines.
1317

docs/solution-guidance/pnp-provisioning-framework.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ localization_priority: Priority
99

1010
The PnP provisioning framework provides a code-centric and template-based platform for provisioning your site collections. The new provisioning engine allows you to persist and reuse provisioning models in Office 365 and SharePoint Online as well as on-premises site collections.
1111

12+
> [!NOTE]
13+
> PnP remote provisioning is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
1215
## Why the new approach?
1316

1417
With the introduction of SharePoint Add-ins and the add-in model (formerly known as the "app model"), Microsoft has moved away from sandboxed and full-trust solutions in favor of provider-hosted add-ins and on-premises solutions. These innovations have driven a retooling of the provisioning model and the introduction of a new provisioning engine.

docs/solution-guidance/pnp-provisioning-schema.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ localization_priority: Priority
99

1010
As you learned in [PnP provisioning framework](pnp-provisioning-framework.md) and elsewhere, the format for provisioning templates has been decoupled from the persistence format so that you can use any format you prefer. Nevertheless, because using the XML provisioning schema for persisting templates is such a common scenario, we're providing some additional information about how to use the XML schema to serialize and save your provisioning templates.
1111

12+
> [!NOTE]
13+
> PnP remote provisioning is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
1215
> [!IMPORTANT]
1316
> While the provisioning schema obviously supports XML serialization of provisioning templates, it also provides the structure for serialization in JSON format. More generally, the schema provides the model for defining provisioning structures.
1417

docs/solution-guidance/pnp-provisioning-tenant-templates.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ localization_priority: Priority
99

1010
Think of Tenant Templates as an extension on top of PnP Provisioning or Site Templates. Instead of just provisioning artifacts to a site, you can now create sites, create teams, provision Azure AD entries, provision taxonomy etc.
1111

12+
> [!NOTE]
13+
> PnP Provisioning Tenant Templates is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
1215
> [!NOTE]
1316
> A good resource for tenant templates is the [PnP Provisioning Templates Repository](https://github.com/sharepoint/sp-dev-provisioning-templates) which contains all the templates used in the lookbook service at https://lookbook.microsoft.com. You'll find a tenant folder, and in there several folders, each containing a template. In the subfolders you will find a source folder. In the source folder you'll find a template.xml file which is a tenant template.
1417
15-
1618
## The Sequence
1719

1820
A sequence is a driver to create site collections and optional subsites. Notice that a sequence is only able to create so-called 'modern site': a communication site, a modern team site with a connected O365 group or a modern team without a connected O365 group.
@@ -73,7 +75,7 @@ You can easily configure a team to be created:
7375

7476
The above sample creates a team, adds a channel, and adds 2 tabs to the channel.
7577

76-
## See also
78+
## See also
7779

7880
- [SharePoint Patterns and Practices](https://github.com/SharePoint/PnP/)
7981
- [SharePoint Developer Group at Microsoft Tech Community](https://techcommunity.microsoft.com/t5/SharePoint-Developer/bd-p/SharePointDev)

docs/solution-guidance/pnp-remote-provisioning.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ localization_priority: Priority
99

1010
The current recommendation when it comes to provisioning artifacts like sites, lists, content types, pages is to use something called "remote provisioning". In a nutshell, remote provisioning means that you utilize one of the available APIs (SharePoint REST, the SharePoint Client Side Object Model or the Microsoft Graph) to create those artifacts. Your code runs on your own machine or on a separate server.
1111

12+
> [!NOTE]
13+
> PnP remote provisioning is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
1215
In order for you to create a repeatable process, with known parameters, the [SharePoint Developer Community](../community/community.md) created an engine, called the PnP Provisioning Engine, which allows you to easily create templates and apply those templates to sites or your tenant. The PnP Provisioning Engine can be called from C# code or by using PnP PowerShell.
1316

1417
See the following resources for more information:

docs/solution-guidance/provisioning-console-application-sample.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,15 @@ To support the new add-in model, the Office 365 Developer Patterns and Practices
1212
- Persist the model as a provisioning template.
1313
- Apply the custom template to new or existing site collections as needed.
1414

15+
> [!NOTE]
16+
> PnP remote provisioning is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
17+
1518
In this sample, we create a basic console application that implements classes in the provisioning PnP Core library to enable the PnP provisioning engine to complete these essential provisioning tasks:
1619

1720
- Design and model your site customization. This can be a new site design, or you can point to an existing site and save it as a provisioning template.
1821
- Save and persist the site model as a provisioning template so that you can reuse it.
1922
- Apply the provisioning template to a new or existing site collection.
20-
23+
2124
> [!NOTE]
2225
> This sample walkthrough is a companion to a sample currently available on GitHub at [Getting Started with the PnP provisioning engine](https://github.com/SharePoint/PnP/tree/master/Samples/Provisioning.Framework.Console). The code (Program.cs) and solution files for the sample are available for download. There also is a 20-minute video presentation of this process (with slightly different code) available on the Microsoft Channel 9 site, [Getting Started with the PnP provisioning engine](https://channel9.msdn.com/blogs/OfficeDevPnP/Getting-Started-with-PnP-Provisioning-Engine).
2326

docs/solution-guidance/the-pnp-office-open-xml-file-format.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ localization_priority: Priority
99

1010
If you have a template which contains file references (through the ```<pnp:Files />``` element) you will have to distribute both the xml file _and_ the files that are referred to. While this of course works, it is very easy to miss files when copying them to another ___location.
1111

12+
> [!NOTE]
13+
> PnP remote provisioning is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
1215
For this reason we introduced a specific Office Open XML format called a 'pnp file'. Effectively it is a zip file with a specific structure in it. If you rename the .pnp file to have a .zip extension you can simply open the file and have a look in it.
1316

1417
![Contents of a PnP file](./media/the-pnp-office-open-xml-file-format/figure1-contents-of-file.png)

docs/toc.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1752,8 +1752,12 @@
17521752
href: solution-guidance/pnp-provisioning-framework.md
17531753
- name: PnP provisioning engine and the Core library
17541754
href: solution-guidance/pnp-provisioning-engine-and-the-core-library.md
1755+
- name: Provisioning Tenant Templates
1756+
href: solution-guidance/pnp-provisioning-tenant-templates.md
1757+
- name: PnP Open XML File format
1758+
href: solution-guidance/the-pnp-office-open-xml-file-format.md
17551759
- name: PnP provisioning schema
1756-
href: solution-guidance/pnp-provisioning-schema.md
1760+
href: solution-guidance/pnp-provisioning-schema.md
17571761
- name: Provisioning console application sample
17581762
href: solution-guidance/provisioning-console-application-sample.md
17591763
- name: PnP remote timer job framework

0 commit comments

Comments
 (0)