Skip to content

Commit f002a07

Browse files
committed
add references to tenant wide extensions list. correct typos
1 parent 8058373 commit f002a07

File tree

2 files changed

+35
-14
lines changed

2 files changed

+35
-14
lines changed

docs/spfx/extensions/basics/tenant-wide-deployment-extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Tenant Wide Deployment option for SharePoint Framework Extensions is supported f
1313
> [!NOTE]
1414
> SharePoint Framework extensions are supported with modern experiences regardless of the actual site template used when content site was created.
1515
16-
When developers create a new SharePoint Framework extension solution using standard SharePoint Framework Yeoman packages, automation is included in the solution package to activate extension cross the tenant.
16+
When developers create a new SharePoint Framework extension solution using standard SharePoint Framework Yeoman packages, automation is included in the solution package to activate extension across the tenant.
1717

1818
> [!WARNING]
1919
> Starting from SharePoint Framework v1.6, default scaffolding will automatically create example files in SharePoint Solution to activate extension across the tenant if you chose to use the tenant-scoped deployment option.
@@ -143,4 +143,4 @@ When an administrator adds a solution that has a ClientSideInstance.xml file in
143143

144144
![SharePoint client-side solution scaffolded successfully](../../../images/ext-tenant-wide-solution-deployment.png)
145145

146-
After solution deployment, administrator can change the deployment settings from the **Tenant Wide Extension** list.
146+
After solution deployment, an administrator can change the deployment settings from the **Tenant Wide Extension** list.

docs/spfx/tenant-scoped-deployment.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ localization_priority: Priority
1111

1212
You can configure your SharePoint Framework components to be immediately available across the tenant when the solution package is installed to the tenant app catalog. This can be configured by using the **skipFeatureDeployment** attribute in the **package-solution.json** file.
1313

14-
When the solution has this attribute enabled, the tenant administrator is provided the option to enable the solution to be available automatically across all site collections and sites in the tenant when the solution package is installed to the tenant app catalog.
14+
When the solution has this attribute enabled, the tenant administrator is provided the option to enable the solution to be available automatically across all site collections and sites in the tenant when the solution package is installed to the tenant app catalog.
1515

1616
You can also see the tenant-wide deployment option demonstrated by watching the following video on the SharePoint PnP YouTube Channel:
1717

1818
<br/>
1919

2020
> [!Video https://www.youtube.com/embed/pemHOZCSwZI]
2121
22-
<br/>
22+
<br/>
2323

2424

25-
> [!NOTE]
25+
> [!NOTE]
2626
> You have to update to the latest SharePoint Framework Yeoman template version to be able to use this capability. You can update your global installation by executing `npm install -g @microsoft/generator-sharepoint`.
2727
> Tenant-wide deployment is not available for SharePoint 2016 Feature Pack 2 since it only supports SPFX 1.1, and this deployment option was released in version 1.4
2828
> If you are utilizing a SPFX webpart older than 1.4 you can upgrade with instructions via the [Office 365 CLI](https://aka.ms/o365cli)
@@ -33,26 +33,40 @@ When this option is used, any feature framework definitions in the SharePoint Fr
3333

3434
For more information, see [Provision SharePoint assets with your solution package](./toolchain/provision-sharepoint-assets.md).
3535

36-
> [!NOTE]
37-
> Solutions that are configured to be automatically deployed across tenants are not visible in the add-an-app capability at the site level.
36+
> [!NOTE]
37+
> Solutions that are configured to be automatically deployed across tenants are not visible in the add-an-app capability at the site level.
3838
3939
## Configure solution to be available across the tenant
4040

41-
The SharePoint Framework Yeoman template asks a specific question related to this option. This question impacts directly on the **skipFeatureDeployment** attribute in the **package-solution.json** file.
41+
The SharePoint Framework Yeoman template asks a specific question related to this option. This question impacts directly on the **skipFeatureDeployment** attribute in the **package-solution.json** file.
4242

4343
![Yeoman question around tenant deployed option](../images/tenant-deploy-yeoman.png)
4444

4545
<br/>
4646

47-
In following example configuration, **skipFeatureDeployment** is set to true, which indicates that the solution can be centrally deployed across the tenant.
47+
In following example configuration, **skipFeatureDeployment** is set to true, which indicates that the solution can be centrally deployed across the tenant.
4848

4949
```json
5050
{
5151
"solution": {
5252
"name": "tenant-deploy-client-side-solution",
5353
"id": "dd4feca4-6f7e-47f1-a0e2-97de8890e3fa",
5454
"version": "1.0.0.0",
55-
"skipFeatureDeployment": true
55+
"skipFeatureDeployment": true,
56+
"features": [
57+
{
58+
"title": "Application Extension - Deployment of custom action.",
59+
"description": "Deploys a custom action with ClientSideComponentId association",
60+
"id": "54f0dc0e-c190-439d-933b-2dd2809ed3c3",
61+
"version": "1.0.0.0",
62+
"assets": {
63+
"elementManifests": [
64+
"elements.xml",
65+
"ClientSideInstance.xml"
66+
]
67+
}
68+
}
69+
]
5670
},
5771
"paths": {
5872
"zippedPackage": "solution/tenant-deploy-true.sppkg"
@@ -65,19 +79,26 @@ In following example configuration, **skipFeatureDeployment** is set to true, wh
6579

6680
When the solution with the **skipFeatureDeployment** attribute set to **true** is deployed to the tenant app catalog, the administrator is given an option to configure the solution to be deployed centrally across the tenant.
6781

68-
By default, the **Make this solution available to all sites in the organization** check box is not selected. If the check box is selected by the administrator, components in the solutions are automatically visible and available across the tenant.
82+
By default, the **Make this solution available to all sites in the organization** check box is not selected. If the check box is selected by the administrator, components in the solutions are automatically visible and available across the tenant.
6983

7084
![The "Make this solution available to all sites in the organization" setting is visible when solution is deployed to app catalog](../images/tenant-deploy-app-catalog.png)
7185

72-
Notice that because the solution and site-specific upgrade actions are only available when you use the feature framework, there's no specific upgrade option for the centrally deployed solutions. These solutions can be updated by updating the solution-specific assets in the CDN and by updating the package in the app catalog. This automatically updates all existing component instances across the tenant to use the latest component assets, such as JavaScript files and updated CSS files.
86+
Notice that because the solution and site-specific upgrade actions are only available when you use the feature framework, there's no specific upgrade option for the centrally deployed solutions. These solutions can be updated by updating the solution-specific assets in the CDN and by updating and deploying the package in the app catalog. This automatically updates all existing component instances across the tenant to use the latest component assets, such as JavaScript files and updated CSS files.
87+
88+
> [!WARNING]
89+
> For solution packages containing site extension(s), selecting the **Make this solution available to all sites in the organization** check box is only required to activate the site extension(s) initially. When updating existing solution packages, selecting the check box during deployment may create duplicate entries in the **Tenant Wide Extension** list.
7390
7491
## Client-side web part visibility on SharePoint sites
7592

76-
Web parts included in solutions that have been centrally deployed are immediately visible in the web part picker in both classic and modern pages.
93+
Web parts included in solutions that have been centrally deployed are immediately visible in the web part picker in both classic and modern pages.
7794

7895
## Impact of skipFeatureDeployment setting with Extensions
7996

80-
[SharePoint Framework Extensions](./extensions/overview-extensions.md) are immediately available to be used on SharePoint sites. This means that they can be associated with **ClientSideComponentId** properties in the specific SharePoint elements, such as **fields** and **user custom actions**.
97+
[SharePoint Framework Extensions](./extensions/overview-extensions.md) are immediately available to be used on SharePoint sites. This means that they can be associated with **ClientSideComponentId** properties in the specific SharePoint elements, such as **fields** and **user custom actions**.
98+
99+
Additionally, if an administrator selects the **Make this solution available to all sites in the organization** checkbox during deployment, automations in the solution package may create entries in the **Tenant Wide Extensions** list on the app catalog. Entries in this list manage tenant-wide activation of site extensions. The automations are described by the **ClientSideInstance.xml** file as referenced in **package-solution.json**.
100+
101+
For more information, see [Tenant Wide Deployment of SharePoint Framework Extensions](./extensions/basics/tenant-wide-deployment-extensions.md).
81102

82103
## See also
83104

0 commit comments

Comments
 (0)