You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Tips to maintain and support your SharePoint Framework app after publishing it to the marketplace
4
-
ms.date: 06/25/2020
3
+
description: Tips to maintain and support your SharePoint Framework app after publishing it to the Marketplace
4
+
ms.date: 07/16/2020
5
5
ms.prod: sharepoint
6
6
localization_priority: Priority
7
7
---
8
8
9
9
# Maintain and support your published app
10
10
11
-
Publishing the application to the marketplace is just the first step in helping users solve their business problem. Following sections contain some tips that you should consider after publishing your application to the marketplace.
11
+
Publishing the application to the Marketplace is just the first step in helping users solve their business problem. Following sections contain some tips that you should consider after publishing your application to the Marketplace.
12
12
13
-
## Install applications from the marketplace in the tenant app catalog
13
+
## Install applications from the Marketplace in the tenant App Catalog
14
14
15
-
SharePoint Online allows you to create a tenant app catalog where you centrally manage applications available in your organization. Additionally, you can create site collection app catalogs, where you can deploy applications to specific sites.
15
+
SharePoint Online allows you to create a tenant App Catalog where you centrally manage applications available in your organization. Additionally, you can create site collection App Catalogs, where you can deploy applications to specific sites.
16
16
17
-
Applications that you acquire from the marketplace, you can install only in tenant app catalogs. After installing the application, you can decide whether you want to deploy it globally and make it available to all sites in your tenant or if you want to deploy it only to specific sites.
17
+
Applications that you acquire from the Marketplace, you can install only in tenant App Catalogs. After installing the application, you can decide whether you want to deploy it globally and make it available to all sites in your tenant or if you want to deploy it only to specific sites.
18
18
19
-
For more information about managing SharePoint Framework solution in the app catalog visit: [https://docs.microsoft.com/sharepoint/use-app-catalog](https://docs.microsoft.com/sharepoint/use-app-catalog) and [https://docs.microsoft.com/sharepoint/dev/general-development/site-collection-app-catalog](https://docs.microsoft.com/sharepoint/dev/general-development/site-collection-app-catalog).
19
+
For more information about managing SharePoint Framework solution in the App Catalog visit: [https://docs.microsoft.com/sharepoint/use-app-catalog](https://docs.microsoft.com/sharepoint/use-app-catalog) and [https://docs.microsoft.com/sharepoint/dev/general-development/site-collection-app-catalog](https://docs.microsoft.com/sharepoint/dev/general-development/site-collection-app-catalog).
20
20
21
-
## Permissions required to install applications from the marketplace
21
+
## Permissions required to install applications from the Marketplace
22
22
23
-
By default, only tenant administrators can install applications from the marketplace. They can however choose to delegate the responsibility to others in your organization by granting them access to the tenant app catalog.
23
+
By default, only tenant administrators can install applications from the Marketplace. They can however choose to delegate the responsibility to others in your organization by granting them access to the tenant App Catalog.
24
24
25
-
SharePoint Framework applications execute on behalf of the current user and can do whatever the current user can do. Because of this, only tenant app catalog administrators can install applications from the marketplace. Users who are not app catalog administrators can request a specific application to be installed by the app catalog administrator, but they cannot install the application themselves.
25
+
SharePoint Framework applications execute on behalf of the current user and can do whatever the current user can do. Because of this, only tenant App Catalog administrators can install applications from the Marketplace. Users who are not App Catalog administrators can request a specific application to be installed by the App Catalog administrator, but they cannot install the application themselves.
26
26
27
27
## Notify users of new versions
28
28
29
-
As you update your application, you should notify your users when an updated version is available. The marketplace does not offer any version checking mechanism and you should implement it your application so that notifications are meaningful and as unobtrusive as possible. In your code you can for example call a custom API that you own to compare the current version of the application with the latest version available.
29
+
As you update your application, you should notify your users when an updated version is available. The Marketplace does not offer any version checking mechanism and you should implement it your application so that notifications are meaningful and as unobtrusive as possible. In your code, you can, for example, call a custom API that you own to compare the current version of the application with the latest version available.
30
30
31
-
Tenant app catalog administrators can update applications acquired from the marketplace directly from the app catalog, by selecting the application in the app catalog and from the ribbon choosing the **Upgrade Store App** option. When the upgrade succeeds, the latest version will be automatically visible to users in all sites where the application has been installed.
31
+
Tenant App Catalog administrators can update applications acquired from the Marketplace directly from the App Catalog, by selecting the application in the App Catalog and from the ribbon choosing the **Upgrade Store App** option. When the upgrade succeeds, the latest version will be automatically visible to users in all sites where the application has been installed.
32
32
33
33
## Applications listed in the SharePoint category
34
34
35
-
All SharePoint Framework applications published in the marketplace are listed in the **SharePoint** category. At this moment, it is not possible to specify a custom category. Also, even if you configured web parts in your application to be exposed in Microsoft Teams, the application will still be listed in the **SharePoint** category.
35
+
All SharePoint Framework applications published in the Marketplace are listed in the **SharePoint** category. At this moment, it is not possible to specify a custom category. Also, even if you configured web parts in your application to be exposed in Microsoft Teams, the application will still be listed in the **SharePoint** category.
Copy file name to clipboardExpand all lines: docs/spfx/publish-to-marketplace-checklist.md
+20-20Lines changed: 20 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,20 @@
1
1
---
2
-
title: Prepare your SharePoint Framework application for publishing to the marketplace
3
-
description: Tips & tricks to help you get your SharePoint Framework application published in the marketplace
4
-
ms.date: 06/25/2020
2
+
title: Prepare your SharePoint Framework application for publishing to the Marketplace
3
+
description: Tips & tricks to help you get your SharePoint Framework application published in the Marketplace
4
+
ms.date: 07/16/2020
5
5
ms.prod: sharepoint
6
6
localization_priority: Priority
7
7
---
8
8
9
-
# Prepare your SharePoint Framework application for publishing to the marketplace
9
+
# Prepare your SharePoint Framework application for publishing to the Marketplace
10
10
11
-
Before a SharePoint Framework application is published in the marketplace, it must go through an approval process. This process is executed free of charge by Microsoft and is meant to ensure that your app functions properly and that its page clearly describes its purpose and features. To help you get your application published in the marketplace, following is the list of tests executed as a part of the approval process.
11
+
Before a SharePoint Framework application is published in the Marketplace, it must go through an approval process. This process is executed free of charge by Microsoft and is meant to ensure that your app functions properly and that its page clearly describes its purpose and features. To help you get your application published in the Marketplace, following is the list of tests executed as a part of the approval process.
12
12
13
13
## Prerequisites
14
14
15
15
### Use SharePoint Framework v1.11 or newer
16
16
17
-
To build solutions that you want to publish to the marketplace, you need to use SharePoint Framework v1.11 or higher. Starting from version 1.11, SharePoint Framework solution manifest has additional information about your organization and solution, which is required for publishing your application in the marketplace.
17
+
To build solutions that you want to publish to the Marketplace, you need to use SharePoint Framework v1.11 or higher. Starting from version 1.11, SharePoint Framework solution manifest has additional information about your organization and solution, which is required for publishing your application in the Marketplace.
18
18
19
19
> [!TIP]
20
20
> If your application is built using an older version of the SharePoint Framework, you can easily upgrade it to SharePoint Framework v1.11 or newer using Office 365 CLI. For more information, visit [https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/).
@@ -25,7 +25,7 @@ When testing your application, verify that it's working as intended when install
25
25
26
26
### Test application in the required browsers
27
27
28
-
When testing your application against checks described in the following section, verify that it works as expected at least on Windows 10 in the latest versions of Microsoft Edge, Google Chrome, Firefox and Microsoft Teams Desktop client (if your application exposes web parts in Teams).
28
+
When testing your application against checks described in the following section, verify that it works as expected at least on Windows 10 in the latest versions of Microsoft Edge, Google Chrome, Firefox, and Microsoft Teams Desktop client (if your application exposes web parts in Teams).
29
29
30
30
## Required checks
31
31
@@ -35,13 +35,13 @@ Following checks must be passed. If one or more checks from this category failed
35
35
36
36
Under normal circumstances, all components (web parts and extensions) in your solution should work as intended. Preferably, before submitting your application for approval, you should verify that it's working as expected on multiple tenants and using different user accounts to ensure that it doesn't depend on any specific configuration. If your solution requires specific settings, mention it explicitly in your solution's description.
37
37
38
-
### Web part should work in all hosts in which its exposed
38
+
### Web part should work in all hosts in which it is exposed
39
39
40
40
When building web parts using SharePoint Framework, you can choose [where they should be exposed](integrate-with-teams-introduction.md). Before submitting you application for review, ensure that your web part works as intended in all these hosts.
41
41
42
42
### Solution package must contain valid developer metadata
43
43
44
-
In the solution's manifest (managed in the `package-solution.json` file) there is a new section named `developer` with the following properties:
44
+
Solution's manifest (managed in the `package-solution.json` file) has to have a new section named `developer` with the following properties:
Including this additional information allows you to clearly communicate information about your application towards your users and in the future should allow you to access additional usage data.
55
55
56
-
The developer information is displayed when installing web parts in Microsoft Teams. Information about the application and the developer that is displayed in the marketplace is managed separately in the marketplace.
56
+
The developer information is displayed when installing web parts in Microsoft Teams. Information about the application and the developer that is displayed in the Marketplace is managed separately in the Marketplace.
57
57
58
58
### Web part metadata description text must briefly describe its functionality and value proposition
59
59
60
60
Ensure that your web part's description in the metadata is meaningful so that users understand what is your web part's purpose and what they can expect of it.
61
61
62
62
### Solution's description must clearly describe the different components included in the package
63
63
64
-
When submitting your package to the marketplace, be sure to clearly describe what different component (web parts, application customizers, etc.) are included in the package to manage user expectations and help them understand the impact of using your application.
64
+
When submitting your package to the Marketplace, be sure to clearly describe what different components (web parts, application customizers, etc.) are included in the package to manage user expectations and help them understand the impact of using your application.
65
65
66
66
### Don't use names of features in Teams and SharePoint in your solution's name
67
67
68
-
In your solution name don't use words matching features in Microsoft Teams or SharePoint, such as **Chat**, **Contacts**, **Calendar**, **Calls**, **Files**, **Meeting**, **Activity**, **Teams**, **Apps**, **Help**, **SharePoint**, **List**, **Page**, etc. as these names could be confused with the standard functionality in Teams and SharePoint.
68
+
In your solution name, don't use words matching features in Microsoft Teams or SharePoint, such as **Chat**, **Contacts**, **Calendar**, **Calls**, **Files**, **Meeting**, **Activity**, **Teams**, **Apps**, **Help**, **SharePoint**, **List**, **Page**, etc. as these names could be confused with the standard functionality in Teams and SharePoint.
69
69
70
70
### Don't use names of other Microsoft's products in your solution's name
71
71
@@ -77,7 +77,7 @@ Your solution must not use Microsoft Teams or SharePoint feature-specific keywor
77
77
78
78
### Naming your solution
79
79
80
-
If your solution is named after a common word, such as **Orders**, you will need to include your company name as well to clearly differentiate it from other solutions in the marketplace, eg.**Contoso Orders**.
80
+
If your solution is named after a common word, such as **Orders**, you will need to include your company name as well to clearly differentiate it from other solutions in the Marketplace, for example,**Contoso Orders**.
81
81
82
82
### Don't include additional advertising in your app's description and screenshots
83
83
@@ -87,9 +87,9 @@ Make sure that your app's description, screenshots, text, and promotional images
87
87
88
88
Properties exposed in the property pane of your web part should be meaningful. Changing their settings, should clearly change the behavior of your web part.
89
89
90
-
### Verify that the package file can be uploaded to App catalog without errors
90
+
### Verify that the package file can be uploaded to App Catalog without errors
91
91
92
-
Verify that the solution package can be uploaded to the App catalog in your tenant without any errors.
92
+
Verify that the solution package can be uploaded to the App Catalog in your tenant without any errors.
93
93
94
94
### Verify that the app can be deployed without errors
95
95
@@ -128,11 +128,11 @@ If your application uses pop-ups, verify, that browsers with default settings do
128
128
129
129
### Correct first-launch experience
130
130
131
-
If possible, your application should work when launched for the first time. If it must be configured first, clearly communicate next steps to the user. If the configuration is complex or requires additional information, provide clear instructions to help users setup your application.
131
+
If possible, your application should work when launched for the first time. If it must be configured first, clearly communicate next steps to the user. If the configuration is complex or requires additional information, provide clear instructions to help users set up your application.
132
132
133
133
### Test syncing to Teams
134
134
135
-
If your application contains web parts that are exposed as Teams tabs or personal apps, verify that they can be deployed to teams using the **Sync to Teams** option in the App catalog without any errors. After syncing the configuration to Teams, verify that all web parts are exposed in the Teams' app catalog as intended, can be installed and work as expected.
135
+
If your application contains web parts that are exposed as Teams tabs or personal apps, verify that they can be deployed to teams using the **Sync to Teams** option in the App Catalog without any errors. After syncing the configuration to Teams, verify that all web parts are exposed in the Teams' App Catalog as intended, can be installed and work as expected.
136
136
137
137
### Verify that links with additional information are correct
138
138
@@ -148,7 +148,7 @@ If your offering includes a free trial of your application, then your applicatio
148
148
149
149
### Don't include malicious code
150
150
151
-
Solutions that contain malicious code, links to malicious websites or otherwise illegal resources will be rejected from publishing in the marketplace.
151
+
Solutions that contain malicious code, links to malicious websites or otherwise illegal resources will be rejected from publishing in the Marketplace.
152
152
153
153
### Don't include vulnerable resource
154
154
@@ -160,7 +160,7 @@ When testing your application, verify that it doesn't lead to noticeable or sust
160
160
161
161
## Recommended checks
162
162
163
-
Following checks are recommended to pass. While a failed check in this category won't prevent you from publishing your application in the marketplace, it might have a negative impact on end-user experience.
163
+
Following checks are recommended to pass. While a failed check in this category won't prevent you from publishing your application in the Marketplace, it might have a negative impact on end-user experience.
164
164
165
165
### Web part icon should be 64x64px with transparent background
166
166
@@ -175,7 +175,7 @@ We recommend that all web parts have a title that clearly describes the informat
175
175
176
176
### Properly handle different themes
177
177
178
-
Your application should properly handle light- and dark-color themes. Switching between the different themes shouldn't have a negative effect on the usability of your application. While not supporting themes will not prevent you from publishing your app in the marketplace, it's strongly recommended that you support them to offer optimal user experience.
178
+
Your application should properly handle light- and dark-color themes. Switching between the different themes shouldn't have a negative effect on the usability of your application. While not supporting themes will not prevent you from publishing your app in the Marketplace, it's recommended that you support them to offer optimal user experience.
179
179
180
180
> [!TIP]
181
181
> For more information about using themes in your application, see the [Use theme colors in your SharePoint Framework customizations](use-theme-colors-in-your-customizations.md) article.
0 commit comments